Интерфейс OData: правила формирования имени ресурса
При обращении к какому-либо ресурсу, его идентификатор формируется по следующему принципу:
ПрефиксИмени_ИмяОбъектаКонфигурации_СуффиксИмени. С помощью стандартного интерфейса OData можно получить доступ к следующим объектам (ПрефиксИмени):
| Объект конфигурации | Префикс имени для указания в URL |
|---|---|
|
Справочник |
Catalog |
|
Документ |
Document |
|
Журнал документов |
DocumentJournal |
|
Константа |
Constant |
|
План обмена |
ExchangePlan |
|
План счетов |
ChartOfAccounts |
|
План видов расчета |
ChartOfCalculationTypes |
|
План видов характеристик |
ChartOfCharacteristicTypes |
|
Регистр сведений |
InformationRegister |
|
Регистр накопления |
AccumulationRegister |
|
Регистр расчета |
CalculationRegister |
|
Регистр бухгалтерии |
AccountingRegister |
|
Бизнес-процесс |
BusinessProcess |
|
Задача |
Task |
ИмяОбъектаКонфигурации – свойство Имя объекта конфигурации, как оно задано при разработке прикладного решения в конфигураторе.
СуффиксИмени – предназначено для уточнения имени ресурса и является необязательной частью имени. В качестве суффикса имени могут выступать следующие выражения:
- Имя табличной части объекта;
- Имя реквизита табличной части или набора записей;
- Имя виртуальной таблицы регистра;
- RowType;
- RecordType;
Далее будут более подробно рассмотрены вышеописанные уточнения имени ресурса:
Имя табличной части объекта
Если объект обладает табличной частью, то для получения доступа ко всем записям этой табличной части необходимо добавить имя табличной части после имени самого объекта, например, для получения всех строк табличных частей Товары всех документов РасходТовара будет необходимо выполнить GET-запрос по следующему адресу: https://host/base/zone/odata/standard.odata/Document_РасходТовара_Товары.
Имя реквизита табличной части или набора записей
Если объект обладает табличной частью, то имеется возможность указать, что требуется получение не всех реквизитов табличной части, а некоторого списка этих реквизитов. Для этого необходимо указать в параметре $select список требуемых реквизитов в следующем виде: <Имя табличной части>/<Имя поля>. Аналогичная возможность предоставляется для наборов записей регистров, где в качестве имени табличной части выступает RecordSet: RecordSet/<Имя поля>.
Имя виртуальной таблицы регистра
В роли виртуальной таблицы регистра выступает функция, связанная с ресурсом, возвращающей набор сущностей регистра. Имя функции совпадает с английским вариантом имени используемой виртуальной таблицы языка запросов. Параметры функции соответствуют параметрам виртуальной таблицы. Так, для получения среза последних регистра сведений КурсыВалют, следует выполнить GET-запрос по следующему адресу: https://host/base/zone/odata/standard.odata/InformationRegister_КурсыВалют/SliceLast().
RowType
Сущность с таким суффиксом описывает тип строки табличной части какого-либо объекта.
RecordType
Сущность с таким суффиксом описывает отдельную запись регистра.
