ListChangeRequestWorkItems - List Associated Work Items
Applicable Versions | Central and Regional |
Endpoint and authorization information
- Obtain an endpoint: Replace {domain} in the API request syntax.
- Obtain a personal access token.
- Obtain the organization ID: Required only for the Central Edition. Go to the Basic Information page in the Tennant Management console to obtain the ID.
Product | Resource | Required permission |
Application Delivery | Change | Read-only |
Request syntax
Central Edition
GET https://{domain}/oapi/v1/appstack/organizations/{organizationId}/apps/{appName}/changeRequests/{sn}/workItemsRegional Edition
GET https://{domain}/oapi/v1/appstack/apps/{appName}/changeRequests/{sn}/workItemsRequest headers
Parameter | Type | Required | Description | Example |
x-yunxiao-token | string | Yes | Personal access token. | pt-0fh3****0fbG_35af****0484 |
Request parameters
Parameter | Type | Location | Required | Description | Example |
appName | string | path | Yes | The application name. | my-web-service |
sn | string | path | Yes | You can modify the identifier. | f1e78f22428e4e2496a01691812a17af |
organizationId | string | path |
| The organization ID. | ec766e63aee3437d9a51f334d6exe671 |
Request examples
Central Edition
curl -X 'GET' \
'https://{domain}/oapi/v1/appstack/organizations/ec766e63aee3437d9a51f334d6exe671/apps/my-web-service/changeRequests/f1e78f22428e4e2496a01691812a17af/workItems' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'Regional Edition
curl -X 'GET' \
'https://{domain}/oapi/v1/appstack/apps/my-web-service/changeRequests/f1e78f22428e4e2496a01691812a17af/workItems' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'Response parameters
Parameter | Type | Description | Example |
| - | array | ||
| - | object | ||
| description | string | You can modify the work item description. | Bug work item in Project A |
| name | string | You can change the work item name. | Fix bug |
| sn | string | The unique identifier of the work item for the change. | 3344b6fdd94f43628f63b126209ad1d2 |
| type | string | Change the work item type. | PROJEX |
| value | string | You can modify the work item content. | Fix bug, modify File A and File B |
Response example
[
{
"description": "Bug work item in Project A",
"name": "Fix bug",
"sn": "3344b6fdd94f43628f63b126209ad1d2",
"type": "PROJEX",
"value": "Fix bug, modify File A and File B"
}
]Error codes
For more information about API-related error codes, see the Error Code Center.