v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
dashboardPendingTasks

Get dashboard pending tasks summary

get/api/servicetodo/processes/dashboard/pending-tasks-summary

Query parameters

locationUuidsstring[]
jobUuidstring uuid
assignedUserUuidsstring[]

Empty = all assignees; non-empty = internal tasks assigned to any of these employer UUIDs

taskTypesstring[]

Empty = all task types; non-empty = only tasks whose virtualTask.taskType is in this list

Response

Returns the employer dashboard pending tasks summary.

Example response

{
  "data": {
    "total": 4,
    "workersMissingStartDate": {
      "count": 1,
      "status": "critical",
      "type": "workerMissingStartDate",
      "workers": [
        {
          "displayFullName": "Fleur Delacour",
          "uuid": "48c21eb0-ec96-475f-b8a4-ac2b9359f412"
        }
      ]
    },
    "pendingTasksSummary": [
      {
        "count": 2,
        "tasks": [
          {
            "assignedTaskUuid": "edb1385d-c08a-4d3c-b721-51d38450fe83",
            "status": "inProgress",
            "title": "Contract",
            "taskType": "documentSigning",
            "requireReview": true,
            "worker": {
              "uuid": "739fa0e1-7966-4ba3-8846-f523d448190e",
              "displayFullName": "Hermione Granger"
            }
          }
        ],
        "status": "needsReview",
        "type": "documentSigning"
      }
    ]
  },
  "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
  }
}