Get information about resources

Request

GET

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

Path parameters

Name

Description

idx

Type: integer

Query parameters

Name

Description

cursor

Type: string

Example: ``

order_by

Type: string

If specified, sort the results by this field in the direction direction

Enum: name_title, created_at

order_direction
All of: OrderDirection

  • OrderDirection

    Type: string

    An enumeration.

    Enum: asc, desc

If the order_by field is specified, the sort direction

Default: asc

Example: ``

page_size

Type: integer

Number of results per page.

Default: 50

Min value: 1

Max value: 100

q

Type: string

Search by title

Max length: 255

Example: ``

types

Type: string

The resource types to include, comma-separated. Possible values: 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

Page resource type:

  • attachment — an attached file
  • grid — a dynamic table

Type: string

Enum: attachment, grid

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

FileCheckStatusType

Antivirus file check status:

  • check — the file is being checked
  • ready — the file has been checked and is safe
  • deleted — the file has been deleted
  • infected — a virus has been detected
  • error — an error occurred during the check

Type: string

Enum: check, ready, deleted, infected, error

AttachmentSchema

A file attached to the page

Name

Description

created_at

Type: string<date-time>

Date and time the file was uploaded

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

description

Type: string

File description

Example: example

download_url

Type: string

File download URL

Example: example

has_preview

Type: boolean

Whether a file preview is available

id

Type: integer

Unique file identifier

mimetype

Type: string

File MIME type

Example: example

name

Type: string

File name

Example: example

size

Type: string

File size

Example: example

check_status
All of 1 type

  • FileCheckStatusType

    Type: FileCheckStatusType

    Antivirus file check status:

    • check — the file is being checked
    • ready — the file has been checked and is safe
    • deleted — the file has been deleted
    • infected — a virus has been detected
    • error — an error occurred during the check

    Enum: check, ready, deleted, infected, error

Antivirus file check status

Default: ready

is_downloadable

Type: boolean

Whether the file is available for download

Default: true

user
All of 1 type

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

The user who uploaded the file

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>

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

    A file attached to the page

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

Type: ResourceType

Page resource type:

  • attachment — an attached file
  • grid — a dynamic table

Enum: attachment, grid
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"
  }
}
Previous
Overview
Next
Overview