Parameters

Parameters API enables you to send custom inputs to the workflow

POST Create Parameters

Create parameters

Create a set of parameters for given workflow definition to use

post

/parameters

Body

workflowDefinitionIdstringrequired

Id of the workflow definition

Example: 3b2d8a4f-579f-4e2e-a51c-f859e532fe8c

parametersanyrequired

Example: {"param0":0,"param1":1.2222,"param2":true,"param3":"text"}

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.transactionlink.io/parameters' \
  --header 'Content-Type: application/json' \
  --data '{"workflowDefinitionId":"3b2d8a4f-579f-4e2e-a51c-f859e532fe8c","parameters":{"param0":0,"param1":1.2222,"param2":true,"param3":"text"}}'

201

400

404

201

{
  "workflowDefinitionId": "e1413f5b-acb0-4995-919a-3fc60c9592c5",
  "parametersId": "c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81",
  "parameters": {
    "param1": "value1",
    "param2": true,
    "param3": "text"
  }
}

Set of parameters for given workflow was created successfully

GET Parameters

Get parameters

Get a set of parameters for given workflow definition to use

get

/parameters/{parametersId}

Path parameters

parametersIdstring · uuidrequired

UUID of the parameters set to get

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.transactionlink.io/parameters/{parametersId}'

201

400

404

201

{
  "workflowDefinitionId": "e1413f5b-acb0-4995-919a-3fc60c9592c5",
  "parametersId": "c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81",
  "parameters": {
    "param1": "value1",
    "param2": true,
    "param3": "text"
  }
}

Set of parameters for given workflow was created successfully