GET api/tasks?id={id}&showAssignedDetails={showAssignedDetails}&filterMyTask={filterMyTask}&age={age}
Returns a list of Tasks
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
the unique id of the parent\location to get tasks from |
integer |
Default value is 0 |
| showAssignedDetails |
Include the users and groups that the tasks are assigned to, setting to false will improve performance |
boolean |
Default value is True |
| filterMyTask |
true will return tasks user is assigned to, false will return all tasks |
boolean |
Default value is False |
| age |
The time in minutes to limit tasks based on create date, ) will ignore this setting but it should be set to increase speed when using this to get recent tasks. |
integer |
Default value is 0 |
Body Parameters
None.
Response Information
Resource Description
List of Tasks
Collection of SDTask| Name | Description | Type | Additional information |
|---|---|---|---|
| startDate |
Task Start Date |
date |
None. |
| endDate |
Task End Date |
date |
None. |
| overdue |
Flag set if the task is overdue, this is based on endDate and status |
boolean |
None. |
| myTask |
Flag showing if task is assigned to the current user |
boolean |
None. |
| assignedUsers | Collection of ViewUserDTO |
None. |
|
| assignedGroups | Collection of ViewGroupDTO |
None. |
|
| children |
A list of Child Tasks |
Collection of SDTask |
None. |
| mySubTask |
Flag showing if one of the child tasks is assigned to the current user. |
boolean |
None. |
| i_node |
Unique database id of the item |
integer |
None. |
| f_node |
Unique database id of the item's parent, this is needed sometimes to figure out the structure of the content |
integer |
None. |
| item |
Name\Title of the item |
string |
None. |
| description |
Description of the item |
string |
None. |
| creator |
User details who created the item |
ViewUserDTO |
None. |
| status |
Current status of the item |
string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"startDate": "2024-09-08T03:19:44.9036292+00:00",
"endDate": "2024-09-08T03:19:44.9036292+00:00",
"overdue": true,
"myTask": true,
"assignedUsers": [
{
"userID": 1,
"userName": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"email": "sample string 5",
"customFields": [
{
"values": [
"sample string 1",
"sample string 2"
],
"guid": "sample string 1",
"type": "sample string 2",
"dataType": "sample string 3"
},
{
"values": [
"sample string 1",
"sample string 2"
],
"guid": "sample string 1",
"type": "sample string 2",
"dataType": "sample string 3"
}
],
"status": "sample string 6",
"createDate": "2024-09-08T03:19:44.9036292+00:00",
"groups": [
{
"name": "sample string 1",
"id": 2
},
{
"name": "sample string 1",
"id": 2
}
]
},
{
"userID": 1,
"userName": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"email": "sample string 5",
"customFields": [
{
"values": [
"sample string 1",
"sample string 2"
],
"guid": "sample string 1",
"type": "sample string 2",
"dataType": "sample string 3"
},
{
"values": [
"sample string 1",
"sample string 2"
],
"guid": "sample string 1",
"type": "sample string 2",
"dataType": "sample string 3"
}
],
"status": "sample string 6",
"createDate": "2024-09-08T03:19:44.9036292+00:00",
"groups": [
{
"name": "sample string 1",
"id": 2
},
{
"name": "sample string 1",
"id": 2
}
]
}
],
"assignedGroups": [
{
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"tags": "sample string 4"
},
{
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"tags": "sample string 4"
}
],
"children": [],
"mySubTask": true,
"i_node": 6,
"f_node": 7,
"item": "sample string 8",
"description": "sample string 9",
"creator": {
"userID": 1,
"userName": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"email": "sample string 5",
"customFields": [
{
"values": [
"sample string 1",
"sample string 2"
],
"guid": "sample string 1",
"type": "sample string 2",
"dataType": "sample string 3"
},
{
"values": [
"sample string 1",
"sample string 2"
],
"guid": "sample string 1",
"type": "sample string 2",
"dataType": "sample string 3"
}
],
"status": "sample string 6",
"createDate": "2024-09-08T03:19:44.9036292+00:00",
"groups": [
{
"name": "sample string 1",
"id": 2
},
{
"name": "sample string 1",
"id": 2
}
]
},
"status": "sample string 10"
},
{
"startDate": "2024-09-08T03:19:44.9036292+00:00",
"endDate": "2024-09-08T03:19:44.9036292+00:00",
"overdue": true,
"myTask": true,
"assignedUsers": [
{
"userID": 1,
"userName": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"email": "sample string 5",
"customFields": [
{
"values": [
"sample string 1",
"sample string 2"
],
"guid": "sample string 1",
"type": "sample string 2",
"dataType": "sample string 3"
},
{
"values": [
"sample string 1",
"sample string 2"
],
"guid": "sample string 1",
"type": "sample string 2",
"dataType": "sample string 3"
}
],
"status": "sample string 6",
"createDate": "2024-09-08T03:19:44.9036292+00:00",
"groups": [
{
"name": "sample string 1",
"id": 2
},
{
"name": "sample string 1",
"id": 2
}
]
},
{
"userID": 1,
"userName": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"email": "sample string 5",
"customFields": [
{
"values": [
"sample string 1",
"sample string 2"
],
"guid": "sample string 1",
"type": "sample string 2",
"dataType": "sample string 3"
},
{
"values": [
"sample string 1",
"sample string 2"
],
"guid": "sample string 1",
"type": "sample string 2",
"dataType": "sample string 3"
}
],
"status": "sample string 6",
"createDate": "2024-09-08T03:19:44.9036292+00:00",
"groups": [
{
"name": "sample string 1",
"id": 2
},
{
"name": "sample string 1",
"id": 2
}
]
}
],
"assignedGroups": [
{
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"tags": "sample string 4"
},
{
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"tags": "sample string 4"
}
],
"children": [],
"mySubTask": true,
"i_node": 6,
"f_node": 7,
"item": "sample string 8",
"description": "sample string 9",
"creator": {
"userID": 1,
"userName": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"email": "sample string 5",
"customFields": [
{
"values": [
"sample string 1",
"sample string 2"
],
"guid": "sample string 1",
"type": "sample string 2",
"dataType": "sample string 3"
},
{
"values": [
"sample string 1",
"sample string 2"
],
"guid": "sample string 1",
"type": "sample string 2",
"dataType": "sample string 3"
}
],
"status": "sample string 6",
"createDate": "2024-09-08T03:19:44.9036292+00:00",
"groups": [
{
"name": "sample string 1",
"id": 2
},
{
"name": "sample string 1",
"id": 2
}
]
},
"status": "sample string 10"
}
]