ОПИСАНИЕМетод sys.item_list позволяет получить список элементов заданного модуля с применением сортировок по одному из полей и фильтрацией данных. Метод sys.item_get позволяет получить данные отдельного элемента. НЕОБХОДИМОСТЬ АВТОРИЗАЦИИНет. REQUEST | service | + | ami_webservice | | | version | + | 1.1 | | | action | + | sys.item_list | sys.item_get | | | appToken | + | #string | Токен доступа к API | | userToken | | #string | Токен авторизации пользователя | | modId | + | #string | ID Модуля |
Параметры списка | limit | | #integer | 1...2000 | 10 | | offset | | #integer | | 0 | | sortCol | | #string | Поле по которому происходит сортировка | #options | | sortDir | | #string | Направление сортировки (asc/desc) | #options | | getFoundRows | | 1/0 | Возвращать или нет общее количество строк | 0 | | fields[] | | #array | Перечень полей модели | все поля | | filter | | #array | Массив полей для фильтрации в формате JSON (имя поля -> значение) | |
Параметры элемента | itemId | + | #mixed | Id элемента |
RESPONSE (список)| errorCode | #string | Код ошибки, 'OK' в случае успешного выполнения | | errorMessage | #string | Сообщение об ошибке, пустая строка если выполнение прошло без ошибок | | list | #array | Массив данных элементов списка | | listColumns | #array | Массив, описывающий столбцы списка | | listData | #array | Данные списка: число элементов, сортировка и пр. |
RESPONSE (элемент)| errorCode | #string | Код ошибки, 'OK' в случае успешного выполнения | | errorMessage | #string | Сообщение об ошибке, пустая строка если выполнение прошло без ошибок | | item | #array | Массив данных элемента |
ФОРМАТ КЛЮЧЕЙ LIST, LISTCOLUMNS, LISTDATAНа примере списка, имеющего столбцы id, column1, columnN и M элементов. 'list' => array(
0 => array(
'id' => 1,
'column1' => 'Element id=1, column 1 value',
'columnN' => 'Element id=1, column N value',
),
...
M => array(
'id' => Z,
'column1' => 'Element id=Z, column 1 value',
'columnN' => 'Element id=Z, column N value',
),
),
'listColumns' => array(
'id' => array(
'caption' => '',
'format' => 'hidden'
),
'column1' => array(
'caption' => 'Заголовок столбца списка 1',
'format' => 'defined by component'
),
'columnN' => array(
'caption' => 'Заголовок столбца списка N',
'format' => 'defined by component'
)
),
'listData' => array(
'dataCount' => M,
'dataType' => 'array',
'sort' => array(
'col' => 'Поле сортировки',
'dir' => 'Направление сортировки (asc/desc)'
)
)
|
ВОЗМОЖНЫЕ КОДЫ ОШИБОКОбщие коды ошибок Коды ошибок авторизации
|
