Endpoint and authorization information
- Get the endpoint: Replace {domain} in the API request syntax.
- Get a personal access token.
|
Product |
Resource |
Required permission |
|
Project Collaboration |
Iteration |
Read-only |
Request syntax
Region edition
GET https://{domain}/oapi/v1/projex/projects/{projectId}/sprints/{id}Request headers
|
Parameter |
Type |
Required |
Description |
Example value |
|
x-yunxiao-token |
string |
Yes |
Personal access token. |
pt-0fh3****0fbG_35af****0484 |
Request parameters
|
Parameter |
Type |
Location |
Required |
Description |
Example value |
|
projectId |
string |
path |
Yes |
Unique project identifier. |
589c53d622cc8521793e08**** |
|
id |
string |
path |
Yes |
Unique iteration identifier. |
892153d622cc8521793e08**** |
Request examples
Region edition
curl -X 'GET' \
'https://{domain}/oapi/v1/projex/projects/589c53d622cc8521793e08****/sprints/892153d622cc8521793e08****' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'Response parameters
|
Parameter |
Type |
Description |
Example value |
| - |
object |
|
|
| capacityHours |
integer |
Iteration capacity in hours. |
100 |
| creator |
object |
Owner. |
|
| id |
string |
User ID. |
674d96abd497cd558d68**** |
| name |
string |
Username. |
user-name-xxx |
| description |
string |
Description. |
test |
| endDate |
string |
End date. |
|
| gmtCreate |
string |
Creation timestamp. |
|
| gmtModified |
string |
Update timestamp. |
|
| id |
string |
ID. |
1111 |
| locked |
boolean |
Is it locked? |
false |
| modifier |
object |
Owner. |
|
| id |
string |
User ID. |
674d96abd497cd558d68**** |
| name |
string |
Username. |
user-name-xxx |
| name |
string |
Name. |
sprint-test |
| owners |
array |
Owners. |
|
| - |
object |
Owner. |
|
| id |
string |
User ID. |
674d96abd497cd558d68**** |
| name |
string |
Username. |
user-name-xxx |
| startDate |
string |
Start date. |
|
| status |
string |
Status. Possible values: TODO (not started), DOING (in progress), ARCHIVED (completed). |
TODO |
Response example
{
"capacityHours": 100,
"creator": {
"id": "674d96abd497cd558d68****",
"name": "user-name-xxx"
},
"description": "test",
"endDate": "",
"gmtCreate": "",
"gmtModified": "",
"id": "1111",
"locked": false,
"modifier": {
"id": "674d96abd497cd558d68****",
"name": "user-name-xxx"
},
"name": "sprint-test",
"owners": [
{
"id": "674d96abd497cd558d68****",
"name": "user-name-xxx"
}
],
"startDate": "",
"status": "TODO"
}Error codes
For more information, see Error Code Center for API-related error codes.