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

011 012

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

013 014

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

025 026

Запрос (Request):

027 028

029  POST /api/v1/boi/update-with-id
030  Content-Type: application/json
031  API-TOKEN/TOKEN: your_token 
032  
033

034 035

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

Headers: 042 043

044  Content-Type: application/json
045  API-TOKEN/TOKEN: your_token
046  
047

048

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

053 054

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

055 056

057  {
058    "boId": "Идентификатор бизнес-объекта",
059    "boiId": "Идентификатор инстанции бизнес-объекта",
060    "fieldValues": {
061      "идентификатор поля 1": "новое значение 1",
062      "идентификатор поля 2": "новое значение 2",
063      "идентификатор поля 3": "новое значение 3"
064    },
065    "removeAfter": true,
066    "fieldRefAdd": [{
067      "fieldCode": "код поля 4",
068      "boCode": "код БО который содержит в себе поле с кодом поля 4",
069      "fieldRefUniqCode": "код уникального поля 1",
070      "apiValues": [
071        "значение 1 уникального поля 1",
072        "значение 2 уникального поля 1"
073      ]
074    }, ...],
075    "fieldRefRemove": [{
076      "fieldCode": "код поля 4",
077      "boCode": "код БО который содержит в себе поле с кодом поля 4",
078      "fieldRefUniqCode": "код уникального поля 1",
079      "apiValues": [
080        "значение 3 уникального поля 1",
081        "значение 4 уникального поля 1"
082      ]
083    }, ...]
084  }
085  
086

087 088 089 090 091 092 093 094 095 096 097 098 099 101 102 103 104 105 108 109 110 111 112 115 116 117 118 119 122 123 124 125 126 129 130 131 132 133 135 136 137 138 139 141 142 143 144 145 147 148 149 150 151 155 156 157 158 159 162 163 164 165 166 168 169 170

Атрибут входного JSON	Описание
boId	(String): Идентификатор бизнес-объекта. 100 Как получить идентификаторы БО?
boiId	(String): Идентификатор инстанции 106 бизнес-объекта. Как получить 107 boiId?
fieldValues.key	(String): Код определенного поля внутри 113 БО. Как получить идентификаторы 114 полей?
fieldValues.value	(String): Значение определенного поля 120 внутри БО. Какие значения для 121 каких полей надо вводить?
removeAfter	(Boolean): Указывает что будет раньше 127 добавление или удаление новых инстанции в поле БО. По умолчанию 128 false значит удаление потом добавление.
fieldRefAdd	(Массив объектов): Для добавления 134 ссылок в поле БО по значениям уникальных полей вложенного БО
fieldRefRemove	(Массив объектов): Для удаления ссылок 140 из поля БО по значениям уникальных полей вложенного БО
fieldRefAdd.fieldCode	(String): Код поля БО. Смотрите 146 выше как получить код поля?
fieldRefAdd.boCode	(String): Если поле с 152 fieldCode находится внутри СО, то данное поле 153 обязательное к заполнению, так как она будет 154 показывать к какому БО относится ваше поле.
fieldRefAdd.fieldRefUniqCode	(String): Код уникального поля БО на 160 которое ссылается ваше поле. Смотрите выше как получить код 161 поля?
fieldRefAdd.apiValues	(Массив String): Значения уникальных 167 полей которы надо добавить. Если в fieldRefRemove, то удалить.

171 172

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

174 175

Пример:

176 177

178  {
179    "boId": "gWmNg9ec3yI0wv4V",
180    "boiId": "jJY02CrDmAQw1OMz",
181    "fieldValues": {
182      "UweuNeV8aG3~Tuvf": "15",
183      "CV~4boDWzp2SpQ@U": "Alimzhan",
184      "84uP6Ml@gq87Fs2u": "1231231.0123",
185      "eK3Owd6xaY7YCODc": "2023-12-23T14:30:45.123Z",
186      "DybDzyYFS9csQLoJ": "cOtDX2KPeLv3nrjS"
187    }
188  }
189  
190

191 192

Ответ (Response):

193 194

Ответ: код 200

195 196

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

198 199

201