Вивантаження списку типів документів з .xlsx файлу¶
Для роботи з цим методом користувач повинен бути авторизованим .
Метод запиту |
HTTP POST |
---|---|
Content-Type |
application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
URL запиту |
https://doc.edin.ua/bdoc/document_types |
Параметри, що передаються в URL (разом з адресою методу) |
В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: document_id - ID документу Опціональні url-параметри: use_type - тип документообігу („1 - external use (зовнішній), 2 - internal use (внутрішній)“) |
JSON-параметри в тілі HTTP запиту/відповіді¶
REQUEST
В запиті методу передається Excel файл.
RESPONSE
Опис json-параметрів відповіді методу API (масив об’єктів Document).
Таблиця 1 - Опис параметрів об’єкта Document
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Document |
||
documentId |
long |
id документа |
companyId |
long |
id компанії |
company |
об’єкт; інформація про компанію |
|
name |
String |
назва документа |
type |
int |
тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця» |
code |
String |
код документа |
agreementProcId |
long |
id процесу узгодження |
isActive |
int |
статус; «1 - Активний; 0 - Заблокований» |
extraFields |
List<ExtraField_> |
масив об’єктів; додаткові поля документа |
dictionary |
об’єкт; дані довідника |
|
structures |
List<DocumentStructure_> |
масив об’єктів; дані структурованого документа |
Приклади¶
В тілі запиту передається Excel файл.
Приклад тіла відповіді в json форматі
[
{
"agreementProcId": 0,
"companyId": 4,
"documentId": 2583,
"extraFields": [],
"isActive": 1,
"isProviderAccess": 1,
"name": "Для шифрования",
"type": 1,
"useType": 1
},
{
"agreementProcId": 68,
"code": "423",
"companyId": 4,
"documentId": 1008,
"extraFields": [],
"isActive": 1,
"isProviderAccess": 0,
"name": "О еще один",
"type": 1,
"useType": 1
},
{
"agreementProcId": 0,
"code": "56",
"companyId": 4,
"documentId": 980,
"extraFields": [],
"isActive": 1,
"isProviderAccess": 0,
"name": "для шифрования",
"type": 1,
"useType": 1
}
]