Создавайте документы на основе выбранного шаблона, используя метод PUT api/v2/documents. Вы можете указать в запросе пользователя, который имя которого будет указываться в качестве автора в тегах и данных документа.
Параметры запроса:
|
Параметр |
Формат |
Обязательность |
Примечание |
|
ExternalID |
Строка |
Да |
Идентификатор документа во внешней системе |
|
TemplateID |
Строка |
Да |
Идентификатор шаблона в Системе |
|
Data |
Строка |
Да |
Данные документа. Формат строки должен соответствовать формату строки JSON |
|
|
|
Нет |
Пользователь с данным email будет указан автором созданного документа. В качестве автора может быть указан любой пользователь, кроме пользователя со статусом "Приглашение отменено". Если пользователь не найден или не указан в запросе, то в качестве автора устанавливается пользователь, под которым выполнена авторизация. |
Пример запроса:
curl -X PUT "https://local.doc.one/api/v2/documents" \
-H "Accept: application/json" \
-d "ExternalID"="architecto" \
-d "TemplateID"="architecto" \
-d "Data"="["foo","bar","baz"]" \
-d "Email"="willms.josue@example.org" \
Параметры ответа:
В ответе вернется ID созданного документа.
|
Параметр |
Формат |
Примечание |
|
ID |
Целое число |
Идентификатор документа |
|
UUID |
Строка |
Универсальный уникальный идентификатор документа |
|
ExternalID |
Строка |
Идентификатор документа во внешней системе |
Пример ответа:
{
"ID": 1,
"UUID": "550e8400-e29b-41d4-a716-446655440000",
"ExternalID": "123"
}
Комментарии
0 комментариев
Войдите в службу, чтобы оставить комментарий.