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

Creating a Scrum Project Iteration

Function

Creating a Scrum Project Iteration

URI

POST /v4/projects/{project_id}/iteration

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

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

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

id

Integer

Identifies a sprint.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Description

error_code

String

Error Codes

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Description

error_code

String

Error Codes

Example Requests

Post https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/iteration

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

Example Responses

Status code: 201

OK

{
  "id" : 7312121
}

Status Codes

Status Code

Description

201

OK

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.