Workflows
Workflows API enables you to run flow through api.
POST
Run Workflow
POST
Run WorkflowDifferences between versions: version 1 relies on caseId and is scheduled for deprecation, whereas version 2 uses recordId and no longer returns partyDetails.
Body
caseIdstring · uuidRequired
Case identifier for which we want to initiate the workflow
workflowDefinitionIdstringRequiredExample:
ID of the workflow definition
3b2d8a4f-579f-4e2e-a51c-f859e532fe8c
parametersIdstringOptionalExample:
ID of the parameters used in workflow
4b6ffcb6-ab6d-44b9-b5ab-4b5147b0b302
Responses
200
Workflow has been run
404
Workflow Definition Not Found
application/json
post
POST /workflows/run HTTP/1.1
Host: api.transactionlink.io
Content-Type: application/json
Accept: */*
Content-Length: 165
{
"caseId": "11111111-2222-3333-4444-555555555555",
"workflowDefinitionId": "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c",
"parametersId": "4b6ffcb6-ab6d-44b9-b5ab-4b5147b0b302"
}
{
"id": "e1413f5b-acb0-4995-919a-3fc60c9592c5",
"caseId": "c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81",
"status": "COMPLETED"
}
GET
Check Workflow Status
GET
Check Workflow StatusCheck the status of a workflow
Path parameters
workflowIdstring · uuidRequired
Workflow identifier
Responses
200
Returns the Workflow Status
404
Workflow not found
application/json
get
GET /workflows/{workflowId} HTTP/1.1
Host: api.transactionlink.io
Accept: */*
{
"id": "e1413f5b-acb0-4995-919a-3fc60c9592c5",
"caseId": "c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81",
"status": "COMPLETED"
}
GET
Get Workflow Result
GET
Get Workflow ResultRetrieve the result of a workflow
Path parameters
workflowIdstring · uuidRequired
Workflow identifier
Responses
200
Returns the workflow result
404
Workflow not found
application/json
get
GET /workflows/{workflowId}/result HTTP/1.1
Host: api.transactionlink.io
Accept: */*
{
"createdDate": "text",
"caseId": "text",
"partyId": "text",
"partyDetails": {
"personal": {
"firstName": "text",
"lastName": "text",
"personalNumber": "text",
"email": "text",
"phone": {
"countryCode": "text",
"number": "text"
}
},
"business": {
"companyNumber": "text",
"companyName": "text",
"companyAddress": "text"
},
"documents": [
{
"resourceId": "text",
"resourceName": "text",
"resourcePath": "text"
}
]
}
}
Last updated
Was this helpful?