API 3. Создание документа или пакета – Doc.one

Создавайте документы на основе выбранного шаблона, используя метод POST api/v3/documents. Вы можете указать в запросе пользователя, который имя которого будет указываться в качестве автора в тегах и данных документа.

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

Параметр	Формат	Обязательность	Примечание
TemplateID	Строка	Да	Идентификатор шаблона в Системе
ExternalID	Строка	Нет	Идентификатор документа во внешней системе. Если идентификатор указан, то должен быть уникальным
Title	Строка	Нет	Наименование документа. Минимальный размер наименования – 1 символ, максимальный – 255. Если название не указано, оно будет создано автоматически по правилам, заданным в шаблоне
Data	Строка	Нет	Данные документа. Формат строки должен соответствовать формату строки JSON
Author	Email	Нет	Пользователь с данным email будет указан автором созданного документа. В качестве автора может быть указан любой пользователь, кроме пользователя со статусом «Приглашение отменено». Если пользователь не найден или не указан в запросе, то в качестве автора устанавливается пользователь, под которым выполнена авторизация

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

curl -X POST "https://local.doc.one/api/v3/documents" \
-H "Accept: application/json" -H "Content-type: application/json" \
-d '{"TemplateID":"modi","ExternalID":"modi","Title":"modi","Data":"modi","Author":"ratke.camilla@example.org"}'

Параметры ответа:

В ответе вернутся данные документа или пакета документов.

Параметр	Формат	Примечание
ID	Целое число	Идентификатор документа
UUID	Строка	Универсальный уникальный идентификатор документа
Title	Строка	Заголовок документа
ExternalID	Строка	Идентификатор документа во внешней системе
Created	Дата и время	Дата и время создания документа в формате ISO 8601
Updated	Дата и время	Дата и время последнего изменения документа в формате ISO 8601
Link	Ссылка	Ссылка на загрузку документа. Параметр не приходит для пакетов документов
Data	Массив данных	В массиве приходят ExternalID всех вопросов и полей документа. Если для вопроса или поля не указан ExternalID, приходит название

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

{
    "ID": 1,
    "UUID": "550e8400-e29b-41d4-a716-446655440000",
    "Title": "1 - DOCUMENT_NAME",
    "ExternalID": "123",
    "Created": "2018-05-25 13:34:26",
    "Updated": "2018-09-17 13:54:03",
    "Link": "DOMAIN\/api\/documents\/download\/1",
    "Data": {
        "ExternalID1": [
            "fieldValue1"
        ],
        "ExternalID2": [
            "questionAnswerTitle1"
        ],
        "ExternalID3": [
            "fieldValue3",
            "questionAnswerTitle3"
        ],
        "ExternalIDN": [
            "fieldValueN_1",
            "fieldValueN_2"
        ]
    }
}