Corda Blockchain

Corda is a smart contract distributed ledger. With the Corda connector, you can perform actions such as submitting transactions and reading contract state.

Status: Preview

Tier: Premium

Version: 1.0

Actions:

Name	Summary
CreateContractRequest (string applicationSchema, string workflowName, CreateContractRequestParameterParameters parameters)	Create Contract message
CreateContractActionRequest (string applicationSchema, string contractLedgerIdentifier, string workflowName, string actionName, CreateContractActionRequestParameterParameters parameters)	Create Contract Action message
CreateContractReadRequest (string contractLedgerIdentifier)	Read state
ParseMessageTypeResponse (string response)	Parse message type from the response
ParseContractMessageResponse (string response)	Parse the contract message response
ParseCreateContractResponse (string response)	Parse the create contract response
ParseCreateContractUpdateResponse (string response)	Parse the create contract update response
ParseCreateContractActionResponse (string response)	Parse the create contract action response
ParseCreateContractActionUpdateResponse (string response)	Parse the create contract action update response
ParseContractFunctionInvocationResponse (string response)	Parse the contract function invocation response
GetApplicationWorkflowNames (string applicationSchema)	Get names of constant contract functions
GetWorkflowActionsNames (string applicationSchema, string workflowName)	Get names of constant contract functions
GetWorkflowConstructorMetadata (string applicationSchema, string workflowName)	Get smart contract function metadata
GetWorkflowActionMetadata (string applicationSchema, string workflowName, string actionName)	Get smart contract function metadata

Objects:

Name	Summary
ActionName
ApplicationFunctionMetadata
ContractFunctionInvocationMessage
ContractMessage
ContractPropertyInformation
CreateContractActionRequestMessage
CreateContractActionRequestParameterParameters
CreateContractActionUpdateMessage
CreateContractRequestMessage
CreateContractRequestParameterParameters
CreateContractUpdateMessage
IdentityInformation
MessageTypeResponse
NameValueParameter
Object
TransactionInformation
WorkflowName
WorkflowRequest

Actions:

CreateContractRequest

Summary: Create Contract message

Description: Create Contract message.

Syntax:

CordaBlockchain.CreateContractRequest (string applicationSchema, string workflowName, CreateContractRequestParameterParameters parameters)

Parameters:

Name	Type	Summary	Required	Related Action
applicationSchema	string (Application Schema)	Application Schema.	True
workflowName	string (Workflow Name)	Name of the workflow.	True	GetApplicationWorkflowNames
parameters	CreateContractRequestParameterParameters		True

Returns:

Type:WorkflowRequest

Description: Wrapper for the request message

CreateContractActionRequest

Summary: Create Contract Action message

Description: Create Contract Action message.

Syntax:

CordaBlockchain.CreateContractActionRequest (string applicationSchema, string contractLedgerIdentifier, string workflowName, string actionName, CreateContractActionRequestParameterParameters parameters)

Parameters:

Name	Type	Summary	Required	Related Action
applicationSchema	string (Application Schema)	Application Schema.	True
contractLedgerIdentifier	string (ContractLedgerIdentifier)	Contract ledger identifier.	True
workflowName	string (Workflow Name)	Name of the workflow.	True	GetApplicationWorkflowNames
actionName	string (Action Name)	Name of the action.	True	GetWorkflowActionsNames
parameters	CreateContractActionRequestParameterParameters		True

Returns:

Type:WorkflowRequest

Description: Wrapper for the request message

CreateContractReadRequest

Summary: Read state

Description: Read state.

Syntax:

CordaBlockchain.CreateContractReadRequest (string contractLedgerIdentifier)

Parameters:

Name

Type

Summary

Required

Related Action

contractLedgerIdentifier

string

(ContractLedgerIdentifier)

ContractLedgerIdentifier.

True

Returns:

Type:WorkflowRequest

Description: Wrapper for the request message

ParseMessageTypeResponse

Summary: Parse message type from the response

Description: Parse message type from the response.

Syntax:

CordaBlockchain.ParseMessageTypeResponse (string response)

Parameters:

Name

Type

Summary

Required

Related Action

response

string

(Response)

Response from Service Bus.

True

Returns:

Type:MessageTypeResponse

Description: Message Type Information

ParseContractMessageResponse

Summary: Parse the contract message response

Description: Parse the contract message response.

Syntax:

CordaBlockchain.ParseContractMessageResponse (string response)

Parameters:

Name

Type

Summary

Required

Related Action

response

string

(Response)

Response from Service Bus.

True

Returns:

Type:ContractMessage

Description: Contract Message

ParseCreateContractResponse

Summary: Parse the create contract response

Description: Parse the create contract response.

Syntax:

CordaBlockchain.ParseCreateContractResponse (string response)

Parameters:

Name

Type

Summary

Required

Related Action

response

string

(Response)

Response from Service Bus.

True

Returns:

Type:CreateContractRequestMessage

Description: Create Contract Request Message

ParseCreateContractUpdateResponse

Summary: Parse the create contract update response

Description: Parse the create contract update response.

Syntax:

CordaBlockchain.ParseCreateContractUpdateResponse (string response)

Parameters:

Name

Type

Summary

Required

Related Action

response

string

(Response)

Response from Service Bus.

True

Returns:

Type:CreateContractUpdateMessage

Description: Create Contract Update Message

ParseCreateContractActionResponse

Summary: Parse the create contract action response

Description: Parse the create contract action response.

Syntax:

CordaBlockchain.ParseCreateContractActionResponse (string response)

Parameters:

Name

Type

Summary

Required

Related Action

response

string

(Response)

Response from Service Bus.

True

Returns:

Type:CreateContractActionRequestMessage

Description: Create Contract Action Request Message

ParseCreateContractActionUpdateResponse

Summary: Parse the create contract action update response

Description: Parse the create contract action update response.

Syntax:

CordaBlockchain.ParseCreateContractActionUpdateResponse (string response)

Parameters:

Name

Type

Summary

Required

Related Action

response

string

(Response)

Response from Service Bus.

True

Returns:

Type:CreateContractActionUpdateMessage

Description: Create Contract Action Update Message

ParseContractFunctionInvocationResponse

Summary: Parse the contract function invocation response

Description: Parse the contract function invocation response.

Syntax:

CordaBlockchain.ParseContractFunctionInvocationResponse (string response)

Parameters:

Name

Type

Summary

Required

Related Action

response

string

(Response)

Response from Service Bus.

True

Returns:

Type:ContractFunctionInvocationMessage

Description: Contract Function Invocation Message

GetApplicationWorkflowNames

Summary: Get names of constant contract functions

Description: Get names of constant contract functions.

Syntax:

CordaBlockchain.GetApplicationWorkflowNames (string applicationSchema)

Parameters:

Name

Type

Summary

Required

Related Action

applicationSchema

string

True

Returns:

Type:array of (WorkflowName)

GetWorkflowActionsNames

Summary: Get names of constant contract functions

Description: Get names of constant contract functions.

Syntax:

CordaBlockchain.GetWorkflowActionsNames (string applicationSchema, string workflowName)

Parameters:

Name

Type

Summary

Required

Related Action

applicationSchema

string

True

workflowName

string

(Workflow Name)

The workflow name.

True

Returns:

Type:array of (ActionName)

GetWorkflowConstructorMetadata

Summary: Get smart contract function metadata

Description: Get smart contract function metadata.

Syntax:

CordaBlockchain.GetWorkflowConstructorMetadata (string applicationSchema, string workflowName)

Parameters:

Name

Type

Summary

Required

Related Action

applicationSchema

string

True

workflowName

string

(Workflow Name)

Name of the workflow.

True

Returns:

Type:ApplicationFunctionMetadata

Description: SmartContract Function Metadata

GetWorkflowActionMetadata

Summary: Get smart contract function metadata

Description: Get smart contract function metadata.

Syntax:

CordaBlockchain.GetWorkflowActionMetadata (string applicationSchema, string workflowName, string actionName)

Parameters:

Name	Type	Summary	Required	Related Action
applicationSchema	string		True
workflowName	string (Workflow Name)	Name of the workflow.	True
actionName	string (Action Name)	Name of the action.	True

Returns:

Type:ApplicationFunctionMetadata

Description: SmartContract Function Metadata

ActionName

Summary:

Description: Action name

Properties:

Name

Type

Summary

Name

string

Action Name

The Action Name

ApplicationFunctionMetadata

Summary:

Description: SmartContract Function Metadata

Properties:

Name	Type	Summary
name	string	Function name
title	string	Function title
schema	Object

ContractFunctionInvocationMessage

Summary:

Description: Contract Function Invocation Message

Properties:

Name	Type	Summary
caller	IdentityInformation	Identity Information
contractId	integer(int64)	Contract Id
contractLedgerIdentifier	string	Contract Ledger Identifier
functionName	string	Function Name
parameters	array of (NameValueParameter)	Parameters
transaction	TransactionInformation	Transaction Information
inTransactionSequenceNumber	integer(int32)	In-Transaction Sequence Number
eventName	string	Event Name
connectionId	integer(int32)	Connection Id
additionalInformation	Object
requestId	string	Request Id
messageSchemaVersion	string	Version of the message schema
messageName	string	Name of the message

ContractMessage

Summary:

Description: Contract Message

Properties:

Name	Type	Summary
blockId	integer(int64)	Block Id
blockHash	string	Block Hash
modifyingTransactions	array of (TransactionInformation)	Modifying Transactions
contractId	integer(int64)	Contract Id
contractLedgerIdentifier	string	Contract Ledger Identifier
contractProperties	array of (ContractPropertyInformation)	Contract Properties
isNewContract	boolean	Is New Contract?
connectionId	integer(int32)	Connection Id
additionalInformation	Object
requestId	string	Request Id
messageSchemaVersion	string	Version of the message schema
messageName	string	Name of the message

ContractPropertyInformation

Summary:

Description: Contract Property Information

Properties:

Name	Type	Summary
workflowPropertyId	integer(int32)	Workflow Property Id
name	string	Name
value	string	Value

CreateContractActionRequestMessage

Summary:

Description: Create Contract Action Request Message

Properties:

Name	Type	Summary
contractLedgerIdentifier	string	Contract Ledger Identifier
workflowFunctionName	string	Workflow Function Name
parameters	array of (NameValueParameter)	Parameters
requestId	string	Request Id
messageSchemaVersion	string	Version of the message schema
messageName	string	Name of the message

CreateContractActionRequestParameterParameters

Summary:

Description:

Properties:

Name

Type

Summary

CreateContractActionUpdateMessage

Summary:

Description: Create Contract Action Update Message

Properties:

Name	Type	Summary
requestId	string	Request Id
connectionId	integer(int32)	Connection Id
status	string	Status
additionalInformation	Object
messageSchemaVersion	string	Version of the message schema
messageName	string	Name of the message

CreateContractRequestMessage

Summary:

Description: Create Contract Request Message

Properties:

Name	Type	Summary
workflowName	string	Workflow Name
parameters	array of (NameValueParameter)	Parameters
requestId	string	Request Id
messageSchemaVersion	string	Version of the message schema
messageName	string	Name of the message

CreateContractRequestParameterParameters

Summary:

Description:

Properties:

Name

Type

Summary

CreateContractUpdateMessage

Summary:

Description: Create Contract Update Message

Properties:

Name	Type	Summary
contractId	integer(int64)	Contract Id
contractLedgerIdentifier	string	Contract Ledger Identifier
requestId	string	Request Id
connectionId	integer(int32)	Connection Id
status	string	Status
additionalInformation	Object
messageSchemaVersion	string	Version of the message schema
messageName	string	Name of the message

IdentityInformation

Summary:

Description: Identity Information

Properties:

Name	Type	Summary
type	string	Type
id	integer(int64)	Id
ledgerIdentifier	string	Ledger Identifier

MessageTypeResponse

Summary:

Description: Message Type Information

Properties:

Name

Type

Summary

messageType

string

MessageType

Message Type

messageSchemaVersion

string

MessageSchemaVersion

Message Schema Version

NameValueParameter

Summary:

Description: Name Value Parameter

Properties:

Name

Type

Summary

name

string

Name

value

string

Value

Object

Summary:

Description:

Properties:

Name

Type

Summary

TransactionInformation

Summary:

Description: Transaction Information

Properties:

Name	Type	Summary
transactionId	integer(int64)	Transaction Id
transactionHash	string	Transaction Hash
from	string	From
to	string	To
provisioningStatus	integer(int32)	Provisioning Status

WorkflowName

Summary:

Description: Workflow name

Properties:

Name

Type

Summary

Name

string

Workflow Name

The Workflow Name

WorkflowRequest

Summary:

Description: Wrapper for the request message

Properties:

Name

Type

Summary

requestId

string

Request Id

requestMessage

string

Request Message