Skip to main content

Tasks

Overview​

Manages all aspects of tasks related to requests. This can come from the requests module (eg: leave requests) or due to the submission/approval/rejection of timesheets.

tip

All endpoints in this service use the Base URL of /tasks

warning

It is not possible to create or delete tasks. Tasks are created (and retracted) automatically due to rules within the Decisively rule base

1. Get a Task​

  • Endpoint: /{id}
  • Method: GET
  • Summary: Get a specific tasks

Request Parameters:​

None

Response:​

{
  "goal": "GUID", // the overall goal of this task
  "graph": {}, // A compressed version of the rule graph from Decisively. All data is contained within this
  "id": "GUID",
  "indices": [], // An array of attributes that will be indexed
  "indicesValues": {}, // The values of the requested indices
  "model": "GUID", // The Decisively model this is based on 
  "release": "GUID", // The Decisively release this is based on
  "status": "in-progress", // The status of the session. Note: this is seperate from the status of the underlying timesheet. This will generally be in-progress, until the entire proces is complete in which case it will "complete" (or "error" if a non-recoverable error has been detected)
}

2. Get all Tasks​

  • Endpoint: /
  • Method: GET
  • Summary: Get a task

Request Parameters:​

None

Response:​

{
  "total": 1, // Total number of tasks in the system. Note: only 10 is returned at a time by default
  "items": [{
    // same response as the get task response
  }]
}

Authentication​

Please refer to the authentication guide to understand how to authenticate your requests before interacting with the API.

Error Handling​

Please refer to the error handling guide for details on common errors and how to handle them.