Документерра: руководство пользователя

[API] Создание страницы

Создание новой страницы в проекте.

POST projects/{project-id}/articles

Авторизация

Этот запрос требует базовой авторизации.

Параметры запроса

Параметры пути

project-id	string	Идентификатор проекта, в котором будет создана страница.

Параметры тела запроса

assigneeUserName	string	Логин исполнителя, которому назначена страница.
bodyHtml	string	[опционально] HTML-контент страницы.
id	string	Идентификатор страницы.
isShowInToc	bool	[опционально] Определяет, отображается ли страница в качестве элемента Дерева страниц в публикациях. Определяет соответствующий параметр в свойствах страницы. Условие false (ложно) по умолчанию.
ownerUserName	string	Логин владельца страницы.
parentTocNodeId	string	[опционально] Уникальный идентификатор родительского элемента Дерева страниц. Если указано значение null, страница отобразится на корневом уровне.
statusName	string	Состояние рабочего процесса страницы.
title	string	[опционально] Название страницы.
tocNodeCaption	string	[опционально] Пользовательское обозначение элемента Дерева страниц. Если не указано иное, то вместо этого используется название страницы.
tocNodeOrdinalNo	int	[опционально] Порядковый номер, указывающий на позицию страницы в Дереве страниц. Если не указано иное, страница будет создана на последней позиции на соответствующем уровне.
indexKeywords	array of strings	[опционально] Массив строк, содержащих ключевые слова, которые необходимо использовать при создании страницы.

Образцы

Образец запроса

Copy Code

Bash (Unix Shell)

curl --location -g --request POST 'https://{portal-url}/api/v1/projects/project-deep-space-exploration/articles' ^
--data-raw '{
    "assigneeUserName":"admin",
    "bodyHtml":"<p>This topic was created with the help of API<p>",
    "id":"nebula-api",
    "isShowInToc":true,
    "ownerUserName":"admin",
    "parentTocNodeId":null,
    "statusName":"draft",
    "title":"Nebula API",
    "tocNodeCaption":"",
    "tocNodeOrdinalNo":null,
  "indexKeywords": [
        "machinery",
        "api"
    ]
}'

[API] Получение всех страниц из проекта/публикации [API] Обновление страницы