Deleting a Sprint (V2)
Function
This API is used to delete a sprint.
Calling Method
For details, see Calling APIs.
URI
POST /v2/version/delete
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 |
---|---|---|---|
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 |
version_id |
No |
String |
Definition: Unique ID of the deleted sprint. The value is obtained by calling the Querying the Sprint API. The ID in the version field in the response body is the ID of the current sprint. Constraints: N/A Value range: N/A Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result |
String |
Definition: Result of the request for deleting a sprint. Value range: N/A |
status |
String |
Definition: Status of the request for deleting a sprint. Value range: success: The sprint is successfully deleted. error: The sprint deletion failed. |
Example Requests
{endpoint}/v2/version/delete { "project_id" : "ac73924a87d0455ca9b16b0ed15fe367", "version_id" : "26658661" }
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