Create Grid

Create a new dynamic table as a page resource.

For common headers and authentication methods, see Access to the API. For sample scenarios, see API usage examples.

Request

POST

https://api.wiki.yandex.net/v1/grids

Body

application/json

{
  "title": "example",
  "page": {
    "id": 0,
    "slug": "example"
  }
}

Name

Description

page

All of 1 type

PageIdentity

Type: PageIdentity

Page identifier
Example
```
{
  "id": 0,
  "slug": "example"
}
```

The page to attach the table to. Specify the ID or slug of an existing page.

Example

{
  "id": 0,
  "slug": "example"
}

title

Type: string

New table title.

Min length: 1

Max length: 255

Example: example

PageIdentity

Page identifier

Name

Description

Type: integer

Page ID. Either id or slug is required. If both are provided, id takes precedence and slug is ignored. In /v1/pages/{idx} methods, the value of idx is the value of this field.

slug

Type: string

Page address relative to the Wiki root, such as team/project. Either id or slug is required.

Example: example

Example

{
  "id": 0,
  "slug": "example"
}

Responses

200 OK

Body

application/json

{
  "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
}

Name	Description
created_at	Type: string<date-time> Date and time the table was created Example: `2025-01-01T00:00:00Z`
id	Any of 2 types Type: string<uuid4> Example: `example` Type: integer Dynamic table ID. In `/v1/grids/{idx}` methods, the value of `idx` is the UUID from this field. Example: `example`
page	All of 1 type PageIdentity Type: PageIdentity Page identifier Example `{ "id": 0, "slug": "example" }` The page the table is attached to Example `{ "id": 0, "slug": "example" }`
revision	Type: string Table version. Pass this value in the `revision` field in the body of requests that modify the table. Example: `example`
rich_text_format	All of 1 type TextFormat Type: TextFormat Text format: `yfm`: Yandex Flavored Markdown. `wom`: Wiki Old Markup (legacy markup). `plain`: Plain text. Enum: `yfm`, `wom`, `plain` Text format in the table Example: `yfm`
rows	Type: GridRowSchema[] Table rows Example `[ { "id": "example", "row": [ 0 ], "pinned": true, "color": "blue" } ]`
structure	All of 1 type GridStructureSchema Type: GridStructureSchema Grid structure Example `{ "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" } ] }` The table structure (columns and data types) Example `{ "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" } ] }`
title	Type: string Table title Example: `example`
attributes	All of 1 type GridAttributesSchema Type: GridAttributesSchema Dynamic table attributes (metadata) Example `{ "created_at": "2025-01-01T00:00:00Z", "modified_at": "2025-01-01T00:00:00Z" }` This field is not returned by default Include `attributes` in `?fields=attributes, ...` to return it in the response. Returns additional attributes of the dynamic table. Example `{ "created_at": "2025-01-01T00:00:00Z", "modified_at": "2025-01-01T00:00:00Z" }`
template_id	Type: integer ID of the template that the table belongs to.
user_permissions	Type: UserPermission[] This field is not returned by default Include `user_permissions` in the `?fields=user_permissions, ...` list to return it in the response. Returns access permissions for the page that owns the dynamic table. Example `[ "create_page" ]`

SortDirection

Sort direction:

asc: Ascending (smallest to largest, A to Z).
desc: Descending (largest to smallest, Z to A).

Type: string

Enum: asc, desc

ColumnSortSchema

Sort schema for a grid column

Name	Description
direction	All of 1 type SortDirection Type: SortDirection Sort direction: `asc`: Ascending (smallest to largest, A to Z). `desc`: Descending (largest to smallest, Z to A). Enum: `asc`, `desc` Sort direction Example: `asc`
slug	Type: string Unique text ID of the column Example: `example`
title	Type: string Column title Example: `example`

Example

{
  "slug": "example",
  "title": "example",
  "direction": "asc"
}

ColumnType

Data type of a dynamic table column.

Type: string

Enum: string, number, date, select, staff, checkbox, ticket, ticket_field

WidthUnits

Column width units.

Type: string

Enum: %, px

ColumnPinTypes

Side where the column is pinned.

Type: string

Enum: left, right

BGColor

Background color of a row or column.

Type: string

Enum: blue, yellow, pink, red, green, mint, grey, orange, magenta, purple, copper, ocean

TextFormat

Text format:

yfm: Yandex Flavored Markdown.
wom: Wiki Old Markup (legacy markup).
plain: Plain text.

Type: string

Enum: yfm, wom, plain

TicketField

A Tracker issue field whose value is displayed in the column.

Type: string

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

ColumnSchema

Grid column schema

Name	Description
required	Type: boolean Whether the column must be filled in
slug	Type: string Unique text ID of the column (used in formulas and the API) Example: `example`
title	Type: string Column title (shown in the interface) Example: `example`
type	All of 1 type ColumnType Type: ColumnType Data type of a dynamic table column. Enum: `string`, `number`, `date`, `select`, `staff`, `checkbox`, `ticket`, `ticket_field` Column data type Example: `string`
color	All of 1 type BGColor Type: BGColor Background color of a row or column. Enum: `blue`, `yellow`, `pink`, `red`, `green`, `mint`, `grey`, `orange`, `magenta`, `purple`, `copper`, `ocean` Column background color Example: `blue`
description	Type: string Column description Example: `example`
format	All of 1 type TextFormat Type: TextFormat Text format: `yfm`: Yandex Flavored Markdown. `wom`: Wiki Old Markup (legacy markup). `plain`: Plain text. Enum: `yfm`, `wom`, `plain` Only for `string`. The text format. Example: `yfm`
id	Type: string Unique column ID Example: `example`
mark_rows	Type: boolean Only for `checkbox`. Marks the row as completed in the interface.
multiple	Type: boolean Only for `select` and `staff`. Enables multiple selection.
pinned	All of 1 type ColumnPinTypes Type: ColumnPinTypes Side where the column is pinned. Enum: `left`, `right` Column pin state (left, right, or not pinned) Example: `left`
select_options	Type: string[] Only for `select`. Defines the available options. Example `[ "example" ]`
ticket_field	All of 1 type TicketField Type: TicketField A Tracker issue field whose value is displayed in the column. 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` Only for `ticket_field`. A field of an issue in Yandex Tracker. Example: `assignee`
width	Type: integer Column width
width_units	All of 1 type WidthUnits Type: WidthUnits Column width units. Enum: `%`, `px` Column width units Example: `%`

Example

{
  "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"
}

GridStructureSchema

Grid structure

Name

Description

columns

Type: ColumnSchema[]

Table columns

Example

[
  {
    "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"
  }
]

default_sort

Type: ColumnSortSchema[]

Default sort order

Example

[
  {
    "slug": "example",
    "title": "example",
    "direction": "asc"
  }
]

Example

{
  "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"
    }
  ]
}

TicketSchema

Yandex Tracker issue schema

Name

Description

key

Type: string

Issue key (for example, WIKI-123)

Example: example

resolved

Type: boolean

The issue is resolved (closed).

Example

{
  "key": "example",
  "resolved": true
}

UserIdentity

User identifier

Name

Description

cloud_uid

Type: string

User identifier in the cloud

Example: example

uid

Type: string

Yandex user ID

Example: example

Example

{
  "uid": "example",
  "cloud_uid": "example"
}

UserSchema

User information

Name	Description
affiliation	Type: string User affiliation Example: `example`
display_name	Type: string User display name Example: `example`
id	Type: integer Internal user identifier
is_dismissed	Type: boolean The user is dismissed
username	Type: string User login Example: `example`
identity	All of 1 type UserIdentity Type: UserIdentity User identifier Example `{ "uid": "example", "cloud_uid": "example" }` User identifier in the system Example `{ "uid": "example", "cloud_uid": "example" }`

Example

{
  "id": 0,
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "username": "example",
  "display_name": "example",
  "is_dismissed": true,
  "affiliation": "example"
}

UnresolvedUserSchema

Schema for a user that was not found in the system

Name

Description

identity

All of 1 type

UserIdentity

Type: UserIdentity

User identifier

Example

{
  "uid": "example",
  "cloud_uid": "example"
}

User ID

Example

{
  "uid": "example",
  "cloud_uid": "example"
}

username

Type: string

User login

Example: example

Example

{
  "username": "example",
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  }
}

TrackerEnumField

Enum field from Yandex Tracker

Name

Description

display

Type: string

Displayed value of the field

Example: example

key

Type: string

Field value key

Example: example

Example

{
  "display": "example",
  "key": "example"
}

GridRowSchema

Dynamic table row schema

Name	Description
id	Type: string Unique row identifier Example: `example`
row	Type: array Any of 10 types Type: integer Type: number Type: boolean Type: string Example: `example` TicketSchema Type: TicketSchema Yandex Tracker issue schema Example `{ "key": "example", "resolved": true }` Type: string[] Example `[ "example" ]` Type: array Any of 2 types UserSchema Type: UserSchema User information Example `{ "id": 0, "identity": { "uid": "example", "cloud_uid": "example" }, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }` UnresolvedUserSchema Type: UnresolvedUserSchema Schema for a user that was not found in the system Example `{ "username": "example", "identity": { "uid": "example", "cloud_uid": "example" } }` Example `[ { "id": 0, "identity": { "uid": "example", "cloud_uid": "example" }, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" } ]` UserSchema Type: UserSchema User information Example `{ "id": 0, "identity": { "uid": "example", "cloud_uid": "example" }, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }` UnresolvedUserSchema Type: UnresolvedUserSchema Schema for a user that was not found in the system Example `{ "username": "example", "identity": { "uid": "example", "cloud_uid": "example" } }` TrackerEnumField Type: TrackerEnumField Enum field from Yandex Tracker Example `{ "display": "example", "key": "example" }` Row cell values. When retrieving a table, their order matches the column order. When adding rows, only the provided values are returned, in the order of the keys in the request object. Example `[ 0 ]`
color	All of 1 type BGColor Type: BGColor Background color of a row or column. Enum: `blue`, `yellow`, `pink`, `red`, `green`, `mint`, `grey`, `orange`, `magenta`, `purple`, `copper`, `ocean` Row background color Example: `blue`
pinned	Type: boolean The row is pinned

Example

{
  "id": "example",
  "row": [
    0
  ],
  "pinned": true,
  "color": "blue"
}

UserPermission

User access permissions for the page:

create_page: Create subpages.
delete: Delete the page.
edit: Edit the page.
view: View the page.
comment: Add comments.
change_authors: Change authors.
change_acl: Change the access list.
set_redirect: Set a redirect.
manage_invite: Manage invitations.
view_invite: View invitations.
admin: Administrative permissions.

Type: string

Enum: create_page, delete, edit, view, comment, change_authors, change_acl, set_redirect, manage_invite, view_invite, admin

GridAttributesSchema

Dynamic table attributes (metadata)

Name

Description

created_at

Type: string<date-time>

Date and time the table was created

Example: 2025-01-01T00:00:00Z

modified_at

Type: string<date-time>

Date and time the table was last modified

Example: 2025-01-01T00:00:00Z

Example

{
  "created_at": "2025-01-01T00:00:00Z",
  "modified_at": "2025-01-01T00:00:00Z"
}

Was the article helpful?

Overview

Get Grid