Большая инструкция по работе с интерфейсом OData

30 мая 2020

Большая инструкция по работе с интерфейсом OData

Начиная с версии 8.3.5 1С Предприятие умеет генерировать REST интерфейс для всей конфигурации, используя протокол OData. Это значит, что стороннее приложение может получить доступ ко всей базе 1С буквально за пару кликов.

Базы данных, которые размещаются на Платформе42, поддерживаются автоматическим REST-сервисом по протоколу OData версии 3.0. И мы подготовили для вас большую инструкцию – знакомство с OData. Чтобы не пугать вас «простыней», мы разбили ее на 11 блоков. В этой статье вы найдете краткие обзоры блоков и ссылки на подробную информацию.

1

Возможности и настройка

https://42clouds.com/ru-ru/manuals/interfeys-odata-vozmozhnosti-i-nastroyka.html

Из этой инструкции вы получите общее представление об интерфейсе OData. Тут мы рассказываем об основных возможностях протокола и о том, как настроить автоматический REST-сервис для запроса и обновления данных. Если хотите познакомиться и узнать, какие задачи можно решить при помощи OData – вам сюда.

2

Общие принципы работы

https://42clouds.com/ru-ru/manuals/interfeys-odata-obshchie-printsipy-raboty.html

Здесь мы разбираем специальную терминологию OData. Рассмотрим в отдельности каждый термин из тех, которыми будем оперировать в дальнейшем, узнаем, как выполнить обращение к стандартному интерфейсу OData и подробно разберем верный URL-запрос.

3

Представление данных

https://42clouds.com/ru-ru/manuals/interfeys-odata-predstavlenie-dannykh.html

В этой инструкции посмотрим, в каком виде стандартный интерфейс OData возвращает данные, и взглянем на соответствие между типом данных «1С:Предприятия» и типом OData. И отдельно разберем различные суффиксы, на которые могут оканчиваться имена свойств.

4

Правила формирования имени ресурса

https://42clouds.com/ru-ru/manuals/interfeys-odata-pravila-formirovaniya-imeni-resursa.html

Из этого текста вы узнаете, по какому принципу формируется идентификатор имени ресурса, к каким объектам можно получить доступ при помощи стандартного интерфейса OData и как уточняется имя ресурса при помощи суффикса. Возможные виды суффиксов тоже разберем.

5

Правила формирования условия отбора

https://42clouds.com/ru-ru/manuals/interfeys-odata-pravila-formirovaniya-usloviya-otbora.html

В данном разделе мы приводим информации по различным способам формирования отбора получаемых данных, которые используются в стандартном интерфейсе OData системы «1С:Предприятие». Инструкция большая и детальная, советуем ознакомиться «с чувством, с толком, с расстановкой».

6

Параметры запроса

https://42clouds.com/ru-ru/manuals/interfeys-odata-parametry-zaprosa.html

Здесь рассматриваем четыре основных параметра запроса: $count, $inlinecount, $orderby и $expand. Узнаем, что они позволяют сделать, как их правильно использовать и какие подводные камни могут встретиться на пути погружения в тему.

7

Способы получения описания стандартного интерфейса OData

https://42clouds.com/ru-ru/manuals/interfeys-odata-sposoby-polucheniya-opisaniya-standartnogo-interfeysa-odata.html

Рассказываем при помощи каких GET-запросов можно получить сокращенное и полное описания стандартного интерфейса OData. Расскажем, каким образом формировать параметр $format при выполнении запроса, если данные получены в формате json.

8

Способы получения данных

https://42clouds.com/ru-ru/manuals/interfeys-odata-sposoby-polucheniya-dannykh.html

А в этой инструкции расскажем, как получать и списки сущностей, и сами сущности. Эти способы получения данных отличаются URL, по которому происходит обращение к данным. Вы узнаете, чем отличается URL набора сущностей от канонического URL экземпляра сущности.

9

Выполнение функций и действий

https://42clouds.com/ru-ru/manuals/interfeys-odata-vypolnenie-funktsiy-i-deystviy.html

Посмотрим, как формируется URL ресурса, если с сущностью или с набором сущностей связана функция (например, работа с виртуальными таблицами регистров выполняется именно через функции).

10

Ошибочные ситуации

https://42clouds.com/ru-ru/manuals/interfeys-odata-oshibochnye-situatsii.html

Вот мы и подошли к самому интересному – к кодам ошибок, их описанию. Посмотрим, как происходит информирование об ошибках со стороны клиентского приложения и об ошибках со стороны сервера, какие коды назначаются и что с этим делать.

11

Примеры типовых операций

https://42clouds.com/ru-ru/manuals/interfeys-odata-primery-tipovykh-operatsiy.html

И немного практики напоследок. Рассмотрим несколько типовых операций в их практическом применении. Пошагово разберем работу с одним объектом, работу с планами обмена и другие вещи, с которыми вам наверняка придется столкнуться.

Чтобы иметь полное представление о стандартном интерфейсе OData, ознакомьтесь со всеми представленными выше инструкциями. Или сохраняйте в закладки, чтобы обращаться к этому тексту по мере необходимости.

1С онлайн

Аренда 1С или загрузка своей базы

Аренда 1С или загрузка своей базы

Обновления 1С включены в стоимость

Обновления 1С включены в стоимость

Ежедневное  резервное копирование баз

Ежедневное резервное копирование баз

Консультации по 1С и 24/7 техподдержка

Консультации по 1С и 24/7 техподдержка

Попробовать бесплатно

Сервисы 1С для работы с маркетплейсами