Створення/редагування структурованого документа¶
Для роботи з цим методом користувач повинен бути авторизованим .
Метод запиту |
HTTP PATCH |
---|---|
Content-Type |
application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
URL запиту |
https://doc.edi-n.com/bdoc/store/package/document |
Параметри, що передаються в URL (разом з адресою методу) |
В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації |
JSON-параметри в тілі HTTP запиту/відповіді¶
REQUEST
Опис json-параметрів запиту метода API (об’єкт DocumentStore)
Таблиця 1 - Опис параметрів об’єкта DocumentStore
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт DocumentStore |
||
documentId |
long |
id документа |
packageId |
long |
id комплекта |
senderCompanyId |
long |
id організації відправника |
senderCompany |
об’єкт; дані компанії відправника |
|
documentType |
об’єкт; опис типу документу |
|
documentTypeId |
Long |
id типу документу |
number |
String |
номер документу |
date |
long |
дата документу |
dateSent |
long |
дата відправки |
clientSignsCount |
int |
кількість підписів клієнта |
ownerSignsCount |
int |
кількість підписів власника |
status |
int |
статус документа; 2 - відправлений; 3 - прийнятий; 4 - відхилений |
comment |
String |
коментар |
versionStructure |
long |
версія структури структурованого документу |
extraFields |
List<ExtraField_> |
масив об’єктів; прив’язка додаткових полів до документа |
bodies |
List<DocumentBody_> |
масив об’єктів; тіла документів |
structure |
List<DocStructValue_> |
масив об’єктів; опис структури зі значеннями |
agreementLogs |
List<AgreementLogs_> |
масив об’єктів; історія / логи узгоджень |
isReadFromApi |
int |
ознака прочитання по API |
documentUuid |
UUID |
унікальний ідентифікатор документа |
agreementProcId |
long |
ID процесу узгодження |
agreementStatus |
int |
статус узгодження |
dictionaryValue |
об’єкт; значення довідника |
RESPONSE
Опис json-параметрів відповіді метода API (об’єкт DocumentStore)
Таблиця 2 - Опис параметрів об’єкта DocumentStore
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт DocumentStore |
||
documentId |
long |
id документа |
packageId |
long |
id комплекта |
senderCompanyId |
long |
id організації відправника |
senderCompany |
об’єкт; дані компанії відправника |
|
documentType |
об’єкт; опис типу документу |
|
documentTypeId |
Long |
id типу документу |
number |
String |
номер документу |
date |
long |
дата документу |
dateSent |
long |
дата відправки |
clientSignsCount |
int |
кількість підписів клієнта |
ownerSignsCount |
int |
кількість підписів власника |
status |
int |
статус документа; 2 - відправлений; 3 - прийнятий; 4 - відхилений |
comment |
String |
коментар |
versionStructure |
long |
версія структури структурованого документу |
extraFields |
List<ExtraField_> |
масив об’єктів; прив’язка додаткових полів до документа |
bodies |
List<DocumentBody_> |
масив об’єктів; тіла документів |
structure |
List<DocStructValue_> |
масив об’єктів; опис структури зі значеннями |
agreementLogs |
List<AgreementLogs_> |
масив об’єктів; історія / логи узгоджень |
isReadFromApi |
int |
ознака прочитання по API |
documentUuid |
UUID |
унікальний ідентифікатор документа |
agreementProcId |
long |
ID процесу узгодження |
agreementStatus |
int |
статус узгодження |
dictionaryValue |
об’єкт; значення довідника |
Приклади¶
Приклад тіла запиту (json):
{
"packageId": 1982,
"documentType": {
"documentId": 1086
},
"number": "99999",
"date": 1526947200,
"structure": [
{
"id": "Тег1",
"structure": [
[
{
"id": "Тег2",
"structure": null,
"value": "Имя файла"
},
{
"id": "Тег3",
"structure": [
[
{
"id": "Тег4",
"structure": null,
"value": "20820657",
"index": 0
}
]
],
"value": 11111
}
]
],
"value": 1222
}
]
}
Приклад тіла відповіді (json):
{
"documentId": 1662,
"packageId": 1982,
"senderCompanyId": 2,
"documentType": {
"documentId": 1086,
"companyId": 2,
"name": "Для тест ",
"type": 2,
"code": "sdoc1",
"isActive": 1,
"structures": [
{
"id": 1086,
"structure": [
{}
],
"version": 1,
"status": 1,
"dateUpdate": 1540280767
}
]
},
"number": "99999",
"date": 1526947200,
"dateSent": 0,
"clientSignsCount": 0,
"ownerSignsCount": 0,
"status": 1,
"comment": "aaaa",
"versionStructure": 1,
"bodies": [
{
"bodyId": 1662,
"documentId": 1662,
"fileName": "99999_1526947200_1662.xml",
"signBodies": []
}
],
"structure": [
{
"id": "Тег1",
"value": "1222",
"index": 0,
"structure": []
}
],
"isReadFromApi": 0
}