v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
todoWorkers

Get worker task flows

get/api/servicetodo/processes/workers/{workerIdentifier}/taskFlows

Path parameters

workerIdentifierstring uuid required

Worker unique identifier

Query parameters

includeArchivedboolean

If true, include archived task flows in the results

Response

A collection of taskFlows for a given worker with data related to the completion of the taskFlow / tasks

Example response

{
  "data": {
    "taskFlows": [
      {
        "uuid": "7a962659-8fb6-4eef-bb98-acd2db913292",
        "lastUpdated": "2023-03-24T00:00:00.000Z",
        "deadlineDate": "2023-03-24T00:00:00.000Z",
        "status": "inProgress",
        "approvedByAdmin": true,
        "tasks": [
          {
            "uuid": "7a962659-8fb6-4eef-bb98-acd2db913292",
            "status": "ready",
            "reviewStatus": "approved",
            "lastUpdatedAt": "2023-09-02T05:53:38.822Z",
            "createdAt": "2023-09-02T05:53:38.822Z",
            "taskUuid": "7a962659-8fb6-4eef-bb98-acd2db913292",
            "virtualTask": {
              "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"
              }
            }
          }
        ]
      }
    ]
  },
  "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
  }
}