Правила формирования URL запроса

Обращение к стандартному интерфейсу OData выполняется с помощью HTTP-запроса по определенному URL. URL формируется специальным образом и состоит из следующих частей:

1. Адрес информационной базы.
2. Признак обращения к стандартному интерфейсу OData.
3. Имя ресурса, к которому выполняется обращение.
4. Параметры запроса обращения к ресурсу.

Адрес информационной базы – это обычный URL, по которому выполняется доступ, например, к информационной базе с помощью веб-клиента. Например, *http://*localhost/base или http://host.server.zone/data-base. Также необходимо помнить, что при использовании информационной базы, в которой настроено разделение данных, значения разделителей можно указывать только в URL информационной базы. Указание разделителей с помощью параметра Z не поддерживается.

Признак обращения к стандартному интерфейсу Odata – это последовательность символов в URL: /odata/standard.odata.

Имя ресурса, к которому выполняется обращение – это особым образом сформированный идентификатор ресурса (возможно, с параметром) или предопределенные ресурсы. Например, $metadata или Catalog_Контрагент(guid'value').

Параметры обращения к ресурсу. В качестве параметров обращения выступают параметры в виде, принятом для HTTP-запросов: ?ключ=значение&ключ2=значение2.

При обращении к ресурсу могут использоваться специальные ключевые слова, имеющие специальное назначение:

• $format – указывает, в каком формате необходимо получить данные. Если ключевое слово не указано, данные получаются в формате atom-xml:
  • $format=atom – возвращает данные в формате atom-xml;
  • $format=json – возвращает данные в формате json. При обращении к REST-интерфейсу из других внешних платформ для указания того, что данные должны возвращаться в формате json, можно указать MIME-тип application/json в заголовке Accept HTTP-запроса на получение данных.
• $metadata – указывает, что требуется получить описание стандартного интерфейса OData.
• $filter – описывает отбор, применяемый при получении данных (см. раздел «Правила формирования условий отбора»).
• $select – описывает перечень свойств сущности (объектных типов, наборов записей регистров и строк табличных частей объектных типов), которые нужно получить при обращении к стандартному интерфейсу OData.

После того как сформирован URL необходимого ресурса, следует выполнить HTTP-запрос нужного вида. В зависимости от того, какая операция выполняется, используется соответствующий HTTP-метод:

• Получение данных – метод GET. В платформе «1С:Предприятие» этому методу соответствует метод Получить() объекта HTTP-соединение.
• Создание объекта – метод POST. В платформе «1С:Предприятие» этому методу соответствует метод ОтправитьДляОбработки() объекта HTTP-соединение.
• Обновление данных:
  • метод PATCH – в этом случае можно указывать только те свойства сущности, которые необходимо обновить. В платформе «1С:Предприятие» этому методу соответствует метод Изменить() объекта HTTP-соединение;
  • метод PUT – в этом случае необходимо указывать все свойства сущности. В платформе «1С:Предприятие» этому методу соответствует метод Записать() объекта HTTP-соединение.
• Удаление данных – метод DELETE. В платформе «1С:Предприятие» этому методу соответствует метод Удалить() объекта HTTP-соединение.

В результате выполнения запроса клиентское приложение получает ответ сервера, который кроме кода состояния может содержать различные данные, предоставленные сервером, в виде XML- или JSON-документа.