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

[API] Обновление страницы

Обновление контента страницы и/или метаданных.

PATCH projects/{project-id}/articles/{topic-id}

Авторизация

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

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

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

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

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

assigneeUserName	string	[опционально] Логин исполнителя, которому назначена страница.
body	string	[опционально] HTML-контент страницы.
ownerUserName	string	[опционально] Логин владельца страницы.
statusName	string	[опционально] Состояние рабочего процесса по странице.
title	string	[опционально] Название страницы.
indexKeywords	array of strings	[опционально] Массив строк, содержащих ключевые слова, которые необходимо использовать при обновлении страницы.
updatedFields	string	Разделенный запятыми список полей, которые подлежат обновлению. Если имя поля отсутствует в списке, то оно не будет обновлено, даже если значение поля указано в других параметрах запроса.

Образцы

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

Copy Code

Bash (Unix Shell)

curl --location -g --request PATCH 'https://{portal-url}/api/v1/projects/project-deep-space-exploration/articles/nebula' ^
--data-raw '{
    "assigneeUserName":"admin",
    "bodyHtml":"<h1>This topic was created with API</h1>",
    "ownerUserName":"admin",
    "statusName":"draft",
    "title":"New topic created with API",
  "indexKeywords": [
        "machinery",
        "api"
    ],
    "updatedFields": "title, body, statusName, assigneeUserName, ownerUserName, indexKeywords"
}'

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