Для взаимодействия с командным сервисом документов используются POST запросы. Параметры запроса указываются в теле запроса в формате JSON. Запросы отправляются к https://documentserver/coauthoring/CommandService.ashx, где documentserver - имя сервера, на котором установлен Сервер документов.
Параметры и их описание:
Параметр | Описание | Тип | Наличие |
c | Определяет тип команды. Поддерживаемые значения:
|
строка | обязательный |
key | Определяет идентификатор документа, используемый, чтобы однозначно идентифицировать файл документа. | строка | обязательный |
meta | Определяет метаинформацию документа (используется для значения параметра c=meta). | строка | обязательный |
meta.title | Определяет название документа (используется для значения параметра c=meta). | строка | обязательный |
token | Определяет зашифрованную подпись, добавленную в параметры Сервера документов в виде токена. | строка | в соответствии с конфигурацией |
userdata | Определяет пользовательский идентификатор, который поможет различить запросы, если их было несколько. | строка | необязательный |
users | Определяет список идентификаторов пользователей (используется в качестве параметров для c=drop). | массив строк | необязательный |
Пример JSON объекта, отправляемого командному сервису документов и используемого для отключения пользователя с идентификатором 6d5a81d0 от сервиса редактирования документов.
{ "c": "drop", "key": "Khirz6zTPdfd7", "users": [ "6d5a81d0" ] }
Результат запроса возвращается в JSON формате form.
Пример результата запроса
{ "error": 0, "key": "Khirz6zTPdfd7" }
Пример JSON объекта, отправляемого командному сервису документов и используемого для принудительного сохранения редактируемого документа с идентификатором 6d5a81d0 без его закрытия.
{ "c": "forcesave", "key": "Khirz6zTPdfd7", "userdata": "sample userdata" }
Результат запроса возвращается в JSON формате form.
Пример результата запроса
{ "error": 0, "key": "Khirz6zTPdfd7" }
Пример JSON объекта, отправляемого командному сервису документов и используемого для получения статуса документа с идентификатором Khirz6zTPdfd7.
{ "c": "info", "key": "Khirz6zTPdfd7" }
Результат запроса возвращается в JSON формате.
Пример результата запроса
{ "error": 0, "key": "Khirz6zTPdfd7" }
Пример JSON объекта, отправляемого командному сервису документов и используемого для обновления названия документа с идентификатором Khirz6zTPdfd7
{ "c": "meta", "key": "Khirz6zTPdfd7", "meta": { "title": "Example Document Title.docx" } }
Результат запроса возвращается в JSON формате.
Пример результата запроса
{ "error": 0, "key": "Khirz6zTPdfd7" }
Пример JSON объекта, отправляемого командному сервису документов и используемого для получения текущего номера версии Сервера документов.
{ "c": "version" }
Результат запроса на получение версии возвращается в JSON формате.
Пример результата запроса
{ "error": 0, "version": "1.0" }
Пример JSON объекта содержит JSON токен, отправляемого командному сервису документов и используемого для получения статуса документа с идентификатором Khirz6zTPdfd7.
{ "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjIjoiaW5mbyIsImtleSI6IktoaXJ6NnpUUGRmZDcifQ.r_6sThjFABsHMNHhkVdHDSz4jwkbXRQNYdvawkBGJgg" }
Сервис редактирования документов оповещает сервис хранения документов о результатах выполнения команд, используя обработчик процедур обратного вызова.
Коды возможных ошибок и их описание
Код ошибки | Описание |
0 | Без ошибок. |
1 | Не указан ключ документа или не найден документ, с таким ключом. |
2 | Некорректная ссылка обратного вызова. |
3 | Внутренняя ошибка сервера. |
4 | Документ не был изменён до получения команды forcesave. |
5 | Неверная команда. |
6 | Неверный токен. |
Комментарии
0 комментариев
Статья закрыта для комментариев.