Изменение тегов документов¶
POST /documents/retagAuthorization: Bearer access_token
Content-Type: application/json
Accept: application/json
Тело запроса:
{
"DocumentRetagInfos": [ // сведения об изменении тегов документов
{
"DocumentId": "guid", // идентификатор документа
"Tags": [ // новый перечень тегов документа
"string"
]
}
]
}
Примечание
Если функционал изменения тегов используется для перенаправления документа из одной учетной системы в другую, то после получения документа в новой учетной системе необходимо вызвать метод получения подробной информации о документе.
Описание запроса¶
Теги используются для разделения потоков документов. Ролям пользователей Integration API можно назначить перечень тегов документов, с которыми разрешено работать пользователям, включенным в роль. В результате пользователи смогут получить доступ в запросах к API только к документам со «своими» тегами.
Теги назначаются автоматически интеграционным модулем Продукта при отправке исходящего или при получении входящего документа.
Если по какой-то причине нужно передать документ другим пользователям Integration API, то нужно использовать запрос на изменение тегов. Он ставит задачу на изменение перечня тегов для одного или нескольких документов.
Сведения об изменении тегов документов передаются в коллекции DocumentRetagInfos.
Каждый элемент коллекции определяет документ и новый перечень тегов документа.
Примечание
Для отправки запроса пользователю Integration API должно быть назначено разрешение retagger.
Ответ на запрос¶
Изменение тегов документов выполняется асинхронно. В случае успешного выполнения запроса ставится задача на изменение и возвращается ее идентификатор.
Статус задачи на изменение тегов документов¶
Отдельный запрос для получения статуса задачи на изменение не предусмотрен. По результатам обработки задачи интеграционным модулем для всех документов, затронутых задачей, поступит новый статус.
DRT).E).