Добавить строки

Перед добавлением строк создайте столбцы методом POST /v1/grids/{idx}/columns.

В rows передайте массив объектов. Каждый объект задает одну строку: ключ — slug существующего столбца, значение — содержимое ячейки. Тип значения должен соответствовать типу столбца.

Например, для столбцов id (number) и name (string) передайте следующее тело запроса:

{
  "rows": [
    {
      "id": 1,
      "name": "One"
    },
    {
      "id": 2,
      "name": "Two"
    }
  ]
}

Общие заголовки и способы аутентификации описаны в разделе Доступ к API. Примеры сценариев приведены в разделе Примеры использования API.

Request

POST

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

Path parameters

Name

Description

idx

Type: string<uuid4>

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

Example: ``

Body

application/json

{
  "revision": "example",
  "position": 0,
  "after_row_id": "example",
  "rows": [
    {}
  ]
}

Name

Description

rows

Type: object[]

[additional]

Any of 6 types

Type: integer
Type: number
Type: boolean
Type: string

Example: example
Type: string[]
Example
```
[
  "example"
]
```

Type: UserIdentityExtended[]

Example

[
  {
    "uid": "example",
    "cloud_uid": "example",
    "username": "example"
  }
]

Example: 0

Добавляемые строки. Каждая строка — объект, в котором ключи — слаги существующих столбцов, значения — данные ячеек. Пустой объект создает пустую строку; в непустой строке должны быть заполнены обязательные столбцы.

Example

[
  {}
]

after_row_id

Type: string

Идентификатор строки, после которой нужно разместить строки. Имеет приоритет над position.

Example: example

position

Type: integer

Позиция вставки, считая с нуля. Используется, если не указан after_row_id. Если оба поля не переданы, строки помещаются в конец таблицы.

revision

Type: string

Базовая версия таблицы, на основе которой подготовлены изменения.

Example: example

UserIdentityExtended

Расширенный идентификатор пользователя с дополнительными полями

Name	Description
cloud_uid	Type: string Идентификатор пользователя в Яндекс Облаке Example: `example`
uid	Type: string Идентификатор пользователя в Яндексе Example: `example`
username	Type: string Логин пользователя Example: `example`

Example

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

Responses

200 OK

Body

application/json

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

Name

Description

revision

Type: string

Версия таблицы после выполнения операции.

Example: example

results

Type: GridRowSchema[]

Добавленные строки с присвоенными им идентификаторами.

Example

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

TicketSchema

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

Name

Description

key

Type: string

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

Example: example

resolved

Type: boolean

Задача решена (закрыта).

Example

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

UserIdentity

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

Name

Description

cloud_uid

Type: string

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

Example: example

uid

Type: string

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

Example: example

Example

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

UserSchema

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

Name	Description
affiliation	Type: string Принадлежность пользователя Example: `example`
display_name	Type: string Отображаемое имя пользователя Example: `example`
id	Type: integer Внутренний идентификатор пользователя
is_dismissed	Type: boolean Пользователь уволен
username	Type: string Логин пользователя Example: `example`
identity	All of 1 type UserIdentity Type: UserIdentity Идентификатор пользователя Example `{ "uid": "example", "cloud_uid": "example" }` Идентификатор пользователя в системе 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

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

Name

Description

identity

All of 1 type

UserIdentity

Type: UserIdentity

Идентификатор пользователя
Example
```
{
  "uid": "example",
  "cloud_uid": "example"
}
```

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

Example

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

username

Type: string

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

Example: example

Example

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

TrackerEnumField

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

Name

Description

display

Type: string

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

Example: example

key

Type: string

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

Example: example

Example

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

BGColor

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

Type: string

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

GridRowSchema

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

Name	Description
id	Type: string Уникальный идентификатор строки Example: `example`
row	Type: array Any of 10 types Type: integer Type: number Type: boolean Type: string Example: `example` TicketSchema Type: TicketSchema Схема задачи из Яндекс Трекера Example `{ "key": "example", "resolved": true }` Type: string[] Example `[ "example" ]` Type: array Any of 2 types UserSchema Type: UserSchema Информация о пользователе Example `{ "id": 0, "identity": { "uid": "example", "cloud_uid": "example" }, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }` UnresolvedUserSchema Type: UnresolvedUserSchema Схема пользователя, который не был найден в системе 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 Информация о пользователе Example `{ "id": 0, "identity": { "uid": "example", "cloud_uid": "example" }, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }` UnresolvedUserSchema Type: UnresolvedUserSchema Схема пользователя, который не был найден в системе Example `{ "username": "example", "identity": { "uid": "example", "cloud_uid": "example" } }` TrackerEnumField Type: TrackerEnumField Поле перечисления из Яндекс Трекера Example `{ "display": "example", "key": "example" }` Значения ячеек строки. При получении таблицы порядок соответствует порядку столбцов. При добавлении строк возвращаются только переданные значения в порядке ключей объекта запроса. Example `[ 0 ]`
color	All of 1 type BGColor Type: BGColor Цвет фона строки или столбца. Enum: `blue`, `yellow`, `pink`, `red`, `green`, `mint`, `grey`, `orange`, `magenta`, `purple`, `copper`, `ocean` Цвет фона строки Example: `blue`
pinned	Type: boolean Строка закреплена

Example

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

Была ли статья полезна?

Удалить таблицу

Удалить строки