API ReferenceWorkflows
Path Parameters
workflowId*string
Format
uuidrouterId*string
Format
uuidRequest Body
application/json
Inject workflow step payload
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "http://localhost:8000/api/routers/497f6eca-6276-4993-bfeb-53cbbbba6f08/workflows/497f6eca-6276-4993-bfeb-53cbbbba6f08/steps/inject" \ -H "Content-Type: application/json" \ -d '[ { "index": -2147483648, "stepId": "50e29fb7-490e-4a88-b2f4-2fde4d70423d" } ]'[
{
"workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
"manualAddition": true,
"actorId": "d2f1b55c-8cee-4a0d-af57-aebaeff77518",
"dispatchesActorId": "4b53a359-41fc-4bb3-aae5-be9591e6b70a",
"activeStepDataId": "e6677ddb-5fe7-41b4-8896-8ac5afae52a4",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"descriptionOperator": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Hello world",
"marks": [
{
"type": "bold"
}
]
}
]
}
]
},
"descriptionContractor": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Hello world",
"marks": [
{
"type": "bold"
}
]
}
]
}
]
},
"descriptionClient": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Hello world",
"marks": [
{
"type": "bold"
}
]
}
]
}
]
},
"dependsOnStepId": "e8ff1ea6-401d-4234-97d5-b3d1846438d8",
"isRequired": true,
"type": "booking_create",
"settings": {
"useActorsInstallerNetwork": true,
"isAutoDispatchingEnabled": false,
"retryOnFailure": false,
"multipleDispatches": 1,
"responseDeadlineDays": 10,
"skipWeekendsForResponseDeadline": false
},
"variant": "inspection",
"index": -2147483648,
"actor": "operator",
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"autoComplete": true,
"dueAfterDays": -2147483648,
"dueAtTime": "string",
"dueDateSkipWeekends": true,
"visibleToOperator": true,
"visibleToContractor": true,
"visibleToClient": true,
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
"workflowStepId": "910ae244-d9b7-47aa-bbbd-fedca7553eff",
"status": "todo",
"actionReason": "string",
"dueAt": "2019-08-24",
"dueState": "todo",
"comment": "string",
"actor": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24",
"booking": null,
"currentStatusLog": {
"comment": "string",
"createdAt": "2019-08-24",
"actor": "string"
},
"org": {
"id": "string",
"name": "string"
}
}
],
"status": "todo",
"actorVisibility": [],
"documents": [],
"backgroundEvents": [],
"stepActor": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"name": "string",
"workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
"type": "dispatched",
"source": "order_creator",
"activeRepresentativeId": "30df3691-d989-4adf-b59f-de3617255eaa",
"isMainInstaller": true,
"professions": [
"ELECTRICIAN"
],
"services": [
"AIR_CONDITIONING"
]
},
"description": null,
"productTags": []
}
]