Retrieve a list of errors for a workflow instance
GET https://automation.8x8.com/api/v1/accounts/:accountId/definitions/:definitionId/workflows/:workflowId/errors
Use this resource to retrieve a list of runtime errors for a workflow instance. If the workflow definition is not working as expected, workflow errors help you figure out what went wrong.
Request
Path Parameters
Account id
Workflow definition id.
Workflow instance id.
List of workflow instance errors.
Schema
- Array [
- ]
Unique id of the workflow instance to which the error belongs to.
Id of the step that faulted.
Reason for failure.
ISO 8601 formatted timestamp of the time the error occurred.
[
{
"workflowId":"string",
"step":"string",
"message":"string",
"errorTime":"string"
}
]
{
"workflowId":"60e6b22fc517c0785de3ca22",
"step":"step1",
"message":"Invalid subaccount id.",
"errorTime":"2021-06-30T03:21:25.83Z"
}
Request is invalid.
Schema
Error code.
Description of the error.
Unique error id.
Timestamp when the error occurred.
{
"code":0,
"message":"string",
"errorId":"string",
"timestamp":"string"
}
{
"code":1000,
"message":"Invalid definition id.",
"errorId":"2558ff83-c8db-4890-805e-ad64001857a1",
"timestamp":"2021-07-13T01:28:37.66Z"
}
Workflow instance or definition is not found.
Schema
Error code.
Description of the error.
Unique error id.
Timestamp when the error occurred.
{
"code":0,
"message":"string",
"errorId":"string",
"timestamp":"string"
}
{
"code":1300,
"message":"Definition 2aa9465e-dec7-4c3e-8fa6-bd168af9eaca not found.",
"errorId":"2558ff83-c8db-4890-805e-ad64001857a1",
"timestamp":"2021-07-13T01:28:37.66Z"
}
Source: https://developer.8x8.com/connect/reference/get-instance-errors · 8x8 CPaaS Developer Docs. Synced for support deflection.
0 Comments