Дані сценарію/-їв (об’єкт / масив об’єктів XDocApprovalScenario)
Приклад відповіді за всіма сценаріями (JSON):
[
{
"id": 1,
"actual": true,
"userId": 50206655,
"docType": 0,
"auto": false,
"name": "very short",
"documentSumMin": 0.0,
"documentSumMax": 0.0,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 2,
"dateChanged": 0
}
]
}
},
{
"id": 2,
"actual": true,
"userId": 50206655,
"docType": 0,
"auto": false,
"name": "Акт наданих послуг",
"documentSumMin": 0.0,
"documentSumMax": 0.0,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 2,
"dateChanged": 0
}
]
}
},
{
"id": 3,
"actual": true,
"userId": 50206655,
"docType": 0,
"auto": false,
"name": "test skip first step",
"documentSumMin": 0.0,
"documentSumMax": 0.0,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206661,
"stepStatus": 0,
"operationType": 1,
"dateChanged": 0
}
],
"2":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 1,
"dateChanged": 0
}
]
}
},
{
"id": 4,
"actual": true,
"userId": 50206655,
"docType": 0,
"auto": false,
"name": "На Дарʼю",
"documentSumMin": 0.0,
"documentSumMax": 0.0,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 1,
"dateChanged": 0
}
],
"2":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206661,
"stepStatus": 0,
"operationType": 2,
"dateChanged": 0
}
]
}
},
{
"id": 5,
"actual": true,
"userId": 50206655,
"docType": 28,
"auto": true,
"name": "СценкаНова",
"subDocTypes":
[
13
],
"partners":
[],
"documentSumMin": 0.0,
"documentSumMax": 0.0,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 1,
"dateChanged": 0
}
],
"2":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 2,
"dateChanged": 0
}
]
}
},
{
"id": 6,
"actual": false,
"userId": 50206655,
"docType": 28,
"auto": false,
"name": "На підтримку ЗСУ",
"subDocTypes":
[
13
],
"partners":
[
"1234567890AaB",
"4823058722214"
],
"documentSumMin": 5.0E+10,
"documentSumMax": 5000000000000001,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 1,
"dateChanged": 0
}
],
"2":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 2,
"dateChanged": 0
}
]
}
}
]
Приклад відповіді за одним сценарієм (JSON):
{
"id": 5,
"actual": true,
"userId": 50206655,
"docType": 28,
"auto": true,
"name": "СценкаНова",
"subDocTypes":
[
13
],
"partners":
[],
"documentSumMin": 0.0,
"documentSumMax": 0.0,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 1,
"dateChanged": 0
}
],
"2":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 2,
"dateChanged": 0
}
]
}
}
Таблиця 1 - Опис параметрів об’єкта XDocApprovalScenario
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
Об’єкт XDocApprovalScenario |
|||
id |
long |
id сценарію |
|
actual |
O |
boolean |
актуальність
actual=false - передається для видалення сценарію |
userId |
long |
id користувача |
|
docType |
O |
int |
тип документа для автопогодження:
|
auto |
O |
boolean |
автоматичний запуск погодження |
name |
M |
String |
назва сценарію |
subDocTypes |
O |
List<Integer> |
масив чисел; підтип COMDOC документа для автопогодження:
|
partners |
O |
List<String> |
масив значень; перелік GLN контрагентів, за якими буде запускатись автопогодження |
documentSumMin |
O |
double |
ВІД якої суми документа (з ПДВ) буде запускатись автопогодження |
documentSumMax |
O |
double |
ДО якої суми документа (з ПДВ) буде запускатись автопогодження |
steps |
M |
<Integer, List<XDocApprovalStep>> |
об’єкт з пронумерованими масивами об’єктів; тіло сценарію (кроки погодження документів) |
Таблиця 2 - Опис параметрів об’єкта XDocApprovalStep
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
Об’єкт XDocApprovalStep |
|||
docId |
long |
id документа |
|
scenarioId |
long |
id сценарію |
|
stepId |
M |
int |
id кроку погодження |
userId |
long |
id користувача |
|
stepStatus |
int |
статус кроку погодження
|
|
operationType |
M |
int |
тип операції
|
stepInfo |
String |
інфо кроку погодження (текст причини відхилення на даному кроці) |
|
dateChanged |
long |
дата останньої зміни (unix timestamp) |
- 1
Під визначенням колонки Тип поля мається на увазі скорочене позначення:
M (mandatory) — обов’язкові до заповнення поля;
O (optional) — необов’язкові (опціональні) до заповнення поля.