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

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

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

Запрос (Request):

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

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

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

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

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

{
  "boCode": "Код бизнес-объекта",
  "uniqueFieldCode": "Код уникального поля бизнес-объекта",
  "fieldValue": "Значение уникального поля"
}

• Как получить boCode?
• Как сделать поле уникальным?
• Как получить Код Поля (uniqueFieldCode)?
• Какие значения для каких полей надо вводить?

Пример:

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

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

{
  "boCode": "Customer_Orders",
  "uniqueFieldCode": "ORDER_ID",
  "fieldValue": "120398"
}

Ответ (Response):

Ответ: код 200

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

{
    "boiId": "QTU3DCdLCssP7Byg",
    "boCode": "Customer_Orders",
    "state": "REMOVED",
    "isTouched": true,
    "fieldValues": {
        "ORDER_ID": {
            "apiValue": "120398",
            "displayValue": "120398",
            "type": "INPUT_NUMBER"
        },
        "ORDER_DATE": {
            "apiValue": "2023-09-13T20:30:45.123+06",
            "displayValue": "2023-09-13 20:30",
            "type": "FULL_DATE"
        },
        "CUSTOMER_NAME": {
            "apiValue": "Temirlan",
            "displayValue": "Temirlan",
            "type": "INPUT_TEXT"
        },
        "ORDER_STATUS": {
            "apiValue": "qs2Qdp~3vVVSQIPc",
            "displayValue": "Pending",
            "type": "RADIO_BUTTON_GROUP"
        },
        "ORDER_TOTAL": {
            "apiValue": "1231231.0123",
            "displayValue": "1231231.0123",
            "type": "INPUT_NUMBER"
        }
    }
}