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

POSThttps://api.transactionlink.io/parameters

Body

application/json

workflowDefinitionId*string

Id of the workflow definition

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

parameters*any

Response

201400404

Set of parameters for given workflow was created successfully

Body

application/json

parametersId*string

Id of the parameters set

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

workflowDefinitionId*string

Id of the workflow definition

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

parameters*any

Request

JavaScriptCurl

const response = await fetch('https://api.transactionlink.io/parameters', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "workflowDefinitionId": "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c",
      "parameters": {
        "param0": 0,
        "param1": 1.2222,
        "param2": true,
        "param3": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "parametersId": "c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81",
  "workflowDefinitionId": "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c",
  "parameters": {
    "param0": 0,
    "param1": 1.2222,
    "param2": true,
    "param3": "text"
  }
}

GET Parameters

Get parameters

Get a set of parameters for given workflow definition to use

GEThttps://api.transactionlink.io/parameters/{parametersId}

Path parameters

parametersId*string (uuid)

UUID of the parameters set to get

Response

201400404

Set of parameters for given workflow was created successfully

Body

application/json

parametersId*string

Id of the parameters set

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

workflowDefinitionId*string

Id of the workflow definition

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

parameters*any

Request

JavaScriptCurl

const response = await fetch('https://api.transactionlink.io/parameters/{parametersId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "parametersId": "c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81",
  "workflowDefinitionId": "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c",
  "parameters": {
    "param0": 0,
    "param1": 1.2222,
    "param2": true,
    "param3": "text"
  }
}