v1
latestOpenAPI 3.0.12026-07-245752052.0 MBtaskFlows
Apply Test task flow changes back to its source draft
post/api/servicetodo/processes/taskFlows/applyTestChangesToDraftForCopilot
Request body
Response
Updated draft task flow
Example response
{
"data": {
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"companyUuid": "7623df0c-84ec-4758-8d05-2a105b273f83",
"status": "draft",
"title": "Bikini Bottom Line Cook",
"internalName": "My internal private flow name",
"description": "Flow for new line cooks at the Bikini Bottom location",
"taskUuids": [
"3c08568d-2ca2-43c0-b303-e54f35b1dc1a"
],
"virtualTasks": [
{
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"companyUuid": "a0ef351f-e91a-45b4-add1-28d4d8ec29b9",
"title": "Read this document",
"description": "You need to read this document before being able to work",
"taskType": "informationSharing",
"subType": "webhook",
"estimatedCompletionMinutes": 90,
"content": {
"buttonLabel": "myBtnLabel",
"attachments": [
{
"storedFileUuid": "a0ef351f-e91a-45b4-add1-28d4d8ec29b9",
"filename": "handbook.pdf",
"mimeType": "application/pdf"
}
],
"signDoc": {
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"name": "Profile pic.png",
"technicalName": "profile_pic.png",
"companyUuid": "2c84a7c1-4c68-41d8-9376-2a14c60de15f"
},
"section2CompletionMethods": [
{
"methodName": "authorizedRepresentative",
"reminder": 24,
"customConferencing": {
"providerDescription": "Zoom",
"joinUrl": "https://www.my-conferencing.com/join/xyz"
}
}
],
"triggerableType": "task",
"companyAttributeSet": {
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"companyUuid": "bd1663ba-1d09-4554-a21a-d7a62e9b0435",
"label": "European companies",
"companyAttributes": [
{
"companyAttributeUuid": "887436c5-47f4-43cc-963a-1d1d4e21f665",
"companyAttribute": {
"uuid": "8223636c5-47f4-43cc-963a-1d1d4e22b665",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"label": "Attribute 1",
"key": "attribute_1",
"dataType": "string",
"description": "The first attribute in my company",
"hireUuid": "123e4567-e89b-12d3-a456-426614174232",
"attachedToModel": "location"
}
}
]
},
"requirementUuid": "a0ef351f-e91a-45b4-add1-28d4d8ec29b9"
}
}
],
"segmentUuids": [
"08fad9d8-cb47-4b32-8d87-8ef0b7692073"
],
"virtualSegments": [
{
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"name": "Houston workers",
"description": "Segmentation of all drivers located in Houston",
"filters": "{\"and\":[{\"displayFullName\":{\"regex\":\"test\",\"options\":\"i\"}},{\"personalEmail.email\":{\"regex\":\"mail.com\",\"options\":\"i\"}}]}",
"filterValues": "0[id]=displayFullName&0[operator]=regex&0[value]=test&1[id]=personalEmail.email&1[operator]=regex&1[value]=mail.com",
"pipeline": "{\"$addFields\":{\"33b3a7be-3033-4617-9b92-cb0ef311f418\":[{\"eq\":[\"$location\",\"Houston\"]},true,\"$$REMOVE\"]}}",
"companyUuid": "88aab78c-65f0-4d86-bd61-1e30a24be5aa",
"subscriptions": [
{
"service": "todo",
"key": "bind_workflow_219edc8d-1394-4757-9bb0-d33eda69838e"
}
],
"segmentType": "default",
"dynamicFilters": {
"event": "startDate",
"eventOffsetDirection": "before",
"offsetDays": 30,
"finalOffsetDirection": "after"
},
"observerRecurrence": {
"type": "annual"
},
"baseObserverSegmentUuids": [
"ee446039-f06a-4b4b-834e-c51aff5b4fe8"
],
"timezone": "America/Chicago"
}
],
"taskFlowType": "preboarding",
"messages": {
"email": {
"subject": "Welcome to GoatFarm",
"content": "We're so glad to have you onboard, please be ready for your first day of work by checking all your tasks on this link: ..."
},
"sms": {
"content": "We're so glad to have you onboard, please be ready for your first day of work by checking all your tasks on this link: ..."
}
},
"deadline": {
"delayInDays": 5,
"triggerProperty": "assignmentDate",
"remindBeforeDays": 5
},
"reminder": {
"recurringDays": 2,
"messages": {
"email": {
"subject": "Welcome to GoatFarm",
"content": "We're so glad to have you onboard, please be ready for your first day of work by checking all your tasks on this link: ..."
},
"sms": {
"content": "We're so glad to have you onboard, please be ready for your first day of work by checking all your tasks on this link: ..."
}
}
},
"redirectUrl": "https://www.goatfarm.com",
"workerCounts": {
"total": 150,
"notStarted": 20,
"inProgress": 50,
"completed": 70,
"overdue": 5,
"error": 2,
"toReview": 3
}
},
"meta": {
"timestamp": "2021-05-05T09:47:58.924Z",
"verb": "GET",
"path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
"jti": "%cQN3RIGp",
"rid": "$2d2zkHZ5",
"count": 1,
"status": "200",
"duration": 17,
"size": 1234
}
}