Updating a Sprint (V2)
Function
This API is used to update a sprint.
Calling Method
For details, see Calling APIs.
URI
POST /v2/version/update
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: User token. Obtain the token by calling theObtaining a User TokenIAM API. In the returned response header, X-Subject-Token is the desired user token. Constraints: Mandatory. Range: Minimum length: 10 character. Maximum length: 32,768 characters. Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
due_date |
No |
Integer |
Definition: End date of the current sprint (in the timestamp format, for example, 1757952000000). Constraints: N/A Value range: N/A Default value: N/A |
id |
No |
Integer |
Definition: Digital ID of the current sprint. Constraints: N/A Value range: N/A Default value: N/A |
name |
No |
String |
Definition: Sprint name after modification. Constraints: N/A Value range: N/A Default value: N/A |
start_date |
No |
Integer |
Definition: Start date of the current sprint (in the timestamp format, for example, 1757952000000). Constraints: N/A Value range: N/A Default value: N/A |
project_id |
No |
String |
Definition: 32-character ID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API. Constraints: N/A Value range: N/A Default value: N/A |
update_workitem_date |
No |
Boolean |
Definition: Whether to change the estimated start and end time of all work items in the sprint. Constraints: N/A Value range: true: Synchronization is required. false: Synchronization is not required. Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result |
String |
Definition: Returned result of changing the sprint name. Value range: N/A |
status |
String |
Definition: Returned status of changing a sprint. Value range: success: The modification is successful. error: The modification fails. |
Example Requests
{endpoint}/v2/version/update { "due_date" : 1754064000000, "id" : 26664721, "name" : "test", "start_date" : 1752854400000, "project_id" : "5192de5eb435430c8cd41c6ae6028848", "update_workitem_date" : false }
Example Responses
Status code: 200
OK (The request has succeeded).
{ "result" : "", "status" : "success" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK (The request has succeeded). |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot