Design

🔒 Словарь снимков Design для открытой сущности (модалка / страница).

Словарь снимков Design для открытой сущности (модалка / страница).

Access: authorized (10 ) · Scope: read

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

TypeScript (copy-paste)

GET /design/entity

<details open><summary><b>Params</b></summary>
export interface DesignEntityParams {
  entityID: string
}
</details> <details open><summary><b>Response</b></summary>
export type DesignEntityResponse = IServerResponse<DesignMap>

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

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

get/design/entity

Request

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

Query parameters

entityIDstring uuid required

Можно передать header entityID (сервер мержит 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<DesignMap>

codeinteger required
dataDesignMap required

Schema DesignMap (inferred from ResponseData AST)

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.