010
Загрузка инстанции бизнес-объекта (БО)
011
012
Предусловие:
013
014
023
024
Запрос (Request):
025
026
027 POST /api/v1/boi/load
028 Content-Type: application/json
029 API-TOKEN/TOKEN: your_token
030
031
032
033
051
052
Входные данные:
053
054
055 {
056 "boCode": "Код бизнес-объекта",
057 "boiId": "Идентификатор инстанции бизнес-объекта",
058 "multiLanguage": true / false
059 }
060
061
062
063
064 - Как получить
065 boCode?
066
067 - Как получить
068 boiId?
069
070 - multiLanguage - нужен при работе с мультиязычными полями.
071 Значение по умолчанию
false - значит у этих полей
072 будут отображаться значения на выбранном языке текущего
073 пользователя. При true, вам будет отправляться массив
074 объектов fieldValuesLang, содержащая текст по всем
075 языкам которые есть в системе для всех мультиязычных полей.
076
077
078
Пример:
079
080
081 {
082 "boCode": "Customer_Orders",
083 "boiId": "c7g~8pimNyQD2Nj@",
084 "multiLanguage": true
085 }
086
087
088
089
Ответ (Response):
090
091
092 {
093 "boiId": "Идентификатор инстанции БО",
094 "boCode": "Kод БО",
095 "state": "Одно из значений: ALL, REMOVED, ARCHIVED, DEV",
096 "isTouched": "Прочитано ли текущим пользователем данная инстанция? (true/false)",
097 "fieldValues": {
098 "код поля 1": {
099 "apiValue": "значение поля 1",
100 "displayValue": "значение поля для отображения 1",
101 "type": "Тип поля" // Подробнее о типах поля можете узнать по ссылке ниже
102 },
103 "код поля 2": {
104 "apiValue": "значение поля 2",
105 "displayValue": "значение поля для отображения 2",
106 "type": "Тип поля" // Подробнее о типах поля можете узнать по ссылке ниже
107 },
108 "код поля 3": {
109 "apiValue": "значение поля 3",
110 "displayValue": "значение поля для отображения 3",
111 "type": "Тип поля" // Подробнее о типах поля можете узнать по ссылке ниже
112 }
113 },
114 "fieldValuesLang": {
115 "код поля 4 ": {
116 "type": "тип мультиязычного поля 4",
117 "langApiValue": { // Значения по всем языкам которые есть в системе
118 "Код языка": "Значение мультиязычного поля на этом языке",
119 }
120 },
121 "код поля 5": {
122 "type": "тип мультиязычного поля 5",
123 "langApiValue": { // Значения по всем языкам которые есть в системе
124 "Код языка": "Значение мультиязычного поля на этом языке"
125 }
126 }
127 }
128 }
129
130
131
132
136
137
Значения поля state:
138
139
1) ALL - Рабочее состояние записи
140
141
2) REMOVED - Запись удалена
142
143
3) ARCHIVED - Запись в архиве
144
145
4) DEV - Запись используется для тестирования
146 процессов
147
148
Пример:
149
150
151 {
152 "boiId": "c7g~8pimNyQD2Nj@",
153 "boCode": "Customer_Orders",
154 "state": "ALL",
155 "isTouched": true,
156 "fieldValues": {
157 "ORDER_ID": {
158 "apiValue": "3129891",
159 "displayValue": "3129891",
160 "type": "INPUT_NUMBER"
161 },
162 "ORDER_DATE": {
163 "apiValue": "2023-12-23T20:30:45.123+06",
164 "displayValue": "2023-12-23 20:30",
165 "type": "FULL_DATE"
166 },
167 "CUSTOMER_NAME": {
168 "apiValue": "Temirlan",
169 "displayValue": "Temirlan",
170 "type": "INPUT_TEXT_LANG"
171 },
172 "ORDER_STATUS": {
173 "apiValue": "mm6mHOUvo3w3w~Ud",
174 "displayValue": "Delivered",
175 "type": "RADIO_BUTTON_GROUP"
176 },
177 "ORDER_TOTAL": {
178 "apiValue": "1231231.0123",
179 "displayValue": "1231231.0123",
180 "type": "INPUT_NUMBER"
181 }
182 },
183 "fieldValuesLang": {
184 "CUSTOMER_NAME": {
185 "type": "INPUT_TEXT_LANG",
186 "langApiValue": { // Значения по всем языкам которые есть в системе
187 "ENG": "Temirlan",
188 "RUS": "Темирлан",
189 "KAZ": "Темірлан",
190 "QAZ": "Temirlan"
191 }
192 }
193 }
194 }
195
196
197