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 |
Name |
Summary |
Create Contract message |
|
Create Contract Action message |
|
Read state |
|
Parse message type from the response |
|
Parse the contract message response |
|
Parse the create contract response |
|
Parse the create contract update response |
|
Parse the create contract action response |
|
Parse the create contract action update response |
|
Parse the contract function invocation response |
|
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 |
Name |
Summary |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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 |
|
parameters |
CreateContractRequestParameterParameters
|
|
True |
Returns:
Type:WorkflowRequest
Description: Wrapper for the request message
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 |
|
actionName |
string (Action Name) |
Name of the action. |
True |
|
parameters |
CreateContractActionRequestParameterParameters
|
|
True |
Returns:
Type:WorkflowRequest
Description: Wrapper for the request message
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
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
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
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
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
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
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
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
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)
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)
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
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
Summary:
Description: Action name
Properties:
Name |
Type |
Summary |
Name |
string Action Name |
The Action Name |
Summary:
Description: SmartContract Function Metadata
Properties:
Name |
Type |
Summary |
name |
string
|
Function name |
title |
string
|
Function title |
schema |
|
|
Summary:
Description: Contract Function Invocation Message
Properties:
Name |
Type |
Summary |
caller |
|
Identity Information |
contractId |
integer(int64)
|
Contract Id |
contractLedgerIdentifier |
string
|
Contract Ledger Identifier |
functionName |
string
|
Function Name |
parameters |
array of (NameValueParameter)
|
Parameters |
transaction |
|
Transaction Information |
inTransactionSequenceNumber |
integer(int32)
|
In-Transaction Sequence Number |
eventName |
string
|
Event Name |
connectionId |
integer(int32)
|
Connection Id |
additionalInformation |
|
|
requestId |
string
|
Request Id |
messageSchemaVersion |
string
|
Version of the message schema |
messageName |
string
|
Name of the message |
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 |
|
|
requestId |
string
|
Request Id |
messageSchemaVersion |
string
|
Version of the message schema |
messageName |
string
|
Name of the message |
Summary:
Description: Contract Property Information
Properties:
Name |
Type |
Summary |
workflowPropertyId |
integer(int32)
|
Workflow Property Id |
name |
string
|
Name |
value |
string
|
Value |
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 |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description: Create Contract Action Update Message
Properties:
Name |
Type |
Summary |
requestId |
string
|
Request Id |
connectionId |
integer(int32)
|
Connection Id |
status |
string
|
Status |
additionalInformation |
|
|
messageSchemaVersion |
string
|
Version of the message schema |
messageName |
string
|
Name of the message |
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 |
Summary:
Description:
Properties:
Name |
Type |
Summary |
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 |
|
|
messageSchemaVersion |
string
|
Version of the message schema |
messageName |
string
|
Name of the message |
Summary:
Description: Identity Information
Properties:
Name |
Type |
Summary |
type |
string
|
Type |
id |
integer(int64)
|
Id |
ledgerIdentifier |
string
|
Ledger Identifier |
Summary:
Description: Message Type Information
Properties:
Name |
Type |
Summary |
messageType |
string MessageType |
Message Type |
messageSchemaVersion |
string MessageSchemaVersion |
Message Schema Version |
Summary:
Description: Name Value Parameter
Properties:
Name |
Type |
Summary |
name |
string
|
Name |
value |
string
|
Value |
Summary:
Description:
Properties:
Name |
Type |
Summary |
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 |
Summary:
Description: Workflow name
Properties:
Name |
Type |
Summary |
Name |
string Workflow Name |
The Workflow Name |
Summary:
Description: Wrapper for the request message
Properties:
Name |
Type |
Summary |
requestId |
string
|
Request Id |
requestMessage |
string
|
Request Message |