Удаление инстанции бизнес-объекта (БО) по уникальному полю по идентификатору

Предусловие:

• У вас должно иметься БО (Что это такое и как создать?)
• Также созданная инстанция данного БО (Как создать инстанцию через API-service?)

Запрос (Request):

POST /api/v1/boi/delete-by-unique-field-with-id
Content-Type: application/json
API-TOKEN/TOKEN: your_token

• Метод: POST
• URL: http://your-domain.kz/api/v1/boi/delete-by-unique-field-with-id
• Headers:

  Content-Type: application/json
  API-TOKEN/TOKEN: your_token
  

• Как получить API_TOKEN или TOKEN?

Входные данные:

{
  "boId": "Идентификатор бизнес-объекта",
  "uniqueFieldId": "Идентификатор уникального поля бизнес-объекта",
  "fieldValue": "Значение уникального поля"
}

• Как получить boId и uniqueFieldId?
• Как сделать поле уникальным?
• Какие значения для каких полей надо вводить?

Пример:

Хотим удалить заказ данного клиента, копируем текст у поля "ID заказа" с кодом поля "ORDER_ID" (Потому что она является уникальным полем)

Делаем следующий запрос:

{
  "boId": "gWmNg9ec3yI0wv4V", // Должно состоять только из 16 символов
  "uniqueFieldId": "UweuNeV8aG3~Tuvf", // Должно состоять только из 16 символов
  "fieldValue": "120398"
}

Ответ (Response):

Ответ: код 200

Также, вы можете удостовериться в удалении инстанции загрузив её. У вас должно выйти что state равен REMOVED:

{
  "boiId": "QTU3DCdLCssP7Byg",
  "boId": "gWmNg9ec3yI0wv4V",
  "state": "REMOVED",
  "isTouched": true,
  "fieldValues": {
    "UweuNeV8aG3~Tuvf": {
      "apiValue": "120398",
      "displayValue": "120398",
      "type": "INPUT_NUMBER"
    },
    "DybDzyYFS9csQLoJ": {
      "apiValue": "mm6mHOUvo3w3w~Ud",
      "displayValue": "pending",
      "type": "RADIO_BUTTON_GROUP"
    },
    "eK3Owd6xaY7YCODc": {
      "apiValue": "2023-09-13T20:30:45.123+06",
      "displayValue": "2023-09-13 20:30",
      "type": "FULL_DATE"
    },
    "84uP6Ml@gq87Fs2u": {
      "apiValue": "1231231.0123",
      "displayValue": "1231231.0123",
      "type": "INPUT_NUMBER"
    },
    "CV~4boDWzp2SpQ@U": {
      "apiValue": "Temirlan",
      "displayValue": "Temirlan",
      "type": "INPUT_TEXT"
    }
  }
}