Получение списка вложенных инстанций бизнес-объектов с 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
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    "parentBoCode": "Код родительского бизнес-объекта",
070    "parentBoiId": "Идентификатор инстанции родительского бизнес-объекта",
071    "paging": {
072      "offset": "количество пропускаемых элементов",
073      "limit": "количество элементов в одной странице"
074    },
075    "parentFieldCode": "Код поля который ссылвется на вложенный объект",
076    "multiLanguage": true/false
077  }
078  
079

080 081

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

098 099

Пример:

100 101

102  {
103    "parentBoCode": "Customer_Orders",
104    "paretnBoiId": "LiVjxjKNgCHiz1Af",
105    "paging": {
106      "offset": 0,
107      "limit": 20     
108    },
109    "parentFieldCode": "Customer_Address",
110    "multiLanguage": true
111  }
112  
113

114 115

Ответ (Response)

116 117

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

194 195

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

199 200

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

201 202

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

203 204

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

205 206

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

207 208

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

210 211

Пример:

212 213

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

300