010
Загрузка инстанции бизнес-объекта (БО) по уникальному
011 полю
012
013
Предусловие:
014
015
024
025
Запрос (Request):
026
027
028 POST /api/v1/boi/load-by-unique-field
029 Content-Type: application/json
030 API-TOKEN/TOKEN: your_token
031
032
033
034
052
053
Входные данные:
054
055
056 {
057 "boCode": "Код бизнес-объекта",
058 "uniqueFieldCode": "Код уникального поля бизнес-объекта",
059 "fieldValue": "Значение уникального поля",
060 "multiLanguage": true / false
061 }
062
063
064
065
082
083
Пример:
084
085
Хотим получить заказ данного клиента, копируем текст у поля "ID
086 заказа" с кодом поля "ORDER_ID" (Потому что она является уникальным
087 полем) 
089
090
Делаем следующий запрос:
091
092
093 {
094 "boCode": "Customer_Orders",
095 "uniqueFieldCode": "ORDER_ID",
096 "fieldValue": "120398",
097 "multiLanguage": true
098 }
099
100
101
102
106
107
Ответ (Response):
108
109
110 {
111 "boiId": "Идентификатор инстанции БО",
112 "boCode": "Kод БО",
113 "state": "Одно из значений: ALL, REMOVED, ARCHIVED, DEV",
114 "isTouched": "Прочитано ли текущим пользователем данная инстанция? (true/false)",
115 "fieldValues": {
116 "код поля 1": {
117 "apiValue": "значение поля 1",
118 "displayValue": "значение поля для отображения 1",
119 "type": "Тип поля" // Подробнее о типах поля можете узнать по ссылке ниже
120 },
121 "код поля 2": {
122 "apiValue": "значение поля 2",
123 "displayValue": "значение поля для отображения 2",
124 "type": "Тип поля" // Подробнее о типах поля можете узнать по ссылке ниже
125 },
126 "код поля 3": {
127 "apiValue": "значение поля 3",
128 "displayValue": "значение поля для отображения 3",
129 "type": "Тип поля" // Подробнее о типах поля можете узнать по ссылке ниже
130 }
131 },
132 "fieldValuesLang": {
133 "код поля 4 ": {
134 "type": "тип мультиязычного поля 4",
135 "langApiValue": { // Значения по всем языкам которые есть в системе
136 "Код языка": "Значение мультиязычного поля на этом языке",
137 }
138 },
139 "код поля 5": {
140 "type": "тип мультиязычного поля 5",
141 "langApiValue": { // Значения по всем языкам которые есть в системе
142 "Код языка": "Значение мультиязычного поля на этом языке"
143 }
144 }
145 }
146 }
147
148
149
150
154
155
Значения поля state:
156
157
1) ALL - Рабочее состояние записи
158
159
2) REMOVED - Запись удалена
160
161
3) ARCHIVED - Запись в архиве
162
163
4) DEV - Запись используется для тестирования
164 процессов
165
166
Пример:
167
168
169 {
170 "boiId": "QTU3DCdLCssP7Byg",
171 "boCode": "Customer_Orders",
172 "state": "ALL",
173 "isTouched": true,
174 "fieldValues": {
175 "ORDER_ID": {
176 "apiValue": "120398",
177 "displayValue": "3129891",
178 "type": "INPUT_NUMBER"
179 },
180 "ORDER_DATE": {
181 "apiValue": "2023-09-13T20:30:45.123+06",
182 "displayValue": "2023-12-23 20:30",
183 "type": "FULL_DATE"
184 },
185 "CUSTOMER_NAME": {
186 "apiValue": "Temirlan",
187 "displayValue": "Temirlan",
188 "type": "INPUT_TEXT_LANG"
189 },
190 "ORDER_STATUS": {
191 "apiValue": "mm6mHOUvo3w3w~Ud",
192 "displayValue": "Pending",
193 "type": "RADIO_BUTTON_GROUP"
194 },
195 "ORDER_TOTAL": {
196 "apiValue": "1231231.0123",
197 "displayValue": "1231231.0123",
198 "type": "INPUT_NUMBER"
199 }
200 },
201 "fieldValuesLang": {
202 "CUSTOMER_NAME": {
203 "type": "INPUT_TEXT_LANG",
204 "langApiValue": { // Значения по всем языкам которые есть в системе
205 "ENG": "Temirlan",
206 "RUS": "Темирлан",
207 "KAZ": "Темірлан",
208 "QAZ": "Temirlan"
209 }
210 }
211 }
212 }
213
214
215