Получение списка вложенных инстанций бизнес-объектов с 011 фильтром по идентификатору

012 013

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

014 015

У вас должно иметься родительский БО (Что это такое и как 018 создать?)
Также созданные инстанции данного БО (Как создать инстанцию через 022 API-service?)
У вас должно иметься вложенный БО к родительскому БО (Что это 026 такое и как создать?)
Также созданные инстанции данного БО которые вложены к одному 029 инстанцию родительского БО Как создать или 030 обновить вложенную иди инстанцию через API-service?)
Требуется добавить функционал сортировки по конкретному полю 033 для вложенных экземпляров объектов. Это необходимо реализовать в 034 режиме редактирования внутри вложенного БО

036 037

Запрос (Request)

038 039

040  POST /api/v1/boi/load-nested-with-sort-and-id
041  Content-Type: application/json
042  API-TOKEN/TOKEN: your_token
043  
044

045 046

Метод: POST
URL: http://your-domain.kz/api/v1/boi/load-nested-with-filter

Headers: 053 054

055  Content-Type: application/json
056  API-TOKEN/TOKEN: your_token
057  
058

059

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

064 065

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

066 067

068  {
069    "parentBoId": "Идентификатор родительского бизнес-объекта",
070    "parentBoiId": "Идентификатор инстанции родительского бизнес-объекта",
071    "paging": {
072      "offset": "количество пропускаемых элементов",
073      "limit": "количество элементов в одной странице"
074    },
075    "parentFieldId": "Идентификатор поля который ссылвется на вложенный объект",
076    "multiLanguage": true/false
077  }
078  
079

080 081

Как получить 083 boId?
Как получить 086 boiId?
multiLanguage - нужен при работе с мультиязычными полями. 089 Значение по умолчанию false - значит у этих полей 090 будут отображаться значения на выбранном языке текущего 091 пользователя. При true, вам будет отправляться массив 092 объектов fieldValuesLang**, содержащая текст по всем языкам которые 093 есть в системе для всех мультиязычных полей.

095 096

Пример:

097 098

099  {
100    "parentBoId": "ZPZ4oeUVnjnQBipS",
101    "paretnBoiId": "LiVjxjKNgCHiz1Af",
102    "paging": {
103      "offset": 0,
104      "limit": 20     
105    },
106    "parentFieldCode": "Customer_Address",
107    "multiLanguage": true
108  }
109  
110

111 112

Ответ (Response)

113 114

115  {
116    "records": [
117      {
118        "boiId": "Идентификатор инстанции вложенного БО 1",
119        "boId": "Идентификатор вложенного БО",
120        "state": "Одно из значений: ALL, REMOVED, ARCHIVED, DEV",
121        "isTouched": "Прочитано ли текущим пользователем данная инстанция? (true/false)",
122        "fieldValues": {
123          "идентификатор поля 1": {
124            "apiValue": "значение поля 1",
125            "displayValue": "значение поля для отабражения 1",
126            "type": "Тип поля"
127            // Подробнее о типах поля можете узнать по ссылке ниже
128          },
129          "идентификатор поля 2": {
130            "apiValue": "значение поля 2",
131            "displayValue": "значение поля для отабражения 2",
132            "type": "Тип поля"
133            // Подробнее о типах поля можете узнать по ссылке ниже
134          },
135          "идентификатор поля 3": {
136            "apiValue": "значение поля 3",
137            "displayValue": "значение поля для отабражения 3",
138            "type": "Тип поля"
139            // Подробнее о типах поля можете узнать по ссылке ниже
140          }
141        },
142        "fieldValuesLang": {
143          "идентификатор поля 4 ": {
144            "type": "тип мультиязычного поля 4",
145            "langApiValue": {
146              // Значения по всем языкам которые есть в системе
147              "Код языка": "Значение мультиязычного поля на этом языке"
148            }
149          }
150      },
151      {
152        "boiId": "Идентификатор инстанции вложенного БО 2",
153        "boCode": "Идентификатор вложенного БО",
154        "state": "Одно из значений: ALL, REMOVED, ARCHIVED, DEV",
155        "isTouched": "Прочитано ли текущим пользователем данная инстанция? (true/false)",
156        "fieldValues": {
157          "идентификатор поля 1": {
158            "apiValue": "значение поля 1",
159            "displayValue": "значение поля для отабражения 1",
160            "type": "Тип поля"
161            // Подробнее о типах поля можете узнать по ссылке ниже
162          },
163          "идентификатор поля 2": {
164            "apiValue": "значение поля 2",
165            "displayValue": "значение поля для отабражения 2",
166            "type": "Тип поля"
167            // Подробнее о типах поля можете узнать по ссылке ниже
168          },
169          "идентификатор поля 3": {
170            "apiValue": "значение поля 3",
171            "displayValue": "значение поля для отабражения 3",
172            "type": "Тип поля"
173            // Подробнее о типах поля можете узнать по ссылке ниже
174          }
175        },
176        "fieldValuesLang": {
177          "идентификатор поля 4 ": {
178            "type": "тип мультиязычного поля 4",
179            "langApiValue": {
180              // Значения по всем языкам которые есть в системе
181              "Код языка": "Значение мультиязычного поля на этом языке"
182            }
183          }
184      }
185    ],
186    "hasNext": "Имеется ли следующая страница? (true/false)", 
187    "totalHits": "Общее количество вложенных инстанций"    
188  }
189  
190

191 192

Какие есть типы полей и какие 194 значения они хранят?

196 197

Значения поля state:

198 199

1) ALL - Рабочее состояние записи

200 201

2) REMOVED - Запись удалена

202 203

3) ARCHIVED - Запись в архиве

204 205

4) DEV - Запись используется для тестирования 206 процессов

207 208

Пример:

209 210

211  {
212    "records": [
213      {
214        "boiId": "W7mc2dOOoToIKphL",
215        "boId": "aIhVWTEMdCpWJPxS",
216        "state": "ALL",
217        "isTouched": "true",
218        "fieldValues": {
219          "ZI@aXfe~IfeRY7s~": {
220            "apiValue": "Kazakhstan",
221            "displayValue": "Kazakhstan",
222            "type": "INPUT_TEXT"
223          },
224          "cXvd03BW1QCNgY76": {
225            "apiValue": "Almaty",
226            "displayValue": "Almaty",
227            "type": "INPUT_TEXT"
228          },
229          "4sSa~iKMAAEdn7Sv": {
230            "apiValue": "39",
231            "displayValue": "39",
232            "type": "INPUT_NUMBER"
233          },
234          "f4Dh1IbBD@Idv8Qi": {
235            "apiValue": "25",
236            "displayValue": "25",
237            "type": "INPUT_NUMBER"
238          }
239        },
240        "fieldValuesLang": {
241          "bLkMnNgjuAPc6Yv": {
242            "type": "INPUT_TEXT_LANG",
243            "langApiValue": {
244              // Значения по всем языкам которые есть в системе
245              "ENG": "Rozybakiev",
246              "RUS": "Розыбакиева",
247              "KAZ": "Розыбакиев",
248              "QAZ": "Rozybakiev"
249            }
250          }
251      },
252      {
253        "boiId": "V3vtqRrsoHF3khcv",
254        "boId": "aIhVWTEMdCpWJPxS",
255        "state": "ALL",
256        "isTouched": "true",
257        "fieldValues": {
258          "ZI@aXfe~IfeRY7s~": {
259            "apiValue": "Kazakhstan",
260            "displayValue": "Kazakhstan",
261            "type": "INPUT_TEXT"
262          },
263          "cXvd03BW1QCNgY76": {
264            "apiValue": "Shymkent",
265            "displayValue": "Shymkent",
266            "type": "INPUT_TEXT"
267          },
268          "4sSa~iKMAAEdn7Sv": {
269            "apiValue": "70",
270            "displayValue": "70",
271            "type": "INPUT_NUMBER"
272          },
273          "f4Dh1IbBD@Idv8Qi": {
274            "apiValue": "32",
275            "displayValue": "32",
276            "type": "INPUT_NUMBER"
277          }
278        },
279        "fieldValuesLang": {
280          "bLkMnNgjuAPc6Yv": {
281            "type": "INPUT_TEXT_LANG",
282            "langApiValue": {
283              // Значения по всем языкам которые есть в системе
284              "ENG": "Kaldayakov",
285              "RUS": "Калдаякова",
286              "KAZ": "Қалдаяқов",
287              "QAZ": "Rozybakiev"
288            }
289          }
290        }
291    ],
292    "hasNext": false, 
293    "totalHits": 2    
294  }
295  
296

297