Updated on 2023-06-12 GMT+08:00

Update Scrum Project Iteration

Function

Update Scrum Project Iteration

URI

PUT /v4/projects/{project_id}/iterations/{iteration_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the 32-bit ID of the devcloud project.

Minimum: 32

Maximum: 32

iteration_id

Yes

Integer

Identifies a sprint.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Minimum: 10

Maximum: 32768

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

begin_time

Yes

String

Start time, in the format of year-month-day.

description

No

String

Description

end_time

Yes

String

End time, in the format of year-month-day.

name

Yes

String

Title

status

No

String

Iteration status. The options are as follows: 0: not started <--> 1: in progress <--> 2: ended <--> 1<--> 0. The status cannot be changed across states.

over_type

No

String

When the iteration ends, all work items are closed, and work items that are not closed are placed in the block. When the value of status is updated to 2, over_type needs to be set.

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Description

error_code

String

Error Codes

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Description

error_code

String

Error Codes

Example Requests

Put https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/iteration/11225793

{
  "end_time" : "2018-07-05",
  "name" : "sttes32s3",
  "begin_time" : "2018-1-31",
  "description" : ""
}

Example Responses

None

Status Codes

Status Code

Description

204

No Content

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.