States

🔒 Получение состояния для компонента EntityPage (карточка задачи, баги или фичи).

Получение состояния для компонента EntityPage (карточка задачи, баги или фичи).

Access: authorized (10 ) · allowNullCompany: true · Scope: read

Allows: task:read, task:read-drafts, feature:read, product:read, version:read, task:costs, feature:costs (все обязательны; проверка в команде по ресурсу из запроса)

TypeScript (copy-paste)

GET /states/entity-page

<details open><summary><b>Params</b></summary> 
export interface StatesEntityPageParams {
  type: string
  ID: string
  iterationKey?: number | null
}
</details> <details open><summary><b>Response</b></summary> 
export type StatesEntityPageResponse = IServerResponse<Resp_states_entity-page>

export interface IServerResponse<T = any> {
  code: number
  data: T
  srvTS: number
  rkey: string
}
</details>

Полный файл типов: /docs/types · raw: /docs/api-types.ts

get/states/entity-page

Request

  • Base URL: http://localhost
  • URL: http://localhost/states/entity-page
  • Auth: one of:
    • API key in header sid and API key in header rts and API key in header sig
    • HTTP bearer

Query parameters

typestring required

Можно передать header type (сервер мержит headers+query)

IDstring uuid required

Можно передать header ID (сервер мержит headers+query)

iterationKeyinteger nullable

Можно передать header iterationKey (сервер мержит headers+query)

Headers

devIDstring uuid required

UUID устройства клиента

tzstring required
Example:Europe/Moscow

Таймзона клиента (IANA или offset)

appstring required
Example:kosmodrom-web

Имя клиентского приложения

appVerstring required
Example:1.0.0

Версия клиента

rKeystring

Уникальный ключ запроса для логов/саппорта

Response

OK — IServerResponse<Resp_states_entity-page>

codeinteger required
srvTSinteger required

Server timestamp (ms)

rkeystring required

Request key

Example response

{
  "code": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.