010
Получение списка инстанций бизнес-объектов
011
012
Предусловие:
013
014
023
024
Запрос (Request):
025
026
027 POST /api/v1/business-object-instance/v2/load-api-bracket-boi-table
028 Content-Type: application/json
029 API-TOKEN/TOKEN: your_token
030
031
032
033
051
052
Входные данные:
053
054
055 {
056 "boCode": "Kод БО",
057 "headCodes": ["Код поля 1", "Код поля 2",...],
058 "orderingFieldCode": "Код поля",
059 "orderState": "DESC",
060 "paging": {
061 "offset": 0, // Начиная с 0
062 "limit": 10, // Получить только 10 элементов
063 },
064 "search": "search_text",
065 "state": "ALL",
066 "touchedFilter": "ALL",
067 "brackets" : [{"...Bracket JSON..."}]
068 }
069
070
071
072
Внимание! Поля с * обязательные к заполнению
073
074
075
076
077 | Атрибут входного JSON |
078 Описание |
079
080
081
082
083
084 | boCode* |
085 Код бизнес-объекта в котором будем искать данные (инстанции).
086 (Как получить boCode?) |
087
088
089
090 | headCodes |
091 Список кодов полей (Как
092 получить Код Поля?), которые будут отображаться в запрашиваемом
093 результате.
094 Если не указывать, то будут присылаться записи с полями,
095 которые указаны в виде "Список" Вашего БО на самой платформе
096 MyBPM. |
097
098
099
100 | orderingFieldCode |
101 Код поля, по которому нужно отсортировать результат.
102 Если не указывать то сортировки не будет. |
103
104
105
106 | orderState |
107 Направление сортировки: ASC - по возрастанию, DESC - по
108 убыванию.
109 Если не указывать то будет сортировка по
110 возрастанию. |
111
112
113
114 | paging*.limit |
115 Лимит указывает, сколько записей или элементов данных вы хотите
116 получить.
117 Если не указывать то будет 0 по умолчанию. |
118
119
120
121 | paging*.offset |
122 Смещение определяет, с какой позиции или записи начнется
123 извлечение данных.
124 Если не указывать то будет 10 по умолчанию. |
125
126
127
128 | search |
129 Это поле для фильтрации данных по переданному значению, то есть
130 получает только те данные, которые содержат переданное значение в
131 себе. |
132
133
134
135 | state |
136 Это поле имеет следующие значения: ALL -
137 Рабочие записи, REMOVED - Удаленные записи,
138 ARCHIVED - Записи в архиве, DEV -
139 Записи используемые для тестирования процессов |
140
141
142
143 | touchedFilter |
144 Это поле имеет следующие значения:
145 TOUCHED_ONLY - Возвращает только прочитанные
146 текущим пользователем инстанции, UNTOUCHED_ONLY -
147 Возвращает не прочитанные текущим пользователем инстанции,
148 ALL - Возвращает все инстанции |
149
150
151
152 | brackets |
153 Бракеты предназначены для составление собственных фильтров. Подробно о бракетах. |
155
156
157
158
159
Ответ (Response):
160
161
HttpStatus: 200 OK
162
163
164 {
165 "boCode": "Customer_Orders", // код БО
166 "businessObjectId": "sclbQ~b8X~EiPQOc", // идентификатор БО
167 "heads": [
168 {
169 "fieldId": "ch7hZhDE0zV2A05G", // идентификатор поля БО
170 "name": "Название", // наименование поля БО
171 "code": "NAME", // код поля БО
172 },
173 // ... и так все запрашиваемые колонки
174 ],
175 "records": [
176 {
177 "instanceId": "0~s8DfBBK6dHY16j", //идентификатор полученной инстанции
178 "values": [
179 {
180 "coFieldId": null, // null, так как это не СО
181 "fieldId": "ch7hZhDE0zV2A05G", // идентификатор поля
182 "value": "Опрос свидетелей", // значение поля
183 "displayValue": "Опрос свидетелей", // отображаемое значение поля
184 "isReadOnly": false // Поле только для чтения
185 },
186 // ... и так по всем запрашиваемым полям
187 ]
188 }
189 // ... и так все запрашиваемые инстанции
190 ],
191 "hasNext": false, // есть ли ещё данные
192 "totalHits": 3, // общее количество зписей
193 "totalHitsMore": false, // есть ли ещё записи
194 "tookInMillis": 3, // сколько времени занял запрос в миллисекундах
195 }
196
197
198