---
metadata:
  - name: generator
    content: Diplodoc Platform v5.64.2
alternate:
  - https://yandex.ru/support/wiki/en/api-ref/grids/grids__get_grid.md
  - https://yandex.ru/support/wiki/ru/api-ref/grids/grids__get_grid.md
  - href: https://yandex.ru/support/wiki/ru/api-ref/grids/grids__get_grid.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.ru/support/wiki/ru/llms.txt?revision=r21947862
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/wiki/ru/llms.txt?revision=r21947862

<div class="openapi">

# Получить таблицу

<!-- markdownlint-disable-file -->

Возвращает динамическую таблицу, ее структуру и строки.

Общие заголовки и способы аутентификации описаны в разделе [Доступ к API](https://yandex.ru/support/wiki/ru/api-ref/access.md#headers). Примеры сценариев приведены в разделе [Примеры использования API](https://yandex.ru/support/wiki/ru/api-ref/examples.md).

## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-get);margin-bottom: 12px">

<div class="openapi__request">

GET {.openapi__method}
```text translate=no
https://api.wiki.yandex.net/v1/grids/{idx}
```

</div>

</div>

</div>

### Path parameters

#|
|| **Name** | **Description** ||
||

_idx_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string&lt;uuid4&gt;

UUID динамической таблицы. Значение `idx` совпадает со значением поля `id` в ответе `POST /v1/grids` или поля `results[].id` в ответе `GET /v1/pages/{idx}/grids`. В `/v1/pages/{idx}/grids` параметр `idx` — числовой ID страницы.

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
|#{.json-schema-properties}

### Query parameters

#|
|| **Name** | **Description** ||
||

_fields_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Дополнительные поля, через запятую; см. описание формата ответа.

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
||

_filter_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Отфильтровать строки; Например `[slug] ~ wiki AND [slug2]<32`

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
||

_only_cols_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Вернуть только указанные столбцы. Слаги столбцов через запятую.

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
||

_only_rows_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Вернуть только указанные строки. ID строк через запятую.

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
||

_revision_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Загрузить старую версию динамической таблицы
{.table-cell}
||
||

_sort_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Отсортировать строки по колонкам; Например `slug, -slug2, slug3`

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
|#{.json-schema-properties}

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "id": "example",
  "created_at": "2025-01-01T00:00:00Z",
  "title": "example",
  "page": {
    "id": 0,
    "slug": "example"
  },
  "structure": {
    "default_sort": [
      {
        "slug": "example",
        "title": "example",
        "direction": null
      }
    ],
    "columns": [
      {
        "id": "example",
        "slug": "example",
        "title": "example",
        "type": null,
        "required": true,
        "width": 0,
        "width_units": null,
        "pinned": null,
        "color": null,
        "multiple": true,
        "format": null,
        "ticket_field": null,
        "select_options": [
          null
        ],
        "mark_rows": true,
        "description": "example"
      }
    ]
  },
  "rich_text_format": "yfm",
  "rows": [
    {
      "id": "example",
      "row": [
        0
      ],
      "pinned": true,
      "color": "blue"
    }
  ],
  "revision": "example",
  "user_permissions": [
    "create_page"
  ],
  "attributes": {
    "created_at": "2025-01-01T00:00:00Z",
    "modified_at": "2025-01-01T00:00:00Z"
  },
  "template_id": 0
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_created_at_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string&lt;date-time&gt;

Дата и время создания таблицы

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: string&lt;uuid4&gt;

  _Example:_{.json-schema-reset .json-schema-example} `example`

- **Type**: integer

{% endcut %}

Идентификатор динамической таблицы. В методах `/v1/grids/{idx}` значение `idx` равно UUID из этого поля.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_page_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **PageIdentity**

  **Type**: [PageIdentity](#entity-PageIdentity)

  Идентификатор страницы

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "id": 0,
    "slug": "example"
  }
  ```

  {% endcut %}

{% endcut %}

Страница, к которой привязана таблица

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": 0,
  "slug": "example"
}
```

{% endcut %}
{.table-cell}
||
||

_revision_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Версия таблицы. Передавайте это значение в поле `revision` тела запросов изменения таблицы.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_rich_text_format_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **TextFormat**

  **Type**: [TextFormat](#entity-TextFormat)

  Формат текста:
  - `yfm` — Yandex Flavored Markdown
  - `wom` — Wiki Old Markup (старая разметка)
  - `plain` — простой текст

  _Enum:_{.json-schema-reset .json-schema-value} `yfm`, `wom`, `plain`

{% endcut %}

Формат текста в таблице

_Example:_{.json-schema-reset .json-schema-example} `yfm`
{.table-cell}
||
||

_rows_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [GridRowSchema](#entity-GridRowSchema)[]

Строки таблицы

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "id": "example",
    "row": [
      0
    ],
    "pinned": true,
    "color": "blue"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_structure_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **GridStructureSchema**

  **Type**: [GridStructureSchema](#entity-GridStructureSchema)

  Структура динамической таблицы

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "default_sort": [
      {
        "slug": "example",
        "title": "example",
        "direction": "asc"
      }
    ],
    "columns": [
      {
        "id": "example",
        "slug": "example",
        "title": "example",
        "type": "string",
        "required": true,
        "width": 0,
        "width_units": "%",
        "pinned": "left",
        "color": "blue",
        "multiple": true,
        "format": "yfm",
        "ticket_field": "assignee",
        "select_options": [
          "example"
        ],
        "mark_rows": true,
        "description": "example"
      }
    ]
  }
  ```

  {% endcut %}

{% endcut %}

Структура таблицы (столбцы, типы данных)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "default_sort": [
    {
      "slug": "example",
      "title": "example",
      "direction": "asc"
    }
  ],
  "columns": [
    {
      "id": "example",
      "slug": "example",
      "title": "example",
      "type": "string",
      "required": true,
      "width": 0,
      "width_units": "%",
      "pinned": "left",
      "color": "blue",
      "multiple": true,
      "format": "yfm",
      "ticket_field": "assignee",
      "select_options": [
        "example"
      ],
      "mark_rows": true,
      "description": "example"
    }
  ]
}
```

{% endcut %}
{.table-cell}
||
||

_title_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Название таблицы

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_attributes_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **GridAttributesSchema**

  **Type**: [GridAttributesSchema](#entity-GridAttributesSchema)

  Атрибуты динамической таблицы (метаданные)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "created_at": "2025-01-01T00:00:00Z",
    "modified_at": "2025-01-01T00:00:00Z"
  }
  ```

  {% endcut %}

{% endcut %}

**По умолчанию поле не возвращается**

Укажите `attributes` в списке `?fields=attributes, ...` для получения в ответе.

Возвращает дополнительные атрибуты динамической таблицы.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "created_at": "2025-01-01T00:00:00Z",
  "modified_at": "2025-01-01T00:00:00Z"
}
```

{% endcut %}
{.table-cell}
||
||

_template_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Идентификатор шаблона, к которому относится таблица.
{.table-cell}
||
||

_user_permissions_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [UserPermission](#entity-UserPermission)[]

**По умолчанию поле не возвращается**

Укажите `user_permissions` в списке `?fields=user_permissions, ...` для получения в ответе.

Возвращает права доступа страницы, которой принадлежит динамическая таблица.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "create_page"
]
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### PageIdentity {#entity-PageIdentity}

Идентификатор страницы

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

ID страницы. Обязателен `id` либо `slug`, при передаче обоих `id` имеет приоритет и `slug` игнорируется. В методах `/v1/pages/{idx}` значение `idx` равно значению этого поля.
{.table-cell}
||
||

_slug_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Адрес страницы относительно корня Вики, например `team/project`. Обязателен `id` либо `slug`

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": 0,
  "slug": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### SortDirection {#entity-SortDirection}

Направление сортировки:
- `asc` — по возрастанию (от меньшего к большему, от A до Z)
- `desc` — по убыванию (от большего к меньшему, от Z до A)

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `asc`, `desc`

</div>

<div class="openapi-entity">

### ColumnSortSchema {#entity-ColumnSortSchema}

Схема сортировки столбца в динамической таблице

#|
|| **Name** | **Description** ||
||

_direction_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **SortDirection**

  **Type**: [SortDirection](#entity-SortDirection)

  Направление сортировки:
  - `asc` — по возрастанию (от меньшего к большему, от A до Z)
  - `desc` — по убыванию (от большего к меньшему, от Z до A)

  _Enum:_{.json-schema-reset .json-schema-value} `asc`, `desc`

{% endcut %}

Направление сортировки

_Example:_{.json-schema-reset .json-schema-example} `asc`
{.table-cell}
||
||

_slug_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Уникальный текстовый идентификатор столбца

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_title_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Название столбца

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "slug": "example",
  "title": "example",
  "direction": "asc"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### ColumnType {#entity-ColumnType}

Тип данных столбца динамической таблицы.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `string`, `number`, `date`, `select`, `staff`, `checkbox`, `ticket`, `ticket_field`

</div>

<div class="openapi-entity">

### WidthUnits {#entity-WidthUnits}

Единицы измерения ширины столбца.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `%`, `px`

</div>

<div class="openapi-entity">

### ColumnPinTypes {#entity-ColumnPinTypes}

Сторона, с которой закреплен столбец.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `left`, `right`

</div>

<div class="openapi-entity">

### BGColor {#entity-BGColor}

Цвет фона строки или столбца.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `blue`, `yellow`, `pink`, `red`, `green`, `mint`, `grey`, `orange`, `magenta`, `purple`, `copper`, `ocean`

</div>

<div class="openapi-entity">

### TextFormat {#entity-TextFormat}

Формат текста:
- `yfm` — Yandex Flavored Markdown
- `wom` — Wiki Old Markup (старая разметка)
- `plain` — простой текст

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `yfm`, `wom`, `plain`

</div>

<div class="openapi-entity">

### TicketField {#entity-TicketField}

Поле задачи Яндекс Трекера, значение которого отображается в столбце.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `assignee`, `components`, `created_at`, `deadline`, `description`, `end`, `estimation`, `fixversions`, `followers`, `last_comment_updated_at`, `original_estimation`, `parent`, `pending_reply_from`, `priority`, `project`, `queue`, `reporter`, `resolution`, `resolved_at`, `sprint`, `start`, `status`, `status_start_time`, `status_type`, `storypoints`, `subject`, `tags`, `type`, `updated_at`, `votes`

</div>

<div class="openapi-entity">

### ColumnSchema {#entity-ColumnSchema}

Схема столбца динамической таблицы

#|
|| **Name** | **Description** ||
||

_required_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Обязательность заполнения столбца
{.table-cell}
||
||

_slug_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Уникальный текстовый идентификатор столбца (используется в формулах и API)

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_title_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Название столбца (отображается в интерфейсе)

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_type_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **ColumnType**

  **Type**: [ColumnType](#entity-ColumnType)

  Тип данных столбца динамической таблицы.

  _Enum:_{.json-schema-reset .json-schema-value} `string`, `number`, `date`, `select`, `staff`, `checkbox`, `ticket`, `ticket_field`

{% endcut %}

Тип данных столбца

_Example:_{.json-schema-reset .json-schema-example} `string`
{.table-cell}
||
||

_color_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **BGColor**

  **Type**: [BGColor](#entity-BGColor)

  Цвет фона строки или столбца.

  _Enum:_{.json-schema-reset .json-schema-value} `blue`, `yellow`, `pink`, `red`, `green`, `mint`, `grey`, `orange`, `magenta`, `purple`, `copper`, `ocean`

{% endcut %}

Цвет фона столбца

_Example:_{.json-schema-reset .json-schema-example} `blue`
{.table-cell}
||
||

_description_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Описание столбца

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_format_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **TextFormat**

  **Type**: [TextFormat](#entity-TextFormat)

  Формат текста:
  - `yfm` — Yandex Flavored Markdown
  - `wom` — Wiki Old Markup (старая разметка)
  - `plain` — простой текст

  _Enum:_{.json-schema-reset .json-schema-value} `yfm`, `wom`, `plain`

{% endcut %}

Только для `string`. Формат текста.

_Example:_{.json-schema-reset .json-schema-example} `yfm`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Уникальный идентификатор столбца

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_mark_rows_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Только для `checkbox`. Отмечает строку как выполненную в интерфейсе.
{.table-cell}
||
||

_multiple_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Только для `select` и `staff`. Включает множественный выбор.
{.table-cell}
||
||

_pinned_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **ColumnPinTypes**

  **Type**: [ColumnPinTypes](#entity-ColumnPinTypes)

  Сторона, с которой закреплен столбец.

  _Enum:_{.json-schema-reset .json-schema-value} `left`, `right`

{% endcut %}

Закрепление столбца (слева, справа или без закрепления)

_Example:_{.json-schema-reset .json-schema-example} `left`
{.table-cell}
||
||

_select_options_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[]

Только для `select`. Задает варианты выбора.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "example"
]
```

{% endcut %}
{.table-cell}
||
||

_ticket_field_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **TicketField**

  **Type**: [TicketField](#entity-TicketField)

  Поле задачи Яндекс Трекера, значение которого отображается в столбце.

  _Enum:_{.json-schema-reset .json-schema-value} `assignee`, `components`, `created_at`, `deadline`, `description`, `end`, `estimation`, `fixversions`, `followers`, `last_comment_updated_at`, `original_estimation`, `parent`, `pending_reply_from`, `priority`, `project`, `queue`, `reporter`, `resolution`, `resolved_at`, `sprint`, `start`, `status`, `status_start_time`, `status_type`, `storypoints`, `subject`, `tags`, `type`, `updated_at`, `votes`

{% endcut %}

Только для `ticket_field`. Поле задачи из Яндекс Трекера.

_Example:_{.json-schema-reset .json-schema-example} `assignee`
{.table-cell}
||
||

_width_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Ширина столбца
{.table-cell}
||
||

_width_units_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **WidthUnits**

  **Type**: [WidthUnits](#entity-WidthUnits)

  Единицы измерения ширины столбца.

  _Enum:_{.json-schema-reset .json-schema-value} `%`, `px`

{% endcut %}

Единицы измерения ширины столбца

_Example:_{.json-schema-reset .json-schema-example} `%`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "slug": "example",
  "title": "example",
  "type": "string",
  "required": true,
  "width": 0,
  "width_units": "%",
  "pinned": "left",
  "color": "blue",
  "multiple": true,
  "format": "yfm",
  "ticket_field": "assignee",
  "select_options": [
    "example"
  ],
  "mark_rows": true,
  "description": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### GridStructureSchema {#entity-GridStructureSchema}

Структура динамической таблицы

#|
|| **Name** | **Description** ||
||

_columns_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [ColumnSchema](#entity-ColumnSchema)[]

Столбцы таблицы

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "id": "example",
    "slug": "example",
    "title": "example",
    "type": "string",
    "required": true,
    "width": 0,
    "width_units": "%",
    "pinned": "left",
    "color": "blue",
    "multiple": true,
    "format": "yfm",
    "ticket_field": "assignee",
    "select_options": [
      "example"
    ],
    "mark_rows": true,
    "description": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_default_sort_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [ColumnSortSchema](#entity-ColumnSortSchema)[]

Сортировка по умолчанию

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "slug": "example",
    "title": "example",
    "direction": "asc"
  }
]
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "default_sort": [
    {
      "slug": "example",
      "title": "example",
      "direction": "asc"
    }
  ],
  "columns": [
    {
      "id": "example",
      "slug": "example",
      "title": "example",
      "type": "string",
      "required": true,
      "width": 0,
      "width_units": "%",
      "pinned": "left",
      "color": "blue",
      "multiple": true,
      "format": "yfm",
      "ticket_field": "assignee",
      "select_options": [
        "example"
      ],
      "mark_rows": true,
      "description": "example"
    }
  ]
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### TicketSchema {#entity-TicketSchema}

Схема задачи из Яндекс Трекера

#|
|| **Name** | **Description** ||
||

_key_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Ключ задачи (например, `WIKI-123`)

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_resolved_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Задача решена (закрыта).
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "key": "example",
  "resolved": true
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### UserIdentity {#entity-UserIdentity}

Идентификатор пользователя

#|
|| **Name** | **Description** ||
||

_cloud_uid_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Идентификатор пользователя в облаке

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_uid_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Идентификатор пользователя в Яндексе

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "uid": "example",
  "cloud_uid": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### UserSchema {#entity-UserSchema}

Информация о пользователе

#|
|| **Name** | **Description** ||
||

_affiliation_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Принадлежность пользователя

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_display_name_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Отображаемое имя пользователя

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Внутренний идентификатор пользователя
{.table-cell}
||
||

_is_dismissed_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Пользователь уволен
{.table-cell}
||
||

_username_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Логин пользователя

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_identity_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **UserIdentity**

  **Type**: [UserIdentity](#entity-UserIdentity)

  Идентификатор пользователя

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "uid": "example",
    "cloud_uid": "example"
  }
  ```

  {% endcut %}

{% endcut %}

Идентификатор пользователя в системе

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "uid": "example",
  "cloud_uid": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": 0,
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "username": "example",
  "display_name": "example",
  "is_dismissed": true,
  "affiliation": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### UnresolvedUserSchema {#entity-UnresolvedUserSchema}

Схема пользователя, который не был найден в системе

#|
|| **Name** | **Description** ||
||

_identity_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **UserIdentity**

  **Type**: [UserIdentity](#entity-UserIdentity)

  Идентификатор пользователя

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "uid": "example",
    "cloud_uid": "example"
  }
  ```

  {% endcut %}

{% endcut %}

Идентификатор пользователя

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "uid": "example",
  "cloud_uid": "example"
}
```

{% endcut %}
{.table-cell}
||
||

_username_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Логин пользователя

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "username": "example",
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  }
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### TrackerEnumField {#entity-TrackerEnumField}

Поле перечисления из Яндекс Трекера

#|
|| **Name** | **Description** ||
||

_display_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Отображаемое значение поля

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_key_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Ключ значения поля

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "display": "example",
  "key": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### GridRowSchema {#entity-GridRowSchema}

Схема строки динамической таблицы

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Уникальный идентификатор строки

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_row_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**Type**: array" %}

{% cut "**Any of 10 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: integer

- **Type**: number

- **Type**: boolean

- **Type**: string

  _Example:_{.json-schema-reset .json-schema-example} `example`

- **TicketSchema**

  **Type**: [TicketSchema](#entity-TicketSchema)

  Схема задачи из Яндекс Трекера

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "key": "example",
    "resolved": true
  }
  ```

  {% endcut %}

- **Type**: string[]

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  [
    "example"
  ]
  ```

  {% endcut %}

- {% cut "**Type**: array" %}

  {% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

  - **UserSchema**

    **Type**: [UserSchema](#entity-UserSchema)

    Информация о пользователе

    {% cut "**Example**" %}{.json-schema-example}

    ```json translate=no
    {
      "id": 0,
      "identity": {
        "uid": "example",
        "cloud_uid": "example"
      },
      "username": "example",
      "display_name": "example",
      "is_dismissed": true,
      "affiliation": "example"
    }
    ```

    {% endcut %}

  - **UnresolvedUserSchema**

    **Type**: [UnresolvedUserSchema](#entity-UnresolvedUserSchema)

    Схема пользователя, который не был найден в системе

    {% cut "**Example**" %}{.json-schema-example}

    ```json translate=no
    {
      "username": "example",
      "identity": {
        "uid": "example",
        "cloud_uid": "example"
      }
    }
    ```

    {% endcut %}

  {% endcut %}

  {% endcut %}

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  [
    {
      "id": 0,
      "identity": {
        "uid": "example",
        "cloud_uid": "example"
      },
      "username": "example",
      "display_name": "example",
      "is_dismissed": true,
      "affiliation": "example"
    }
  ]
  ```

  {% endcut %}

- **UserSchema**

  **Type**: [UserSchema](#entity-UserSchema)

  Информация о пользователе

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "id": 0,
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    },
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  }
  ```

  {% endcut %}

- **UnresolvedUserSchema**

  **Type**: [UnresolvedUserSchema](#entity-UnresolvedUserSchema)

  Схема пользователя, который не был найден в системе

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "username": "example",
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    }
  }
  ```

  {% endcut %}

- **TrackerEnumField**

  **Type**: [TrackerEnumField](#entity-TrackerEnumField)

  Поле перечисления из Яндекс Трекера

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "display": "example",
    "key": "example"
  }
  ```

  {% endcut %}

{% endcut %}

{% endcut %}

Значения ячеек строки. При получении таблицы порядок соответствует порядку столбцов. При добавлении строк возвращаются только переданные значения в порядке ключей объекта запроса.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  0
]
```

{% endcut %}
{.table-cell}
||
||

_color_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **BGColor**

  **Type**: [BGColor](#entity-BGColor)

  Цвет фона строки или столбца.

  _Enum:_{.json-schema-reset .json-schema-value} `blue`, `yellow`, `pink`, `red`, `green`, `mint`, `grey`, `orange`, `magenta`, `purple`, `copper`, `ocean`

{% endcut %}

Цвет фона строки

_Example:_{.json-schema-reset .json-schema-example} `blue`
{.table-cell}
||
||

_pinned_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Строка закреплена
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "row": [
    0
  ],
  "pinned": true,
  "color": "blue"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### UserPermission {#entity-UserPermission}

Права доступа пользователя к странице:
- `create_page` — создание подстраниц
- `delete` — удаление страницы
- `edit` — редактирование страницы
- `view` — просмотр страницы
- `comment` — комментирование
- `change_authors` — изменение авторов
- `change_acl` — изменение списка доступа
- `set_redirect` — установка редиректа
- `manage_invite` — управление приглашениями
- `view_invite` — просмотр приглашений
- `admin` — административные права

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `create_page`, `delete`, `edit`, `view`, `comment`, `change_authors`, `change_acl`, `set_redirect`, `manage_invite`, `view_invite`, `admin`

</div>

<div class="openapi-entity">

### GridAttributesSchema {#entity-GridAttributesSchema}

Атрибуты динамической таблицы (метаданные)

#|
|| **Name** | **Description** ||
||

_created_at_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string&lt;date-time&gt;

Дата и время создания таблицы

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

_modified_at_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string&lt;date-time&gt;

Дата и время последнего изменения таблицы

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "created_at": "2025-01-01T00:00:00Z",
  "modified_at": "2025-01-01T00:00:00Z"
}
```

{% endcut %}

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.