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