Відкрити протокол сканування за protocolId POST /api/des-pscan/protocols/{protocolId}/action/open
Повертає протоколи, операційні документи яких відповідають заданому відношенню. Відповідність має бути точною, з урахуванням регістру та в межах tenant; значення не нормалізуються. Для `relationType=order` параметр `relatedCode` може містити щонайбільше 255 символів. Для `relationType=operation-document` додаткові обмеження щодо довжини не застосовуються.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/des-pscan/protocols/{protocolId}/action/open |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 200.
Об'єкт ScanningProtocolResponse
JSON приклад відповіді
{
"protocolId": "string",
"protocolType": "string",
"operationType": "string",
"protocolStatus": "string",
"ugiCode": "string",
"protocolCreatedBy": "string",
"protocolCreatedAt": "2026-11-17T09:07:28.180Z",
"protocolUpdatedBy": "string",
"protocolUpdatedAt": "2026-11-17T09:07:28.181Z",
"protocolClosedBy": "string",
"protocolClosedAt": "2026-11-17T09:07:28.181Z",
"senderEconomicOperatorCode": "string",
"senderEconomicOperatorObjectCode": "string",
"senderBusinessUnitId": "string",
"receiverEconomicOperatorCode": "string",
"receiverEconomicOperatorObjectCode": "string",
"receiverBusinessUnitId": "string",
"operatorObjectCode": "string",
"businessUnitId": "string",
"operationDocuments": [
{
"relations": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
},
"operationDocumentType": "string",
"operationDocumentId": "string",
"items": [
{
"articleId": "string",
"quantity": 0
}
]
}
],
"items": [
{
"itemId": "string",
"scannedBy": "string",
"scannedAt": "2026-11-17T09:07:28.181Z",
"exciseCode": "string",
"barcode": "string",
"ssccCode": "string",
"readableCode": "string",
"legacyExciseCode": "string",
"quantity": 0,
"itemSource": "string",
"itemType": "string",
"articleId": "string",
"validationStatus": "string",
"validationMessage": "string",
"documentId": "string",
"validations": {
"additionalProp1": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
},
"additionalProp2": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
},
"additionalProp3": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
}
}
}
],
"docs": [
{
"documentId": "string",
"desState": "string",
"validationResult": "string"
}
],
"emValidation": {
"errors": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"type": "Business",
"details": "string",
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"warnings": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"decision": "Valid"
},
"generalValidation": {
"errors": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"type": "Business",
"details": "string",
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"warnings": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"decision": "Valid"
}
}
- Статус 404 - Not Found. Протокол сканування за вказаним protocolId не знайдено.