Здесь показаны различия между выбранной ревизией и текущей версией данной страницы.
ru:technical_manual:work_via_odata [2024/05/02 16:48] admin [Включение OData в Bussiness Studio] |
ru:technical_manual:work_via_odata [2024/05/03 07:53] (текущий) admin |
||
---|---|---|---|
Строка 3: | Строка 3: | ||
Доступ к данным посредством OData можно использовать, например: | Доступ к данным посредством OData можно использовать, например: | ||
* для загрузки и выгрузки данных; | * для загрузки и выгрузки данных; | ||
- | * для интеграции со сторонними информационными системами. | + | * для интеграции со сторонними информационными системами. |
===== Включение OData в Bussiness Studio ===== | ===== Включение OData в Bussiness Studio ===== | ||
Строка 19: | Строка 19: | ||
$select, $expand, $filter, $orderby, $skip, $top, $apply.\\ Примеры: | $select, $expand, $filter, $orderby, $skip, $top, $apply.\\ Примеры: | ||
- Получение списка объектов справочника «Физические лица» (здесь и далее в скобках указывается системное название, в данном случае - AppPlatform.Person): \\ [[http://localhost:9000/API/v1/OData/AppPlatform.Person]] | - Получение списка объектов справочника «Физические лица» (здесь и далее в скобках указывается системное название, в данном случае - AppPlatform.Person): \\ [[http://localhost:9000/API/v1/OData/AppPlatform.Person]] | ||
- | - Получение данных конкретного объекта из справочника «Физические лица» (AppPlatform.Person): \\ [[http://localhost:9000/API/v1/OData/AppPlatform.Person('0x00101400000000000000000000000000000000000000000000000000000001']]) | + | - Получение данных конкретного объекта из справочника «Физические лица» (AppPlatform.Person): \\ [[http://localhost:9000/API/v1/OData/AppPlatform.Person('0x00101400000000000000000000000000000000000000000000000000000001')]] |
- Выбор нужных не объектных полей Название (Name) и Дата рождения (DateOfBirth) из справочника «Физические лица» (AppPlatform.Person): \\ [[http://localhost:9000/API/v1/OData/AppPlatform.Person?$select=Name,DateOfBirth]] | - Выбор нужных не объектных полей Название (Name) и Дата рождения (DateOfBirth) из справочника «Физические лица» (AppPlatform.Person): \\ [[http://localhost:9000/API/v1/OData/AppPlatform.Person?$select=Name,DateOfBirth]] | ||
- Выбор нужных объектных полей из справочника «Физические лица» (AppPlatform.Person) Contacts: \\ [[http://localhost:9000/API/v1/OData/AppPlatform.Person?$expand=Contacts]] | - Выбор нужных объектных полей из справочника «Физические лица» (AppPlatform.Person) Contacts: \\ [[http://localhost:9000/API/v1/OData/AppPlatform.Person?$expand=Contacts]] | ||
Строка 32: | Строка 32: | ||
==== POST – создание данных ==== | ==== POST – создание данных ==== | ||
Пример: | Пример: | ||
- | - Добавление нового объекта «Иванов Иван Иванович» в справочник «Физические лица» (AppPlatform.Person): \\ POST [[http://localhost:9000/API/v1/OData/AppPlatform.Person]] \\ | + | - Добавление нового объекта «Иванов Иван Иванович» в справочник «Физические лица» (AppPlatform.Person): \\ POST %%http://localhost:9000/API/v1/OData/AppPlatform.Person%% \\ |
В теле запроса в JSON указываются поля для заполнения нового объекта: | В теле запроса в JSON указываются поля для заполнения нового объекта: | ||
[{{ ru/technical_manual/work_via_odata/lang_work_via_odata_01.png?nolink |Рисунок 1. В теле ответа возвращается созданный объект}}] \\ | [{{ ru/technical_manual/work_via_odata/lang_work_via_odata_01.png?nolink |Рисунок 1. В теле ответа возвращается созданный объект}}] \\ | ||
Строка 51: | Строка 51: | ||
==== PATCH – обновление данных ==== | ==== PATCH – обновление данных ==== | ||
Пример: | Пример: | ||
- | - Изменение наименования объекта (Name) на «Иванов Иван Александрович» в справочнике «Физические лица» (AppPlatform.Person) у ранее добавленного «Иванов Иван Иванович»: \\ PATCH [[http://localhost:9000/API/v1/OData/AppPlatform.Person('0x0010140000000000000000000000000000000000000000000000000000003D')]] \\ | + | - Изменение наименования объекта (Name) на «Иванов Иван Александрович» в справочнике «Физические лица» (AppPlatform.Person) у ранее добавленного «Иванов Иван Иванович»: \\ PATCH %%http://localhost:9000/API/v1/OData/AppPlatform.Person%%('0x0010140000000000000000000000000000000000000000000000000000003D') \\ |
В теле запроса в JSON указываются поля, которые нужно изменить в объекте.\\ | В теле запроса в JSON указываются поля, которые нужно изменить в объекте.\\ | ||
[{{ ru/technical_manual/work_via_odata/lang_work_via_odata_03.png?nolink }}] | [{{ ru/technical_manual/work_via_odata/lang_work_via_odata_03.png?nolink }}] | ||
Строка 57: | Строка 57: | ||
==== DELETE – удаление данных ==== | ==== DELETE – удаление данных ==== | ||
Пример: | Пример: | ||
- | - Удаление объекта физлица «Иванов Иван Александрович»: \\ DELETE [[http://localhost:9000/API/v1/OData/AppPlatform.Person('0x0010140000000000000000000000000000000000000000000000000000003D')]] \\ | + | - Удаление объекта физлица «Иванов Иван Александрович»: \\ DELETE %%http://localhost:9000/API/v1/OData/AppPlatform.Person('0x0010140000000000000000000000000000000000000000000000000000003D')%% \\ |
[{{ ru/technical_manual/work_via_odata/lang_work_via_odata_05.png?nolink }}] \\ | [{{ ru/technical_manual/work_via_odata/lang_work_via_odata_05.png?nolink }}] \\ | ||
В результате возвращается серверное сообщение «204 no content» и объект удаляется, либо появляется текст ошибки в теле ответа. | В результате возвращается серверное сообщение «204 no content» и объект удаляется, либо появляется текст ошибки в теле ответа. | ||
- |