Relations

🔒 Получение списка связей для задачи, баги или митинга.

Получение списка связей для задачи, баги или митинга.

Access: authorized (10 ) · Scope: read

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

TypeScript (copy-paste)

GET /relation/list

<details open><summary><b>Params</b></summary>
export interface RelationListParams {
  refID: string
  refType: relation_list_refType
}
</details> <details open><summary><b>Response</b></summary>
export type RelationListResponse = IServerResponse<EntityRelationsData>

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

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

get/relation/list

Request

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

Query parameters

refIDstring uuid required

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

refType'task' | 'bug' | 'meeting' required

task = "task", bug = "bug", meeting = "meeting"

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

codeinteger required
dataEntityRelationsData required

Schema EntityRelationsData (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.