Opero APIWorkflows
Get workflow instance history
Authorization
api-token AuthorizationBearer <token>
Opero API token. Send it as Authorization: Bearer ek_...
In: header
Path Parameters
instanceId*string
Workflow instance ID
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/workflows/runtime/instances/string/history"{ "data": { "events": [ { "id": "string", "workflowInstanceId": "string", "workflowId": "string", "eventType": "STARTED", "transitionId": "string", "fromStageId": "string", "toStageId": "string", "stageId": "string", "transitionKey": "string", "transitionName": "string", "fromStageKey": "string", "fromStageName": "string", "toStageKey": "string", "toStageName": "string", "stageKey": "string", "stageName": "string", "fromStage": { "id": "string", "key": "string", "name": "string", "color": "string", "icon": "string" }, "toStage": { "id": "string", "key": "string", "name": "string", "color": "string", "icon": "string" }, "stage": { "id": "string", "key": "string", "name": "string", "color": "string", "icon": "string" }, "actorUserId": "string", "actorMembershipId": "string", "actorApiTokenId": "string", "actorType": "USER", "comment": "string", "payload": {}, "targetSnapshot": { "label": "string", "summary": {} }, "conditionResult": { "passed": true, "failedConditionKey": "string", "reason": "string", "debug": {} }, "createdAt": "2019-08-24T14:15:22Z" } ], "actors": { "users": { "property1": { "id": "string", "firstName": "string", "lastName": "string", "name": "string", "email": "string", "status": "ACTIVE", "isActive": true }, "property2": { "id": "string", "firstName": "string", "lastName": "string", "name": "string", "email": "string", "status": "ACTIVE", "isActive": true } }, "memberships": { "property1": { "id": "string", "userId": "string", "roleIds": [ "string" ] }, "property2": { "id": "string", "userId": "string", "roleIds": [ "string" ] } }, "roles": { "property1": { "id": "string", "key": "string", "name": "string", "color": "string", "icon": "string" }, "property2": { "id": "string", "key": "string", "name": "string", "color": "string", "icon": "string" } }, "apiTokens": { "property1": { "id": "string", "name": "string", "kind": "ORGANIZATION", "isActive": true }, "property2": { "id": "string", "name": "string", "kind": "ORGANIZATION", "isActive": true } } } }}{ "error": { "code": "NOT_FOUND", "message": "Resource not found", "meta": { "partiallyApplied": true, "failedPhase": "defaultForms", "committedObjects": [ { "id": "5e2af9bc-be0b-4ad8-af57-e8319fb115d3", "key": "session", "created": true } ], "fieldsWritten": 1, "fieldsDeleted": 0 }, "fieldErrors": { "name": [ "Field \"name\" is required" ] }, "unavailableMutationScopes": [ "contractor.bankAccounts" ], "clientMutationId": "019f2e3a-7c8b-7a33-9fc8-90db2b5b1e50", "relationTableErrors": {}, "idempotencyConflict": {}, "errors": [ { "message": "relation \"foo\" does not exist" } ], "impacts": [ {} ], "validation": {} }}{ "error": { "code": "NOT_FOUND", "message": "Resource not found", "meta": { "partiallyApplied": true, "failedPhase": "defaultForms", "committedObjects": [ { "id": "5e2af9bc-be0b-4ad8-af57-e8319fb115d3", "key": "session", "created": true } ], "fieldsWritten": 1, "fieldsDeleted": 0 }, "fieldErrors": { "name": [ "Field \"name\" is required" ] }, "unavailableMutationScopes": [ "contractor.bankAccounts" ], "clientMutationId": "019f2e3a-7c8b-7a33-9fc8-90db2b5b1e50", "relationTableErrors": {}, "idempotencyConflict": {}, "errors": [ { "message": "relation \"foo\" does not exist" } ], "impacts": [ {} ], "validation": {} }}{ "error": { "code": "NOT_FOUND", "message": "Resource not found", "meta": { "partiallyApplied": true, "failedPhase": "defaultForms", "committedObjects": [ { "id": "5e2af9bc-be0b-4ad8-af57-e8319fb115d3", "key": "session", "created": true } ], "fieldsWritten": 1, "fieldsDeleted": 0 }, "fieldErrors": { "name": [ "Field \"name\" is required" ] }, "unavailableMutationScopes": [ "contractor.bankAccounts" ], "clientMutationId": "019f2e3a-7c8b-7a33-9fc8-90db2b5b1e50", "relationTableErrors": {}, "idempotencyConflict": {}, "errors": [ { "message": "relation \"foo\" does not exist" } ], "impacts": [ {} ], "validation": {} }}