Перейти к основному содержимому

GetDocumentActions

Возвращает список действий, доступных текущему пользователю для указанного документа, шаблона или черновика.

GET /GetDocumentActions

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

  • boxId — идентификатор ящика организации в формате GUID.
  • messageId — идентификатор сообщения.
  • entityId — идентификатор сущности в сообщении.

Заголовки запроса

Коды ответа

  • 200 — операция успешно завершена.
  • 400 — данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
  • 401 — в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
  • 402 — у указанного ящика закончилась подписка на API.
  • 403 — доступ к ящику с предоставленным авторизационным токеном запрещен.
  • 404 — в указанном ящике не найдено сообщение с идентификатором messageId, или в указанном сообщении нет документа с идентификатором entityId, или документ удален.
  • 405 — используется неподходящий HTTP-метод.
  • 410 — документ удален по причине обнаружения вредоносного ПО.
  • 429 — превышено ограничение на количество запросов в единицу времени.
  • 500 — при обработке запроса возникла непредвиденная ошибка.

Тело ответа

Тело ответа содержит список доступных действий, представленный структурой DocumentActionList.

Для выполнения метода текущий пользователь должен иметь доступ к запрашиваемому документу, иначе метод вернет ошибку 403 (Forbidden).

Метод возвращает только те действия, которые текущий пользователь может выполнить над документом в его текущем состоянии. Для каждого действия указывается тип из перечисления DocumentActionType. Если для действия нужны дополнительные параметры (например, индекс титула), они возвращаются в поле Payload структуры DocumentAction.

Примеры использования

Пример HTTP-запроса:

GET /GetDocumentActions?boxId={{boxId}}&messageId={{messageId}}&entityId={{entityId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json

Пример тела ответа:

{
"Actions": [
{
"Type": "AttachParticipantTitle",
"Payload": {
"AttachParticipantTitle": {
"TitleIndex": 1,
"IsOptional": false
}
}
},
{
"Type": "ConfirmReceiptOfTitle",
"Payload": {
"ConfirmReceiptOfTitle": {
"TitleIndex": 0
}
}
},
{
"Type": "Delete"
},
{
"Type": "Move"
}
]
}

См. также

Методы для работы с документами:

  • Delete — отмечает указанный документ как удаленный
  • GetContent — возвращает XSD-схему документа
  • GetDocument (V3) — возвращает данные документа по указанному идентификатору
  • GetDocumentActions — возвращает список действий, доступных текущему пользователю для указанного документа, шаблона или черновика
  • GetDocumentHistory — возвращает историю событий по указанному документу, шаблону или черновику
  • GetDocuments (V3) — возвращает список документов, соответствующих заданным параметрам
  • GetDocuments (V4) — возвращает список документов, соответствующих заданным параметрам
  • GetDocumentsByMessageId — возвращает список документов из указанного сообщения
  • GetDocumentTypes (V2) — возвращает список типов документов, доступных в ящике
  • GetDocumentTypes (V3) — возвращает список типов документов, доступных в ящике, и дату перехода на универсальные сообщения
  • MoveDocuments — перемещает документы в указанное подразделение организации
  • Restore — восстанавливает документ из удаленных

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года