Формат запросов в REST API
Точкой входа для доступа к API в нашей системе является url вида:
http(s)://[имя сервера]:[порт базы Mobile SMARTS]/api/v1
Все методы объединены в группы:
/warehouses - склады
/users - пользователи
/usergroups - группы пользователей
/doctypes - типы документов
/docs - документы
/tableinfo - информация о таблицах данных
/tables - таблицы данных
/devices - устройства, работающие с базами
/products - номенклатура
/licenses - лицензии
Также для групп /docs и /tables формируются подгруппы с названием типов документов и таблиц, созданных в конкретной конфигурации, например /docs/ChekKorrekcii.
Формат передачи входящих и исходящих данных - JSON, в кодировке UTF-8. Входящие параметры должны передаваться в теле POST запроса или в виде query-строки(?field=value) для GET запросов. Нужно учитывать, что GET запросы имеют ограничение на длину URL - 2048 символов.
В случае, если указан неверный адрес - возвращается ошибка 404.
В случае возникновения ошибки авторизации, возвращается ошибка 401.
Запросы строятся в формате OData, подробнее можно посмотреть по адресу
http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part2-url-conventions.html
Функции, возвращающие массив значений, поддерживают параметры для порционной загрузки, которые передаются в виде query-строки(?$top=1&$skip=10)
Пример:
https://localhost:9000/api/v1/Docs?$top=5&$skip=10
При выполнении данного запроса мы получим максимум 5 записей начиная с 11 индекса в списке.
Если в запросе на получение списка указать параметр count=true, в результате вернется дополнительно поле count, которое содержит общее число записей в списке на сервере.
Для фильтрации данных в запросе можно указывать параметр $filter, например:
При выполнении данного запросы мы получим список документов, дата изменения которых более указанной в запросе и тип документа - “Заказ”.
Также можно указывать список полей, которые необходимо отобразить в результате, например:
https://localhost:9005/api/v1/Docs?$select=id,tables
Результатом выполнения данного запроса будет список документов, состоящих только из 2-х полей - id и tables
Для получения нужной записи необходимо составить запрос с указанием идентификатора этой записи, например:
https://localhost:9005/api/v1/Docs(‘165’)
Чтобы отсортировать результат необходимо указать параметр $orderby, например:
https://localhost:9005/api/v1/Docs?$orderby=id
В результате получим список документов, отсортированный по идентификатору
Для документов реализован вывод записей строк документа и таблиц документа
Пример:
Если в документе с идентификатором “1” существует таблица “ОплатыВозвраты”, то получить строки таблицы можно отправив запрос:
https://localhost:9000/api/v1/Docs('1')/ОплатыВозвраты
Для получения только строк документа с идентификатором “123” необходимо выполнить запрос
https://localhost:9000/api/v1/Docs('123)/declaredItems
Чтобы отобразить все документы, включая его таблицы со строками, нужно сформировать запрос в таком виде:
https://localhost:9000/api/v1/Docs?$expand=tables($expand=rows)