Загрузка несколько инстанций бизнес-объекта (БО)

011 012

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

013 014

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

023 024

Запрос (Request):

025 026

027  POST /api/v1/boi/load-many
028  Content-Type: application/json
029  API-TOKEN/TOKEN: your_token
030  
031

032 033

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

Headers: 040 041

042  Content-Type: application/json
043  API-TOKEN/TOKEN: your_token
044  
045

046

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

051 052

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

053 054

055  {
056    "boCode": "Код бизнес-объекта",
057    "boiIds": "Идентификаторы инстанций бизнес-объекта",
058    "multiLanguage": true
059    /
060    false
061  }
062  
063

064 065

Как получить 067 boCode?
Как получить 070 boiId?
multiLanguage - нужен при работе с мультиязычными полями. 073 Значение по умолчанию false - значит у этих полей 074 будут отображаться значения на выбранном языке текущего 075 пользователя. При true, вам будет отправляться массив 076 объектов fieldValuesLang**, содержащая текст по всем языкам которые 077 есть в системе для всех мультиязычных полей.

079 080

Пример:

081 082

083  {
084    "boCode": "Customer_Orders",
085    "boiIds": [
086      "WjzCXs~fkIam6QDI",
087      "c7g~8pimNyQD2Nj@"
088    ],
089    "multiLanguage": true
090  }
091  
092

093 094

Ответ (Response):

095 096

097  {
098    "boiId": "Идентификатор инстанции БО",
099    "boCode": "Kод БО",
100    "state": "Одно из значений: ALL, REMOVED, ARCHIVED, DEV",
101    "isTouched": "Прочитано ли текущим пользователем данная инстанция? (true/false)",
102    "fieldValues": {
103      "код поля 1": {
104        "apiValue": "значение поля 1",
105        "displayValue": "значение поля для отображения 1",
106        "type": "Тип поля"
107        // Подробнее о типах поля можете узнать по ссылке ниже
108      },
109      "код поля 2": {
110        "apiValue": "значение поля 2",
111        "displayValue": "значение поля для отображения 2",
112        "type": "Тип поля"
113        // Подробнее о типах поля можете узнать по ссылке ниже
114      },
115      "код поля 3": {
116        "apiValue": "значение поля 3",
117        "displayValue": "значение поля для отображения 3",
118        "type": "Тип поля"
119        // Подробнее о типах поля можете узнать по ссылке ниже
120      }
121    },
122    "fieldValuesLang": {
123      "код поля 4 ": {
124        "type": "тип мультиязычного поля 4",
125        "langApiValue": {
126          // Значения по всем языкам которые есть в системе
127          "Код языка": "Значение мультиязычного поля на этом языке"
128        }
129      },
130      "код поля 5": {
131        "type": "тип мультиязычного поля 5",
132        "langApiValue": {
133          // Значения по всем языкам которые есть в системе
134          "Код языка": "Значение мультиязычного поля на этом языке"
135        }
136      }
137    }
138  }
139  
140

141 142

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

146 147

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

148 149

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

150 151

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

152 153

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

154 155

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

157 158

Пример:

159 160

161  {
162    "records": [
163      {
164        "boiId": "WjzCXs~fkIam6QDI",
165        "boCode": "Customer_Orders",
166        "state": "ALL",
167        "isTouched": false,
168        "fieldValues": {
169          "ORDER_ID": {
170            "apiValue": "3114448",
171            "displayValue": "3114448",
172            "type": "INPUT_NUMBER"
173          },
174          "ORDER_DATE": {
175            "apiValue": "2024-01-25T13:29:40.143+06",
176            "displayValue": "2024-01-25 13:29",
177            "type": "FULL_DATE"
178          },
179          "CUSTOMER_NAME": {
180            "apiValue": "Orazkhan",
181            "displayValue": "Orazkhan",
182            "type": "INPUT_TEXT_LANG"
183          },
184          "ORDER_STATUS": {
185            "apiValue": "qs2Qdp~3vVVSQIPc",
186            "displayValue": "Delivered",
187            "type": "RADIO_BUTTON_GROUP"
188          },
189          "ORDER_TOTAL": {
190            "apiValue": "100231.0123",
191            "displayValue": "100231.0123",
192            "type": "INPUT_NUMBER"
193          }
194        },
195        "fieldValuesLang": {
196          "CUSTOMER_NAME": {
197            "type": "INPUT_TEXT_LANG",
198            "langApiValue": {
199              // Значения по всем языкам которые есть в системе
200              "ENG": "Orazkhan",
201              "RUS": "Оразхан",
202              "KAZ": "Оразхан",
203              "QAZ": "Orazhan"
204            }
205          }
206        }
207      },
208      {
209        "boiId": "c7g~8pimNyQD2Nj@",
210        "boCode": "Customer_Orders",
211        "state": "ALL",
212        "isTouched": true,
213        "fieldValues": {
214          "ORDER_ID": {
215            "apiValue": "3129891",
216            "displayValue": "3129891",
217            "type": "INPUT_NUMBER"
218          },
219          "ORDER_DATE": {
220            "apiValue": "2023-12-23T20:30:45.123+06",
221            "displayValue": "2023-12-23 20:30",
222            "type": "FULL_DATE"
223          },
224          "CUSTOMER_NAME": {
225            "apiValue": "Temirlan",
226            "displayValue": "Temirlan",
227            "type": "INPUT_TEXT_LANG"
228          },
229          "ORDER_STATUS": {
230            "apiValue": "mm6mHOUvo3w3w~Ud",
231            "displayValue": "Delivered",
232            "type": "RADIO_BUTTON_GROUP"
233          },
234          "ORDER_TOTAL": {
235            "apiValue": "1231231.0123",
236            "displayValue": "1231231.0123",
237            "type": "INPUT_NUMBER"
238          }
239        },
240        "fieldValuesLang": {
241          "CUSTOMER_NAME": {
242            "type": "INPUT_TEXT_LANG",
243            "langApiValue": {
244              // Значения по всем языкам которые есть в системе
245              "ENG": "Temirlan",
246              "RUS": "Темирлан",
247              "KAZ": "Темірлан",
248              "QAZ": "Temirlan"
249            }
250          }
251        }
252      }
253    ]
254  }
255  
256

257