Task

Query Tasks

GET

Retrieve a list of Tasks that match an OData formatted query.

A Task is an individual element of work that must be performed to complete a Project. A Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to indicate whether they have a dependency or a connection.

Query parameters

$topintegerOptional
The number of records to return
$skipintegerOptional
Skips the given number of records and then returns $top records
$filterstringOptional
Filter the expression according to oData queries
$orderbystringOptional
Order collection by this field.
$expandstringOptional
Include related data in the response

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
list of objectsOptional
If the API call succeeded, this will contain the results.
GET
$curl /api/data/tasks \
>     -H "Authorization: Bearer <token>"
Response
1{
2  "error": {
3    "technicalError": "technicalError",
4    "additionalErrors": [
5      "additionalErrors"
6    ],
7    "message": "message"
8  },
9  "success": true,
10  "hasError": true,
11  "statusCode": "Continue",
12  "data": [
13    {
14      "id": "id",
15      "tags": [
16        {}
17      ],
18      "projectId": "projectId",
19      "assignees": [
20        {}
21      ],
22      "todos": [
23        {}
24      ],
25      "shortId": "shortId",
26      "name": "name",
27      "description": "description",
28      "plannedStartDate": "plannedStartDate",
29      "plannedFinishDate": "plannedFinishDate",
30      "actualStartDate": "actualStartDate",
31      "actualFinishDate": "actualFinishDate",
32      "actualEffort": 1,
33      "modifyDate": "2024-01-15T09:30:00Z",
34      "createDate": "2024-01-15T09:30:00Z",
35      "percentComplete": 1,
36      "isSummary": true,
37      "priorityId": 1,
38      "wbs": "wbs",
39      "color": "color",
40      "actualCost": 1.1,
41      "actualResourceCost": 1.1,
42      "plannedCost": 1.1,
43      "plannedResourceCost": 1.1,
44      "plannedDuration": 1,
45      "plannedEffort": 1,
46      "fields": [
47        {}
48      ],
49      "fieldValues": [
50        {}
51      ],
52      "files": [
53        {}
54      ]
55    }
56  ]
57}
Built with