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

Request

GET

https://api.wiki.yandex.net/v1/grids/{idx}

Path parameters

Name	Description
idx*	Type: string<uuid4>

Query parameters

Name	Description
fields	Type: string Дополнительные поля, через запятую; см. описание формата ответа.
filter	Type: string Отфильтровать строки; Например `[slug] ~ wiki AND [slug2]<32`
only_cols	Type: string Вернуть только определенные колонки. Слаг через запятую
only_rows	Type: string Вернуть только определенные ряды. ID через запятую
revision	Type: integer Загрузить старую версию динамической таблицы
sort	Type: string Отсортировать строки по колонкам; Например `slug, -slug2, slug3`

Responses

200 OK

Body

application/json

{
    "created_at": "2022-12-29T18:02:01Z",
    "title": "string",
    "page": {
        "id": 0,
        "slug": "string"
    },
    "structure": {
        "default_sort": [
            {
                "slug": "string",
                "title": "string",
                "direction": "asc"
            }
        ],
        "columns": [
            {
                "id": "string",
                "slug": "string",
                "title": "string",
                "type": "string",
                "required": false,
                "width": 0,
                "width_units": "%",
                "pinned": "left",
                "color": "blue",
                "multiple": false,
                "format": "yfm",
                "ticket_field": "assignee",
                "select_options": [
                    "string"
                ],
                "mark_rows": false,
                "description": "string"
            }
        ]
    },
    "rich_text_format": "yfm",
    "rows": [
        {
            "id": "string",
            "row": [
                null
            ],
            "pinned": false,
            "color": "blue"
        }
    ],
    "revision": "string",
    "user_permissions": [
        "create_page"
    ],
    "attributes": {
        "created_at": "2022-12-29T18:02:01Z",
        "modified_at": "2022-12-29T18:02:01Z"
    },
    "template_id": 0
}

Name	Description
created_at*	Type: string<date-time>
id*	Type: any
page*	Type: PageIdentity
revision*	Type: string
rich_text_format*	Type: TextFormat An enumeration. Enum: `yfm`, `wom`, `plain`
rows*	Type: GridRowSchema[]
structure*	Type: GridStructureSchema
title*	Type: string
attributes	Type: GridAttributesSchema По умолчанию поле не возвращается Укажите `attributes` в списке `?fields=attributes, ...` для получения в ответе. Возвращает дополнительные атрибуты динамической таблицы.
template_id	Type: integer
user_permissions	Type: UserPermission[] По умолчанию поле не возвращается Укажите `user_permissions` в списке `?fields=user_permissions, ...` для получения в ответе. Возвращает права доступа страницы, которой принадлежит динамическая таблица. An enumeration. Enum: `create_page`, `delete`, `edit`, `view`, `comment`, `change_authors`, `change_acl`, `set_redirect`, `manage_invite`, `view_invite`, `admin`

PageIdentity

Name

Description

Type: integer

Обязателен id либо slug, при передаче обоих id имеет приоритет и slug игнорируется.

slug

Type: string

TextFormat

An enumeration.

Type	Description
TextFormat	Enum: `yfm`, `wom`, `plain`

GridRowSchema

Name	Description
id*	Type: string
row*	Type: any[]
color	Type: BGColor An enumeration. Enum: `blue`, `yellow`, `pink`, `red`, `green`, `mint`, `grey`, `orange`, `magenta`, `purple`, `copper`, `ocean`
pinned	Type: boolean

GridStructureSchema

Name	Description
columns*	Type: ColumnSchema[]
default_sort	Type: ColumnSortSchema[]

GridAttributesSchema

Name	Description
created_at*	Type: string<date-time>
modified_at*	Type: string<date-time>

UserPermission

An enumeration.

Type	Description
UserPermission	Enum: `create_page`, `delete`, `edit`, `view`, `comment`, `change_authors`, `change_acl`, `set_redirect`, `manage_invite`, `view_invite`, `admin`

BGColor

An enumeration.

Type	Description
BGColor	Enum: `blue`, `yellow`, `pink`, `red`, `green`, `mint`, `grey`, `orange`, `magenta`, `purple`, `copper`, `ocean`

ColumnSchema

Name	Description
required*	Type: boolean
slug*	Type: string
title*	Type: string
type*	Type: ColumnType An enumeration. Enum: `string`, `number`, `date`, `select`, `staff`, `checkbox`, `ticket`, `ticket_field`
color	Type: BGColor An enumeration. Enum: `blue`, `yellow`, `pink`, `red`, `green`, `mint`, `grey`, `orange`, `magenta`, `purple`, `copper`, `ocean`
description	Type: string Описание
format	Type: TextFormat Только для `text`; None — текст без форматирования. Enum: `yfm`, `wom`, `plain`
id	Type: string
mark_rows	Type: boolean Только для `checkbox`; Отмечает ряд как выполненный в интерфейсе
multiple	Type: boolean Только для `select` и `staff`; Включает множественный выбор.
pinned	Type: ColumnPinTypes An enumeration. Enum: `left`, `right`
select_options	Type: string[] Только для `select`; Задает варианты выбора
ticket_field	Type: TicketField Только для `ticket-field`; Enum: `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`
width	Type: integer
width_units	Type: WidthUnits An enumeration. Enum: `%`, `px`

ColumnSortSchema

Name	Description
direction*	Type: SortDirection An enumeration. Enum: `asc`, `desc`
slug*	Type: string
title*	Type: string

ColumnType

An enumeration.

Type	Description
ColumnType	Enum: `string`, `number`, `date`, `select`, `staff`, `checkbox`, `ticket`, `ticket_field`

ColumnPinTypes

An enumeration.

Type	Description
ColumnPinTypes	Enum: `left`, `right`

TicketField

An enumeration.

Type

Description

TicketField

Enum: 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

WidthUnits

An enumeration.

Type	Description
WidthUnits	Enum: `%`, `px`

SortDirection

An enumeration.

Type	Description
SortDirection	Enum: `asc`, `desc`

Was the article helpful?

Создать таблицу

Обновить таблицу