Получить информацию о ресурсах страницы

Возвращает ресурсы страницы в массиве results. Каждый элемент содержит тип ресурса type и данные ресурса item:

  • attachment — прикрепленный файл: идентификатор, имя, ссылка для скачивания, размер в МиБ, описание, загрузивший файл пользователь, время загрузки, MIME-тип, доступность скачивания и предпросмотра, статус проверки антивирусом.
  • grid — динамическая таблица: идентификатор, название и время создания.

Пример ответа для страницы с файлом и динамической таблицей:

{
  "results": [
    {
      "type": "attachment",
      "item": {
        "id": 12345,
        "name": "report.pdf",
        "is_downloadable": true,
        "download_url": "/team/project/.files/report.pdf",
        "size": "1.00",
        "description": "",
        "user": null,
        "created_at": "2026-11-02T09:00:00Z",
        "mimetype": "application/pdf",
        "has_preview": true,
        "check_status": "ready"
      }
    },
    {
      "type": "grid",
      "item": {
        "id": "123e4567-e89b-42d3-a456-426614174000",
        "title": "Tasks",
        "created_at": "2026-11-02T08:00:00Z"
      }
    }
  ],
  "next_cursor": null,
  "prev_cursor": null
}

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

Request

GET

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

Path parameters

Name

Description

idx

Type: integer

Идентификатор страницы. Значение idx совпадает со значением поля id в ответе GET /v1/pages?slug=… или POST /v1/pages.

Query parameters

Name

Description

cursor

Type: string

Курсор страницы выдачи из next_cursor или prev_cursor предыдущего ответа

Example: ``

order_by

Type: string

Если указано, отсортировать выдачу по полю в направлении order_direction

Enum: name_title, created_at

order_direction
All of: OrderDirection

  • OrderDirection

    Type: string

    An enumeration.

    Enum: asc, desc

Если указано поле order_by, направление сортировки

Default: asc

Example: ``

page_size

Type: integer

Число результатов на странице выдачи.

Default: 50

Min value: 1

Max value: 100

q

Type: string

Поиск по заголовку

Max length: 255

Example: ``

types

Type: string

Необходимые типы ресурсов, через запятую. Возможные значения: attachment, grid

Example: ``

Responses

200 OK

OK

Body

application/json
{
  "results": [
    {
      "type": "attachment",
      "item": {
        "id": 0,
        "name": "example",
        "is_downloadable": true,
        "download_url": "example",
        "size": "example",
        "description": "example",
        "user": null,
        "created_at": "2025-01-01T00:00:00Z",
        "mimetype": "example",
        "has_preview": true,
        "check_status": "ready"
      }
    }
  ],
  "next_cursor": "example",
  "prev_cursor": "example"
}

Name

Description

results

Type: Resource[]

Элементы текущей страницы выдачи

Example
[
  {
    "type": "attachment",
    "item": {
      "id": 0,
      "name": "example",
      "is_downloadable": true,
      "download_url": "example",
      "size": "example",
      "description": "example",
      "user": null,
      "created_at": "2025-01-01T00:00:00Z",
      "mimetype": "example",
      "has_preview": true,
      "check_status": "ready"
    }
  }
]

next_cursor

Type: string

Курсор для запроса следующей страницы выдачи

Example: example

prev_cursor

Type: string

Курсор для запроса предыдущей страницы выдачи

Example: example

ResourceType

Тип ресурса страницы:

  • attachment — прикрепленный файл
  • grid — динамическая таблица

Type: string

Enum: attachment, grid

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

FileCheckStatusType

Статус проверки файла антивирусом:

  • check — файл проверяется
  • ready — файл готов к использованию
  • deleted — файл удален
  • infected — обнаружен вирус
  • error — ошибка при проверке

Type: string

Enum: check, ready, deleted, infected, error

AttachmentSchema

Прикрепленный файл к странице

Name

Description

created_at

Type: string<date-time>

Дата и время загрузки файла

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

description

Type: string

Описание файла

Example: example

download_url

Type: string

URL для скачивания файла

Example: example

has_preview

Type: boolean

Для файла доступен предварительный просмотр

id

Type: integer

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

mimetype

Type: string

MIME-тип файла

Example: example

name

Type: string

Имя файла

Example: example

size

Type: string

Размер файла в мебибайтах (МиБ)

Example: example

check_status
All of 1 type

  • FileCheckStatusType

    Type: FileCheckStatusType

    Статус проверки файла антивирусом:

    • check — файл проверяется
    • ready — файл готов к использованию
    • deleted — файл удален
    • infected — обнаружен вирус
    • error — ошибка при проверке

    Enum: check, ready, deleted, infected, error

Статус проверки файла антивирусом

Default: ready

is_downloadable

Type: boolean

Файл доступен для скачивания

Default: true

user
All of 1 type

  • UserSchema

    Type: UserSchema

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

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

Пользователь, загрузивший файл

Example
{
  "id": 0,
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "username": "example",
  "display_name": "example",
  "is_dismissed": true,
  "affiliation": "example"
}
Example
{
  "id": 0,
  "name": "example",
  "is_downloadable": true,
  "download_url": "example",
  "size": "example",
  "description": "example",
  "user": {
    "id": 0,
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    },
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  },
  "created_at": "2025-01-01T00:00:00Z",
  "mimetype": "example",
  "has_preview": true,
  "check_status": "ready"
}

PageGridsSchema

Краткая информация о динамической таблице страницы.

Name

Description

created_at

Type: string<date-time>

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

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

id

Type: string<uuid4>

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

Example: example

title

Type: string

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

Example: example
Example
{
  "id": "example",
  "title": "example",
  "created_at": "2025-01-01T00:00:00Z"
}

Resource

Name

Description

item
Any of 2 types

  • AttachmentSchema

    Type: AttachmentSchema

    Прикрепленный файл к странице

    Example
    {
  "id": 0,
  "name": "example",
  "is_downloadable": true,
  "download_url": "example",
  "size": "example",
  "description": "example",
  "user": {
    "id": 0,
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    },
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  },
  "created_at": "2025-01-01T00:00:00Z",
  "mimetype": "example",
  "has_preview": true,
  "check_status": "ready"
}

  • PageGridsSchema

    Type: PageGridsSchema

    Краткая информация о динамической таблице страницы.

    Example
    {
  "id": "example",
  "title": "example",
  "created_at": "2025-01-01T00:00:00Z"
}

Сведения о ресурсе. При type=attachment — файл, при type=grid — динамическая таблица.

Example
{
  "id": 0,
  "name": "example",
  "is_downloadable": true,
  "download_url": "example",
  "size": "example",
  "description": "example",
  "user": {
    "id": 0,
    "identity": null,
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  },
  "created_at": "2025-01-01T00:00:00Z",
  "mimetype": "example",
  "has_preview": true,
  "check_status": "ready"
}

type
All of 1 type

  • ResourceType

    Type: ResourceType

    Тип ресурса страницы:

    • attachment — прикрепленный файл
    • grid — динамическая таблица

    Enum: attachment, grid

Тип ресурса: attachment — прикрепленный файл, grid — динамическая таблица

Example: attachment
Example
{
  "type": "attachment",
  "item": {
    "id": 0,
    "name": "example",
    "is_downloadable": true,
    "download_url": "example",
    "size": "example",
    "description": "example",
    "user": {
      "id": 0,
      "identity": null,
      "username": "example",
      "display_name": "example",
      "is_dismissed": true,
      "affiliation": "example"
    },
    "created_at": "2025-01-01T00:00:00Z",
    "mimetype": "example",
    "has_preview": true,
    "check_status": "ready"
  }
}
Предыдущая
Обзор
Следующая
Обзор