Parameters

Parameters API enables you to send custom inputs to the workflow

Create parameters

post

Create a set of parameters for the given workflow definition to use

Body

application/json

workflowDefinitionIdstringRequired

ID of the workflow definition

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

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

Responses

201

A set of parameters for the given workflow was created successfully

application/json

parametersIdstringRequired

ID of the parameters set

Example: c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81

workflowDefinitionIdstringRequired

ID of the workflow definition

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

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

400

Bad Request Body

application/json

404

Not Found

application/json

post

/parameters

HTTPcURLJavaScriptPython

POST /parameters HTTP/1.1
Host: api.transactionlink.io
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "workflowDefinitionId": "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c",
  "parameters": {
    "param0": 0,
    "param1": 1.2222,
    "param2": true,
    "param3": "text"
  }
}

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

Get parameters

get

Get a set of parameters for the given workflow definition

Path parameters

parametersIdstring · uuidRequired

UUID of the parameters set to get

Responses

201

A set of parameters was successfully retrieved

application/json

parametersIdstringRequired

ID of the parameters set

Example: c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81

workflowDefinitionIdstringRequired

ID of the workflow definition

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

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

400

Bad request

application/json

404

Not found

application/json

get

/parameters/{parametersId}

HTTPcURLJavaScriptPython

GET /parameters/{parametersId} HTTP/1.1
Host: api.transactionlink.io
Accept: */*

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