Изменение инстанции бизнес-объекта (БО)

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

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

Запрос (Request):

POST /api/v1/boi/update
Content-Type: application/json
API-TOKEN/TOKEN: your_token

Метод: POST
URL: http://your-domain.kz/api/v1/boi/update

Headers:

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

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

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

{
  "boCode": "код бизнес-объекта",
  "boiId": "Идентификатор инстанции бизнес-объекта",
  "fieldValues": {
    "код поля 1": "новое значение 1",
    "код поля 2": "новое значение 2",
    "код поля 3": "новое значение 3"
  },
  "removeAfter": false,
  "fieldRefAdd": [{
    "fieldCode": "код поля 4",
    "boCode": "код БО который содержит в себе поле с кодом поля 4",
    "fieldRefUniqCode": "код уникального поля 1",
    "apiValues": [
      "значение 1 уникального поля 1",
      "значение 2 уникального поля 1"
    ]
  }, ...],
  "fieldRefRemove": [{
    "fieldCode": "код поля 4",
    "boCode": "код БО который содержит в себе поле с кодом поля 4",
    "fieldRefUniqCode": "код уникального поля 1",
    "apiValues": [
      "значение 3 уникального поля 1",
      "значение 4 уникального поля 1"
    ]
  }, ...]
}

Атрибут входного JSON	Описание
boCode	(String): Код бизнес-объекта. Как получить boCode?
boiId	(String): Идентификатор инстанции бизнес-объекта. Как получить boiId?
fieldValues.key	(String): Код определенного поля внутри БО. Как получить Код Поля?
fieldValues.value	(String): Значение определенного поля внутри БО. Какие значения для каких полей надо вводить?
removeAfter	(Boolean): Указывает что будет раньше добавление или удаление новых инстанции в поле БО. По умолчанию false значит удаление потом добавление.
fieldRefAdd	(Массив объектов): Для добавления ссылок в поле БО по значениям уникальных полей вложенного БО
fieldRefRemove	(Массив объектов): Для удаления ссылок из поля БО по значениям уникальных полей вложенного БО
fieldRefAdd.fieldCode	(String): Код поля БО. Смотрите выше как получить код поля?
fieldRefAdd.boCode	(String): Если поле с fieldCode находится внутри СО, то данное поле обязательное к заполнению, так как она будет показывать к какому БО относится ваше поле.
fieldRefAdd.fieldRefUniqCode	(String): Код уникального поля БО на которое ссылается ваше поле. Смотрите выше как получить код поля?
fieldRefAdd.apiValues	(Массив String): Значения уникальных полей которы надо добавить. Если в fieldRefRemove, то удалить.

Примечание: Вы можете указывать несколько уникальных полей одного и того же БО.

Пример:

{
  "boCode": "Customer_Orders",
  "boiId": "jJY02CrDmAQw1OMz",
  "fieldValues": {
    "ORDER_ID": "14",
    "CUSTOMER_NAME": "Temirlan",
    "ORDER_TOTAL": "123.0123",
    "ORDER_DATE": "2023-11-23T14:30:45.123Z",
    "ORDER_STATUS": "1wgmhNoiLSDpyXY9"
  }
}

Ответ (Response):

Ответ: код 200

Также можете проверить изменения на клиенте или через загрузку инстанции БО: