Получить параметры страницы по ID

Возвращает детали страницы:

fields — желаемые дополнительные блоки, см. описание формата ответа
follow_redirects — если на странице установлен редирект, будет выполнено перенаправление на details целевой страницы

Request

GET

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

Path parameters

Name	Description
idx*	Type: integer

Query parameters

Name	Description
fields	Type: string
raise_on_redirect	Type: boolean Default: `false`
revision_id	Type: integer

Responses

200 OK

Body

application/json

{
    "id": 0,
    "slug": "string",
    "title": "string",
    "page_type": "page",
    "redirect": {
        "page_id": 0,
        "redirect_target": {
            "id": 0,
            "slug": "string",
            "title": "string",
            "page_type": "page"
        }
    },
    "breadcrumbs": [
        {
            "id": 0,
            "title": "string",
            "slug": "string",
            "page_exists": false
        }
    ],
    "attributes": {
        "created_at": "2022-12-29T18:02:01Z",
        "modified_at": "2022-12-29T18:02:01Z",
        "lang": "string",
        "is_readonly": false,
        "comments_count": 0,
        "comments_enabled": false,
        "keywords": [
            "string"
        ],
        "is_collaborative": false,
        "is_draft": false
    }
}

Name	Description
id*	Type: integer
page_type*	Type: PageType An enumeration. Enum: `page`, `grid`, `cloud_page`, `wysiwyg`, `template`
slug*	Type: string
title*	Type: string
attributes	Type: PageAttributesSchema По умолчанию поле не возвращается Укажите `attributes` в списке `?fields=attributes, ...` для получения в ответе.
breadcrumbs	Type: BreadcrumbSchema[] По умолчанию поле не возвращается Укажите `breadcrumbs` в списке `?fields=breadcrumbs, ...` для получения в ответе.
content	Type: any По умолчанию поле не возвращается Укажите `content` в списке `?fields=content, ...` для получения в ответе. Разный для разных типов страницы: `page`, `wysiwyg` — `str` `cloud_page` — `CloudPageContentSchema` `grid` — `GridContentSchema` (legacy, для фронтенда Wiki там всегда null)
redirect	Type: RedirectSchema По умолчанию поле не возвращается Укажите `redirect` в списке `?fields=redirect, ...` для получения в ответе. Если редиректа нет, вернется `null`

PageType

An enumeration.

Type	Description
PageType	Enum: `page`, `grid`, `cloud_page`, `wysiwyg`, `template`

PageAttributesSchema

Name	Description
comments_count*	Type: integer
comments_enabled*	Type: boolean
created_at*	Type: string<date-time>
is_readonly*	Type: boolean
lang*	Type: string
modified_at*	Type: string<date-time>
is_collaborative	Type: boolean
is_draft	Type: boolean
keywords	Type: string[]

BreadcrumbSchema

Name	Description
page_exists*	Type: boolean
slug*	Type: string
title*	Type: string
id	Type: integer

RedirectSchema

Name

Description

page_id

Type: integer

ID страницы, на которую перенаправляет текущая страница.

redirect_target

Type: PageDetailsSchema

Если есть цепочка редиректов A->B->C->D, для A,B и С, это будет страница D.

PageDetailsSchema

Name	Description
id*	Type: integer
page_type*	Type: PageType An enumeration. Enum: `page`, `grid`, `cloud_page`, `wysiwyg`, `template`
slug*	Type: string
title*	Type: string

Was the article helpful?

Создать страницу

Обновить параметры страницы