API 3. Копирование документа или пакета – Doc.one

Используйте метод POSTapi/v3/documents/copy, чтобы скопировать документ или пакет.

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

Параметр	Формат	Обязательность	Примечание
UUID	Строка	Обязательно указание одного из параметров	Уникальный идентификатор документа или пакета документов
ExternalID	Строка	Обязательно указание одного из параметров	Идентификатор документа во внешней системе
NewExternalID	Строка	Нет	Новый внешний идентификатор документа или пакета документа
Upgrade	Да/Нет	Нет	По умолчанию False. Если True, то документ обновляется новой версией шаблона с переносом данных

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

curl -X POST "https://local.doc.one/api/v3/documents/copy" \
-H "Accept: application/json" -H "Content-type: application/json" \
-d '{"ExternalID":"id","UUID":"id","NewExternalID":"id","Upgrade":true}'

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

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

Параметр	Формат	Примечание
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"
        ]
    }
}

Похожие статьи