Online Docs

Tasks list

Retrieve a list of tasks in the eTask project per Team/Channel.

--Cookie, --x-appvity-teamid, and --x-appvity-channelId are required and --x-appvity-groupId and --x-appvity-entityId are not.

This operation returns by default only of all the available properties. To get the task’s properties that are not returned by default, specify them in a $select OData query option.

1
2
3
4
GET /api/tasks [?<CommonODataExpression>]   
--x-appvity-channelId: [ChannelID]
--x-appvity-teamid: [TeamID]
--Cookie: graphNodeCookie=[ID]

URL Endpoint

/api/tasks

Method

GET.

Parameters

This method supports the $select, $count, $orderby, $top and $filter OData Filter parameters to help customize the response.

Request

Headers

1
2
3
--x-appvity-channelId: [ChannelID]
--x-appvity-teamid: [TeamID]
--Cookie: graphNodeCookie=[ID]

Body

This method does not supply the request body.

Response

Success

If successful, this method returns a 200 OK response code and collection of task objects in the response body.

Error

If the --Cookie: graphNodeCookie=[ID] expires, returns 401 Unauthorized.

This method returns 404 Not Found and Must run inside Microsoft Teams. message when missing –x-appvity-channelId or –x-appvity-teamid.

Example

Request

1
2
3
4
5
6
curl --location --request GET
'https://teams.appvity.com/api/tasks?$count=true&$top=16&$orderby=internalId%20desc'\
--header 'x-appvity-groupId: f87faa71-57a8-4c14-91f0-517f54645106' \
--header 'x-appvity-channelId: 19:15c258785b4040699180e7a8ad6c6014@thread.tacv2' \
--header 'Content-Type: application/json' \
--header 'Cookie:graphNodeCookie=s%3A7fny8dhq1t5QO4Z9UNMYylwYpS0WfpRC.8vknvG34SrmKol3FvYAzcKdzPa28mDQIxt48qc0LrBE' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
{
"@odata.context": "https://schema.appvity.com/odata/$metadata#tasks",
"value": [
{
"bucket": [],
"assignedTo": [
{
"_id": "5bce7df753b66e19aaa3e86c",
"sourceId": "a88776b0-3a51-4431-a7fe-d3e2e4a07448",
"displayName": "Amie Massey",
"source": "Microsoft.Graph.User",
"username": "amiemassey@anadea.com"
}
],
"attachments": [],
"_id": "5f5ee4c49669798c31909605",
"source": "Appvity.eTask",
"name": "Change Schema of API",
"owner": "Cora Rowland",
"priority": "Normal",
"status": "Not Started",
"body": "",
"startDate": "2020-09-01T17:00:00.000Z",
"dueDate": "2020-09-24T17:00:00.000Z",
"effort": "",
"projectId": {
"enableBug": true,
"_id": "5f5ed93a9669798c318eb6c7",
"displayName": "eSource"
},
"tenantId": "df7abg9c-c05a-4fc9-b958-64faered911d",
"createdAt": "2020-09-14T03:34:28.863Z",
"createdBy": {
"name": "Oliver Neal",
"username": "oliver@anadea.com",
"sourceId": "5083cb81-35f4-4abd-ba2d-e7b9965c1f89"
},
"updatedAt": "2020-09-14T03:34:28.885Z",
"teamId": "19:15c258785b4040699180e7a8ad6c6014@thread.tacv2",
"channelId": "19:15c258785b4040699180e7a8ad6c6014@thread.tacv2",
"groupId": "f87faa71-57a8-4c14-91f0-517f54645106",
"entityId": "eTask.30c4d651-af40-4739-f9a1-5da75d4fbb4b",
"sourceId": "5f5ee4c49669798c31909605",
"statusId": {
"_id": "5f5ed9639669798c318eb767",
"category": "New"
},
"internalId": 2,
"phaseName": null,
"bucketName": null,
},
{
"bucket": [],
"assignedTo": [
{
"_id": "5bce7df753b66e19aaa3e8a0",
"sourceId": "5083cb81-35f4-4abd-ba2d-e7b9965c1f89",
"displayName": "Oliver Neal",
"source": "Microsoft.Graph.User",
"username": "oliver@anadea.com"
}
],
"attachments": [],
"_id": "5f5ee4929669798c31909601",
"source": "Appvity.eTask",
"name": "Update Api document",
"owner": "Cora Rowland",
"priority": "Normal",
"status": "Not Started",
"body": "",
"startDate": "2020-09-01T17:00:00.000Z",
"dueDate": "2020-09-24T17:00:00.000Z",
"effort": "",
"projectId": {
"enableBug": true,
"_id": "5f5ed93a9669798c318eb6c7",
"displayName": "eSource"
},
"tenantId": "df7abg9c-c05a-4fc9-b958-64faered911d",
"createdAt": "2020-09-14T03:33:38.919Z",
"createdBy": {
"name": "Oliver Neal",
"username": "oliver@anadea.com",
"sourceId": "5083cb81-35f4-4abd-ba2d-e7b9965c1f89"
},
"updatedAt": "2020-09-14T03:33:38.940Z",
"teamId": "19:15c258785b4040699180e7a8ad6c6014@thread.tacv2",
"channelId": "19:15c258785b4040699180e7a8ad6c6014@thread.tacv2",
"groupId": "f87faa71-57a8-4c14-91f0-517f54645106",
"entityId": "eTask.30c4d651-af40-4739-f9a1-5da75d4fbb4b",
"sourceId": "5f5ee4929669798c31909601",
"statusId": {
"_id": "5f5ed9639669798c318eb767",
"category": "New"
},
"internalId": 1,
"phaseName": null,
"bucketName": null,
}
],
"@odata.count": 2
}

Comment

Was this article helpful?
Thanks For Your Feedback