Online Docs
English
Tiếng Việt

Status List

Retrieve the list of all statuses in the specified channel within a team.

1
2
3
4
GET odata/status  
  --x-appvity-channelId: [ChannelID]  
  --x-appvity-teamid: [TeamID]  
  --Cookie: graphNodeCookie=[ID]

URL Endpoint

odata/status

Method

GET.

Parameters

This method supports the $filter and $select OData Filter to help customize the response.

Request

Header

1
2
3
4
5
--x-appvity-channelId: [ChannelID]

--x-appvity-teamid: [TeamID]

--Cookie: graphNodeCookie=[ID]

Body

This method does not supply the request body.

Response

If successful, this method returns a 200 OK response code and the list of statuses object in the response body.

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
{

"@odata.context":
"https://schema.appvity.com/odata/$metadata#status(_id,name,primary,color)",

"value": [

{

"_id": [StatusID],

"type": [entityType],

"name": "[Statusname],

"category": [Category],

"description": [StatusDescription],

"order":[OrderNo],

"value": [OrderNo],

"color": [ColorCode],

"primary": [true/false]

}

]

}

Example:

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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
{

"@odata.context": "https://schema.appvity.com/odata/$metadata#status",

"value": [

{

"_id": "5f5ed9639669798c318eb767",

"type": "Task",

"name": "Not Started",

"category": "New",

"description": "A new thing to do",

"order": 1,

"value": 1,

"color": "#C3C8C0",

"primary": ## true## 

},

{

"_id": "5f5ed9639669798c318eb768",

"type": "Task",

"name": "In Progress",

"category": "Active",

"description": "Happening",

"order": 2,

"value": 2,

"color": "#78BD6A",

"primary": ## false## 

},

{

"_id": "5f5ed9639669798c318eb76a",

"type": "Task",

"name": "Completed",

"category": "Done",

"description": "Finish doing something",

"order": 4,

"value": 4,

"color": "#474876",

"primary": ## false## 

},

{

"_id": "5f5ed9639669798c318eb76b",

"type": "Bug",

"name": "Not Started",

"category": "New",

"description": "A new thing to do",

"order": 1,

"value": 1,

"color": "#C3C8C0",

"primary": ## true## 

},

{

"_id": "5f5ed9639669798c318eb76c",

"type": "Bug",

"name": "In Progress",

"category": "Active",

"description": "Happening",

"order": 2,

"value": 2,

"color": "#78BD6A",

"primary": ## false## 

},

{

"_id": "5f5ed9639669798c318eb76d",

"type": "Bug",

"name": "Resolved",

"category": "Active",

"description": "End a problem",

"order": 3,

"value": 3,

"color": "#295499",

"primary": ## false## 

},

{

"_id": "5f5ed9639669798c318eb76f",

"type": "Bug",

"name": "Completed",

"category": "Done",

"description": "Stop operating",

"order": 5,

"value": 5,

"color": "#6162A5",

"primary": ## false## 

}

]

}

Error

Code: 401 UNAUTHORIZED, 500 ERROR EXCEPTION.
Content: {error: “error message”}

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