Workflow execution

Create workflow execution log

post

Create a new workflow execution log

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body
idnumberOptional

Unique identifier

Example: 1
workflowIdnumberOptional

Workflow identifier

Example: 1
statusstring · enumOptional

Execution status

Default: pendingExample: completedPossible values:
startTimeone ofOptional

Start time

Example: 2023-01-01T00:00:00Z
string · dateOptional
or
string · date-timeOptional
endTimeone ofOptional

End time

Example: 2023-01-01T01:00:00Z
string · dateOptional
or
string · date-timeOptional
attributesobjectOptional

Attributes

Default: {}
surveyResponseIdnumberOptional

Survey response identifier

Example: 1
serviceProviderIdnumberOptional

Service provider identifier

Example: 1
consumerIdnumberOptional

Consumer identifier

Example: 1
consumerUuidstringOptional

Consumer internal identifier

Example: 123e4567-e89b-12d3-a456-426614174000
consumerExternalIdstringOptional

Consumer external identifier

Example: 123e4567-e89b-12d3-a456-426614174000
serviceProviderExternalIdstringOptional

Service provider external identifier

Example: 123e4567-e89b-12d3-a456-426614174000
errorsobjectOptional

Errors

Default: {}
Responses
200Success
application/json
post
/api/workflow-execution
200Success

Get workflow execution log

get

Retrieve a specific workflow execution log

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
idnumberRequiredPattern: [^\/#\?]+?
Responses
200Success
application/json
get
/api/workflow-execution/{id}
200Success

Update workflow execution log

put

Update an existing workflow execution log

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
idnumberRequiredPattern: [^\/#\?]+?
Body
idnumberOptional

Unique identifier

Example: 1
workflowIdnumberOptional

Workflow identifier

Example: 1
statusstring · enumOptional

Execution status

Default: pendingExample: completedPossible values:
startTimeone ofOptional

Start time

Example: 2023-01-01T00:00:00Z
string · dateOptional
or
string · date-timeOptional
endTimeone ofOptional

End time

Example: 2023-01-01T01:00:00Z
string · dateOptional
or
string · date-timeOptional
attributesobjectOptional

Attributes

Default: {}
surveyResponseIdnumberOptional

Survey response identifier

Example: 1
serviceProviderIdnumberOptional

Service provider identifier

Example: 1
consumerIdnumberOptional

Consumer identifier

Example: 1
consumerUuidstringOptional

Consumer internal identifier

Example: 123e4567-e89b-12d3-a456-426614174000
consumerExternalIdstringOptional

Consumer external identifier

Example: 123e4567-e89b-12d3-a456-426614174000
serviceProviderExternalIdstringOptional

Service provider external identifier

Example: 123e4567-e89b-12d3-a456-426614174000
errorsobjectOptional

Errors

Default: {}
Responses
200Success
application/json
put
/api/workflow-execution/{id}
200Success

Delete workflow execution log

delete

Delete a specific workflow execution log

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
idnumberRequiredPattern: [^\/#\?]+?
Responses
200Success
application/json
delete
/api/workflow-execution/{id}
200Success