Add Rows

Request

POST

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

Path parameters

Name

Description

idx

Type: string<uuid4>

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

Example: example

position

Type: integer

revision

Type: string

Example: example

UserIdentityExtended

Extended user identifier with additional fields

Name	Description
cloud_uid	Type: string User identifier in Yandex Cloud Example: `example`
uid	Type: string Unique user identifier (UID) in Yandex Example: `example`
username	Type: string User login 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

Ticket schema from Yandex Tracker

Name

Description

key

Type: string

Ticket key (for example, WIKI-123)

Example: example

resolved

Type: boolean

The ticket is resolved (closed)

Example

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

UserIdentity

User identifier

Name

Description

cloud_uid

Type: string

User identifier in the cloud (for the external instance)

Example: example

uid

Type: string

User identifier in Yandex (for the internal instance)

Example: example

Example

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

UserSchema

Information about the user

Name	Description
affiliation	Type: string User affiliation (for example, `yandex`, `external`) Example: `example`
display_name	Type: string User display name Example: `example`
id	Type: integer Internal user identifier
is_dismissed	Type: boolean The user has been 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 identifier

Example

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

username

Type: string

User login

Example: example

Example

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

TrackerEnumField

Enumeration field from Yandex Tracker

Name

Description

display

Type: string

Displayed field value

Example: example

key

Type: string

Field value key

Example: example

Example

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

BGColor

An enumeration.

Type: string

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

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 Ticket schema from Yandex Tracker Example `{ "key": "example", "resolved": true }` Type: string[] Example `[ "example" ]` Type: array Any of 2 types UserSchema Type: UserSchema Information about the user 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 Information about the user 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 Enumeration field from Yandex Tracker Example `{ "display": "example", "key": "example" }` Array of the row's cell values (the order matches the column order) Example `[ 0 ]`
color	All of 1 type BGColor Type: BGColor An enumeration. 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"
}

Was the article helpful?

Delete Grid

Remove Rows