Справочный центр
Сервер документов Р7-Офис

Командный сервис

Для взаимодействия с командным сервисом документов используются POST запросы. Параметры запроса указываются в теле запроса в формате JSON. Запросы отправляются к https://documentserver/coauthoring/CommandService.ashx, где documentserver - имя сервера, на котором установлен Сервер документов.

Параметры и их описание:

Параметр Описание Тип Наличие
Определяет тип команды.
Поддерживаемые значения:
  • drop - отключает пользователей с идентификаторами, указанными в параметре users от сервиса редактирования документов (эти пользователи смогут просматривать документ, но не смогут его редактировать);
  • forcesave - принудительное сохранение редактируемого документа без его закрытия (после выполнения этой команды редактирование документа может быть продолжено, так что эта версия сохранения документа не будет финальной);
  • info - получение статуса документа;
  • meta - обновляет метаинформацию документа для всех редакторов совместной работы;
  • version - получение текущего номера версии Сервера документов;
строка обязательный
Определяет идентификатор документа, используемый, чтобы однозначно идентифицировать файл документа. строка обязательный
Определяет метаинформацию документа (используется для значения параметра c=meta). строка обязательный
Определяет название документа (используется для значения параметра c=meta). строка обязательный
Определяет зашифрованную подпись, добавленную в параметры Сервера документов в виде токена. строка в соответствии с конфигурацией
Определяет пользовательский идентификатор, который поможет различить запросы, если их было несколько. строка необязательный
Определяет список идентификаторов пользователей (используется в качестве параметров для c=drop). массив строк необязательный
{
    "c": "drop",
    "key": "Khirz6zTPdfd7",
    "users": [ "6d5a81d0" ]
}

Результат запроса возвращается в JSON формате form.

Пример результата запроса
{
    "error": 0,
    "key": "Khirz6zTPdfd7"
}
{
    "c": "forcesave",
    "key": "Khirz6zTPdfd7",
    "userdata": "sample userdata"
}

Результат запроса возвращается в JSON формате form.

Пример результата запроса
{
    "error": 0,
    "key": "Khirz6zTPdfd7"
}
{
    "c": "info",
    "key": "Khirz6zTPdfd7"
}

Результат запроса возвращается в JSON формате.

Пример результата запроса
{
    "error": 0,
    "key": "Khirz6zTPdfd7"
}
{
    "c": "meta",
    "key": "Khirz6zTPdfd7",
    "meta": {
        "title": "Example Document Title.docx"
    }
}

Результат запроса возвращается в JSON формате.

Пример результата запроса
{
    "error": 0,
    "key": "Khirz6zTPdfd7"
}
{
    "c": "version"
}

Результат запроса на получение версии возвращается в JSON формате.

Пример результата запроса
{
    "error": 0,
    "version": "1.0"
}
{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjIjoiaW5mbyIsImtleSI6IktoaXJ6NnpUUGRmZDcifQ.r_6sThjFABsHMNHhkVdHDSz4jwkbXRQNYdvawkBGJgg"
}

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

Коды возможных ошибок и их описание
Код ошибки Описание
0 Без ошибок.
1 Не указан ключ документа или не найден документ, с таким ключом.
2 Некорректная ссылка обратного вызова.
3 Внутренняя ошибка сервера.
4 Документ не был изменён до получения команды forcesave.
5 Неверная команда.
6 Неверный токен.