Для формування API запитів, за допомогою яких Майданчик буде взаємодіяти з ЦБД рекомендуємо орієнтуватися на Swagger Prozorro.Sale
В цьому документі розглянемо загальні правила, які допоможуть правильно взаємодіяти з обʼєктами ЦБД.
Публікація обʼєкта (POST)
Для публікації обʼєкта в ЦБД необхідно передати запит з правильною структурою (body) із заповненими всіма обовʼязковими полями.
Якщо в запиті НЕ передано одне чи декілька обовʼязкових полів, ЦБД поверне помилку:
Для публікації невистачає одного обовʼязкового поля:
Не вистачає декількох обовʼязкових полів:
Якщо існує потреба опублікувати вкладений в масив обʼєкт, необхідно використовувати також POST
Наприклад, в раніше опублікованій Процедурі необхідно додати в items[] ще один item
Потрібно використати запит
Цей запит НЕ змінюючи інші поля Процедури, а також не змінюючи вже існуючі в items[] обʼєкти item, додасть ще один item до items[]
Для даної ситуації бажано НЕ використовувати PATCH всієї Процедури або PATCH , де в запиті передати поля, які не змінюються.
Редагування обʼєкта (PATCH)
Якщо виникає потреба змінити значення в полях раніше опублікованої процедури, необхідно використовувати PATCH
Редагувати можна як весь обʼєкт повністю, так і вкладені обʼєкти.
Наприклад,
В опублікованій процедурі