Створення/редагування типу комплекта документів (структурованого чи НЕструктурованого)

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній documentId, то документ з зазначеним Id підлягає редагуванню. Відсутність параметра documentId веде до створення нового документу.

Увага

Вибір типу документу визначається параметром type:

type=1 - НЕструктурований документ

type=2 - структурований документ

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/document_type

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

documentId (для редагування документу), isActive, companyId, name, code, type

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (об’єкт Document)

Таблиця 1 - Опис параметрів об’єкта Document

Параметр

Формат

Опис

Об’єкт Document

documentId

long

id документа

companyId

long

id компанії

company

Company_

об’єкт; інформація про компанію

name

String

назва документа

type

int

тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця»

code

String

код документа

agreementProcId

long

id процесу узгодження

isActive

int

статус; «1 - Активний; 0 - Заблокований»

extraFields

List<ExtraField_>

масив об’єктів; додаткові поля документа

dictionary

Dictionary_

об’єкт; дані довідника

structures

List<DocumentStructure_>

масив об’єктів; дані структурованого документа

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Document)

Таблиця 2 - Опис параметрів об’єкта Document

Параметр

Формат

Опис

Об’єкт Document

documentId

long

id документа

companyId

long

id компанії

company

Company_

об’єкт; інформація про компанію

name

String

назва документа

type

int

тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця»

code

String

код документа

agreementProcId

long

id процесу узгодження

isActive

int

статус; «1 - Активний; 0 - Заблокований»

extraFields

List<ExtraField_>

масив об’єктів; додаткові поля документа

dictionary

Dictionary_

об’єкт; дані довідника

structures

List<DocumentStructure_>

масив об’єктів; дані структурованого документа


Приклади

Приклад тіла запиту (json) для Створення НЕструктурованого документу:

{
  "isActive": 1,
  "companyId": 989,
  "name": "выаыdssdаы",
  "code": "4324234223425",
  "type": 1
}

Приклад тіла запиту (json) для Редагування НЕструктурованого документу:

{
  "documentId": 2467,
  "isActive": 1,
  "companyId": 989,
  "name": "имя",
  "code": "4324234223425",
  "type": 1
}

Приклад тіла запиту (json) для Створення структурованого документу:

{
  "isActive": 1,
  "companyId": 989,
  "name": "выаыdssdаы",
  "code": "4324234223425",
  "type": 2
}

Приклад тіла запиту (json) для Редагування структурованого документу:

{
  "documentId": 2467,
  "isActive": 1,
  "companyId": 989,
  "name": "имя",
  "code": "4324234223425",
  "type": 2
}

Приклад тіла відповіді (json) - однаковий для Створення/Редагування:

{
  "documentId": 2467,
  "companyId": 989,
  "name": "выаыdssdаы",
  "type": 1,
  "code": "4324234223425",
  "agreementProcId": 0,
  "isActive": 1,
  "extraFields": []
}