States

🔒 Получение ленты логов активности пользователей и сущностей.

Получение ленты логов активности пользователей и сущностей.

Access: authorized (10 ) · Scope: read

Allows: user:activity (все обязательны; проверка в команде по ресурсу из запроса)

TypeScript (copy-paste)

GET /states/activity

<details open><summary><b>Params</b></summary>
export interface StatesActivityParams {
  nextCursor?: string | null
  author?: string | null
  userID?: string | null
  resID?: string | null
  resTypeGroup?: states_activity_resTypeGroup | null
  dtRange?: states_activity_dtRange | null
  startDt?: string | null
  finishDt?: string | null
}
</details> <details open><summary><b>Response</b></summary>
export type StatesActivityResponse = IServerResponse<Resp_states_activity>

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

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

get/states/activity

Request

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

Query parameters

nextCursorstring nullable

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

authorstring nullable

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

userIDstring uuid nullable

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

resIDstring uuid nullable

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

resTypeGroup'project' | 'product' | 'version' | 'feature' | 'task' | 'bug' | 'meeting' | 'chat' | 'profile' | 'administration' | 'worklog'

project = "project", product = "product", version = "version", feature = "feature", task = "task", bug = "bug", meeting = "meeting", chat = "chat", profile = "profile", administration = "administration", worklog = "worklog"

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

dtRange'24h' | 'iteration' | 'month' | 'range'

24h = "24h", iteration = "iteration", month = "month", range = "range"

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

startDtstring date-time nullable

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

finishDtstring date-time nullable

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

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.