UpdateVersion - Update version
Updates a project version in Yunxiao Project Collaboration.
|
Applicable editions |
Central edition, Region edition |
Endpoint and authorization information
- Get the endpoint: Replace {domain} in the API request syntax.
- Obtain a personal access token.
- Obtain organizationId: Required for Central edition only. Go to the Basic Information page in the Organization Management console to retrieve your organization ID.
|
Product |
Resource |
Required Permissions |
|
Project Collaboration |
Version |
Read and write |
Request syntax
Central edition
PUT https://{domain}/oapi/v1/projex/organizations/{organizationId}/projects/{projectId}/versions/{id}Region edition
PUT https://{domain}/oapi/v1/projex/projects/{projectId}/versions/{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 version identifier. |
bfbb5f44f3aaab11460cd1**** |
|
organizationId |
string |
path |
|
Organization ID. |
|
| - |
object |
body |
No |
|
|
| name |
string |
body |
Yes |
Version name. |
|
| operatorId |
string |
body |
No |
User ID of the operator. Ignored when a personal access token is used. |
user-xxx |
| owners |
array[string] |
body |
No |
User IDs of owners. |
|
| publishDate |
string |
body |
No |
Release date. |
2023-03-01 |
| startDate |
string |
body |
No |
Start date. |
2023-01-01 |
Request examples
Central edition
curl -X 'PUT' \
'https://{domain}/oapi/v1/projex/organizations/{organizationId}/projects/589c53d622cc8521793e08****/versions/bfbb5f44f3aaab11460cd1****' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
--data '
{
"name": "",
"operatorId": "user-xxx",
"owners": [
],
"publishDate": "2023-03-01",
"startDate": "2023-01-01"
}'Region edition
curl -X 'PUT' \
'https://{domain}/oapi/v1/projex/projects/589c53d622cc8521793e08****/versions/bfbb5f44f3aaab11460cd1****' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
--data '
{
"name": "",
"operatorId": "user-xxx",
"owners": [
],
"publishDate": "2023-03-01",
"startDate": "2023-01-01"
}'Response parameters
None
Error codes
For API error codes, see Error Code Center.