Online Docs
English
Tiếng Việt

Get task

Retrieves all the properties of a task object.

1
2
3
4
GET /api/tasks/{task-id}/details  
--x-appvity-channelId: [ChannelID]  
--x-appvity-teamid: [TeamID]  
--Cookie: graphNodeCookie=[ID] |

URL Endpoint

/api/tasks/{task-id}/details

Method

GET.

Parameters

Do not supply OData Filter syntax.

Request

Header

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

Body

This method does not supply the request body.

Response

If status of task is not mapping, status property will be Invalid and the sync property display as follows:

1
2
3
4
"sync": {
    "status": "ETASK_MAPPING_NOTFOUND",
    "at": "2020-09-07T03:05:55.461Z"
}

If status of task is not mapping, “status” property will be the status of eTask, and the “sync” property display as follows:

1
2
3
4
"sync": {
    "status": **null**,
    "at": "2020-09-07T03:05:56.768Z"
}

Success

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

Errors

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

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/5f5ee4929669798c31909601/details' \

--header 'Content-Type: application/json' \
--header 'x-appvity-channelId: 19:15c258785b4040699180e7a8ad6c6014@thread.tacv2' \
--header 'x-appvity-teamid: 19:15c258785b4040699180e7a8ad6c6014@thread.tacv2' \
--header 'Cookie: graphNodeCookie=s%3AP6Q5jPUtwmssNyjIzya3wsfcRKXabP2_.0JO9NorfqswRNvufDBQ2P9RgcUJJFuePB102P%2FMPclY'

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
{
    "bucket":null,
    "assignedTo":[
        {
            "_id":"5bce7df753b66e19aaa3e8a0",
            "sourceId":"5083cb81-35f4-4abd-ba2d-e7b9965c1f89",
            "displayName":"Oliver Neal",
            "email":"oliver@anadea",
            "source":"Microsoft.Graph.User",
            "username":"oliver@anadea.com"
        }
    ],
    "attachments":[],
    "_id":"5f5ee4929669798c31909601",
    "source":"Appvity.eTask",
    "name":"Update Api document",
    "owner":"Cora Rowland",
    "priority":"High",
    "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"
    },
    "createdAt":"2020-09-14T03:33:38.919Z",
    "createdBy":{
        "name":"Oliver Neal",
        "username":"oliver@anadea.com",
        "sourceId":"5083cb81-35f4-4abd-ba2d-e7b9965c1f89"
    },
    "updatedAt":"2020-09-15T01:43:54.430Z",
    "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,
    "__v":1,
    "complete":0,
    "completedDate":null,
    "updatedBy":{
        "name":"Oliver Neal",
        "username":"oliver@anadea.com",
        "sourceId":"5083cb81-35f4-4abd-ba2d-e7b9965c1f89"
    },
    "conversationId":"1600073872415",
    "phase":null,
    "id":"5f5ee4929669798c31909601"
}

Comment

Was this article helpful?
Thanks For Your Feedback
app icon authorize

© Appvity. All rights reserved.

app icon contact us app icon facebook app icon linkedin