Skip to main content

Об’єкт StorageQuery (Дані для фільтрації)

Опис параметрів об’єкта

Параметр

Тип 1

Формат

Опис

extraParams

  

List<ExtraQueryParameters>

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

multiExtraParams

  

List<ExtraQueryParameters>

масив об’єктів; мультиіндекс (може приймати масив параметрів з масивами значень для кожного з параметрів)

type

M

List<XDocType>

масив об’єктів; список типів документів: 0 - всі типи, 1/2/3 … і більше - конкретний тип документа

statuses

M

List<Integer>

масив; список статусів (станів) документів, за якими буде відбуватися відбір:

  • 0 - all (всі)

  • 1 - open (чернетки)

  • 2 - sent (відправлені-Відправник)

  • 3 - delivered (доставлені-Відправник)

  • 4 - inbox (вхідні-Отримувач)

  • 5 - read (прочитані-Отримувач)

  • 6 - error (помилка)

  • 7 - deleted (видалені)

extraStatuses

  

List<Integer>

масив; список екстрастатусів

tags

  

List<Long>

масив; тег

exchangeStatus

O

List<Integer>

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

docs

  

List<Long>

масив; документи

docUUIDs

  

List<UUID>

масив; унікальні ідентифікатори документів

partners

  

List<Long>

масив; ідентифікатори контрагентів

families

  

List<Integer>

масив; ознака сервісу (сімейство)

  • 1 - EDI+ЮЗД

  • 7 - ЕТТН

direction

M

Direction

об’єкт; напрямок документообігу; вказуються відправник, отримувач і зв’язок між ними в умовах відбору документів

limit

O

Limitation

об’єкт; фільтр відбору (налаштування виводу даних)

orderBy

O

OrderBy

фільтрувати по даті чи опису документа

groupBy

O

String

об’єднані по id ланцюжка/документа

number

O

String

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

family

O

int

сімейство

  • 1 - EDI

  • 2 - UZD

  • 4 - CERTIFICATS

  • 6 - ATS

  • 7 - ETTN

  • 8 - DISTRIBUTION

  • 9 - SIMPLEDOC (Вільний)

  • 10 - TENDER

  • 11 - AGREEMENT

  • 12 - OPENPRICE (Є-Товар)

partnerId

  

Long

id роздрібної мережі

chainHash

  

String

хеш-значення, отримане в результаті обробки ланцюжка

docHash

  

String

хеш-значення, отримане в результаті обробки документа

docDate

O

DateTimeRange

об’єкт; дата зазначена в документі (в форматі UNIX-timestamp) з / по

docCreate

O

DateTimeRange

об’єкт; дата створення документа (у форматі UNIX-timestamp) з / по

docRead

O

DateTimeRange

об’єкт; дата прочитання документа (у форматі UNIX-timestamp) з / по

docChanged

O

DateTimeRange

об’єкт; дата останньої зміни документа (у форматі UNIX-timestamp) з / по

archive

  

Boolean

відмітка наявності архівної ознаки документа

important

  

boolean

відмітка важливий документ

visible

  

boolean

відмітка видимості

loadBody

  

boolean

відмітка наявності тіла документа

loadComments

  

boolean

відмітка наявності коментарів до документа

loadStatuses

  

boolean

відмітка наявності статусів документа

loadTags

  

boolean

відмітка наявності тегів документа

loadChain

  

boolean

відмітка наявності ланцюжка документів

loadAttachments

  

boolean

відмітка наявності вкладень

Приклади для сервісу «EDI Network»

Отримати всі документи-чернетки, в яких відправником зазначений GLN 9864065732303
JSON приклад 
{
    "archive": false,
    "direction":
    {
        "type": "EQ",
        "sender":
        [
            "9864065732303"
        ]
    },
    "exchangeStatus":
    [],
    "family": 1,
    "limit":
    {
        "offset": "0",
        "count": 21
    },
    "statuses":
    [
        1
    ],
    "tags":
    [],
    "type":
    [
        {
            "type": 0,
            "title": "all",
            "description": "all"
        }
    ],
    "families":
    [
        1,
        7
    ]
}
Отримати всі вхідні «Видаткові накладні», що знаходяться в статусі «Потребує підписання отримувачем»
JSON приклад 
{
  "statuses": [4, 5, 6],
  "type": [
    {
      "type": 28
    }
  ],
  "limit": {
    "offset": "0",
    "count": 21
  },
  "exchangeStatus": [
    1
  ],
  "extraParams": [
    {
      "operator": "AND",
      "type": "EQUALS",
      "value": "6",
      "fieldName": "sub_doc_type_id"
    },
    {
      "operator": "AND",
      "type": "EQUALS",
      "value": "1",
      "fieldName": "sub_status_id"
    }
  ],
  "tags": [],
  "archive": false,
  "direction": {
    "type": "EQ",
    "receiver": [
      "9864066822430"
    ],
    "sender": []
  },
  "family": 1
}
Отримати всі документи, окрім чернеток (масив statuses не містить «1»), в яких отримувачем є GLN 9864232304302
JSON приклад 
{
    "direction": {
        "sender": [],
        "receiver": ["9864232304302"],
        "type": "EQ"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": ["2","3","4","5","6","7"],
    "type": [
        {
            "type": "0"
        }
    ]
}
Отримати всі документи окрім чернеток (масив statuses не містить «1»), в яких відправником є GLN 9864232304302
JSON приклад 
{
    "direction": {
        "sender": ["9864232304302"],
        "receiver": [],
        "type": "EQ"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": ["2","3","4","5","6","7"],
    "type": [
        {
            "type": "0"
        }
    ]
}
Отримати всі вхідні документи (GLN отримувача 9864232304302)
JSON приклад 
{
    "direction": {
        "sender": [],
        "receiver": ["9864232304302"],
        "type": "EQ"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": ["4","5","6"],
    "type": [
        {
            "type": "0"
        }
    ]
}
Отримати всі відправлені документи (GLN відправника 9864232304302)
JSON приклад 
{
    "direction": {
        "sender": ["9864232304302"],
        "receiver": [],
        "type": "EQ"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": ["2","3","6"],
    "type": [
        {
            "type": "0"
        }
    ]
}
Отримати документи з номером рівним значенню «1001» (пошук серед усіх документів окрім чернеток), в яких отримувачем є GLN 9864232304302
JSON приклад 
{
    "direction": {
        "sender": [],
        "receiver": ["9864232304302"],
        "type": "EQ"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": ["2","3","4","5","6","7"],
    "number": "1001",
    "type": [
        {
            "type": "0"
        }
    ]
}
Отримати всі документи окрім чернеток для GLN відправника 9864232304302, що створені в травні 2019 (startTimestamp і finishTimestamp дати в форматі UNIX-timestamp за київським часом відносно UTC)
JSON приклад 
{
    "direction": {
        "sender": ["9864232304302"],
        "receiver": [],
        "type": "EQ"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": ["2","3","4","5","6","7"],
    "type": [
        {
            "type": "0"
        }
    ],
    "docDate": {
        "startTimestamp": "1556668800",
        "finishTimestamp": "1559347199"
    }
}

Приклади для сервісу «Маркет»

Отримати список всіх відправлених «Замовлень» (ORDERS) для GLN відправника 9864232324065
JSON приклад 
{
    "archive": false,
    "direction": {
        "receiver": [],
        "sender": ["9864232324065"],
        "type": "EQ"
    },
    "exchangeStatus": [],
    "extraParams": [],
    "family": 8,
    "multiExtraFields": [],
    "statuses": [2],
    "type": [
        {
            "type": 2
        }
    ]
}
Отримати список всіх чернеток «Замовлень» (ORDERS) для GLN 9864232324065 (створювач-відправник)
JSON приклад 
{
    "archive": false,
    "direction": {
        "receiver": [],
        "sender": ["9864232324065"],
        "type": "EQ"
    },
    "exchangeStatus": [],
    "extraParams": [],
    "family": 8,
    "multiExtraFields": [],
    "statuses": [1],
    "type": [
        {
            "type": 2
        }
    ]
}
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:

  • M (mandatory) — обов’язкові до заповнення поля;

  • O (optional) — необов’язкові (опціональні) до заповнення поля.

 

 

 

 

 

No comments to display

Back to top
Entity Select