Kaiten API

KaitenDevelopers

rest external webhooks webhooks scim user metadata imports addons

Update iteration

PATCH

https://example.kaiten.ru/api/latest/spaces/{space_uid}/iterations/{id}

This endpoint is currently under active development. Parameters, attributes, and response formats are subject to change. Iterations API is in beta and may change.

Updates an iteration. Status transitions are limited to planned to active and active to closed. Use the DELETE endpoint to remove an iteration. At least one editable field must be provided.

Path parameters

Name	Type	Reference
space_uidrequired	string	Space UID
idrequired	string	Iteration ID

Headers

Name	Value
Authorization	Bearer <token>
Content-Type	application/json

Attributes

schema

{
 "$schema": "http://json-schema.org/draft-06/schema",
 "type": "object",
 "properties": {
  "title": {
   "type": "string",
   "minLength": 1,
   "maxLength": 256,
   "description": "Iteration title"
  },
  "goal": {
   "type": [
    "string",
    "null"
   ],
   "description": "Iteration goal"
  },
  "status": {
   "enum": [
    "planned",
    "active",
    "closed"
   ],
   "description": "Iteration status. Supported transitions are planned to active and active to closed. Use DELETE to remove an iteration"
  },
  "start_date": {
   "type": [
    "string",
    "null"
   ],
   "format": "date-time",
   "description": "Start date. ISO 8601 format"
  },
  "finish_date": {
   "type": [
    "string",
    "null"
   ],
   "format": "date-time",
   "description": "Finish date. ISO 8601 format"
  },
  "actual_finish_date": {
   "type": [
    "string",
    "null"
   ],
   "format": "date-time",
   "description": "Actual finish date, applied when closing an iteration (status 'closed'). Must be later than start_date. Defaults to the current time if omitted. ISO 8601 format"
  },
  "new_iteration_id": {
   "type": [
    "string",
    "null"
   ],
   "description": "ID of the iteration to move unfinished cards to when closing with status 'closed'. Must belong to the same space and have the planned or active status"
  }
 },
 "anyOf": [
  {
   "required": [
    "title"
   ]
  },
  {
   "required": [
    "goal"
   ]
  },
  {
   "required": [
    "status"
   ]
  },
  {
   "required": [
    "start_date"
   ]
  },
  {
   "required": [
    "finish_date"
   ]
  }
 ]
}

Name	Type	Constraints	Description
title	string	minLength: 1 maxLength: 256	Iteration title
goal	string \| null		Iteration goal
status	enum	[planned,active,closed]	Iteration status. Supported transitions are planned to active and active to closed. Use DELETE to remove an iteration
start_date	string \| null		Start date. ISO 8601 format
finish_date	string \| null		Finish date. ISO 8601 format
actual_finish_date	string \| null		Actual finish date, applied when closing an iteration (status 'closed'). Must be later than start_date. Defaults to the current time if omitted. ISO 8601 format
new_iteration_id	string \| null		ID of the iteration to move unfinished cards to when closing with status 'closed'. Must belong to the same space and have the planned or active status

Responses

200

Description	Response type	Example
Success	Object	Open

Response Attributes

Name	Type	Description
id	string	Iteration ID (UUID)
space_uid	string	UID of the space the iteration belongs to
title	string	Iteration title
goal	string \| null	Iteration goal
status	string	Iteration status: planned, active, closed or removed
creator_uid	string	UID of the user who created the iteration
updater_uid	string	UID of the user who last updated the iteration
start_date	string \| null	Start date, ISO 8601 format
finish_date	string \| null	Planned finish date, ISO 8601 format
actual_finish_date	string \| null	Actual finish date, ISO 8601 format
sort_order	number	Sort order of the iteration within the space
data	object \| null Schema	Cached iteration statistics. Null for planned iterations; active iterations contain committed, and closed iterations also contain velocity, doneCount and totalCount
moved_cards	array of objects Schema	Present when closing with new_iteration_id and unfinished cards were moved
created	string	Creation timestamp
updated	string	Last update timestamp

400

Description	Response type	Example
Validation error or lifecycle rule violation: invalid status transition (code 1), missing activation dates (code 2), invalid date range (code 6), or invalid actual finish date (code 7)	Object	Open

Response Attributes

Name	Type	Description
code	number	Numeric error code, present for business-rule violations
message	string	Error message

401

Description	Response type	Example
Invalid token	String	Open

A schema has not been defined for this response code.

402

Description	Response type	Example
Feature is not supported by tariff	Object	Open

Response Attributes

Name	Type	Description
message	string	Error message

403

Description	Response type	Example
Forbidden		Response body does not exist

A schema has not been defined for this response code.

404

Description	Response type	Example
Iteration not found		Response body does not exist

A schema has not been defined for this response code.

Kaiten

Addons terms of use Personal data processing policy

If you have any questions or need help with integration feel free to write us at support@kaiten.ru

Company domain

Path Parameters

space_uid

Raw Body(json format)

  1  curl --request PATCH \
  2       --url 'https://example.kaiten.ru/api/latest/spaces/{space_uid}/iterations/{id}' \
  3       --header 'Accept: application/json' \
  4       --header 'Content-Type: application/json'
  5

Response

ClickTry It!to start a request and see the response here!