Интеграция с внешними системами > Запросы к сервису интеграции > Получение сущностей

При чтении сущностей сервис интеграции в ответе не передает значения свойств-ссылок. Чтобы их получить, используйте параметр $expand. Такое поведение сделано для соответствия спецификации OData и чтобы не утяжелять запросы.

Формат URL:

{Протокол https или http}://{имя сервера, на котором установлен сервис интеграции}/{имя сервиса интеграции}/odata/{Интерфейс типа сущности во множественном числе}?$expand={Имя свойства-ссылки 1},{Имя свойства-ссылки 2}...

Пример

Чтобы получить список всех простых документов (SimpleDocument) со свойствами-ссылками Автор (Author) и Вид документа (DocumentKind), используйте GET-запрос:

GET /Integration/odata/ISimpleDocuments?$expand=Author,DocumentKind HTTP/1.1
Host: DirectumRXServer.com
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json
Accept: application/json

В ответе придет список сущностей с указанными свойствами-ссылками.

{
    "@odata.context": "https://DirectumRXServer.com/odata/$metadata#ISimpleDocuments(Author(),DocumentKind())",
    "value": [
        {
            "Name": "Презентация к летучке отдела продаж",
            "Created": "2021-05-11T13:54:13Z",
            "Modified": "2021-05-12T15:59:49Z",
            "HasRelations": false,
            "LastVersionSignatureType": null,
            "LastVersionApproved": false,
            "HasVersions": true,
            "HasPublicBody": false,
            "VersionsLocked": false,
            "Id": 79,
            ...
            "Author": {
                "@odata.type": "#Sungero.IntegrationService.Models.Generated.Company.IEmployeeDto",
                "Sid": "506c9866-51f9-42d4-b245-fbcf184441d5",
                "Name": "Ардо Наталья Михайловна",
                "Description": null,
                "IsSystem": null,
                "Status": "Active",
                "Id": 105,
                "PersonalPhotoHash": "8916804d46554a2b0a8cb27adcb7e4c5",
                "Phone": "55-40-55",
                "Note": null,
                "Email": "Ardo_NM@technosystem.ru",
                "NeedNotifyExpiredAssignments": false,
                "NeedNotifyNewAssignments": false,
                "PersonnelNumber": null
            },
            "DocumentKind": {
                "Name": "Простой документ",
                "Note": null,
                "DeadlineInDays": null,
                "ShortName": "Простой документ",
                "DeadlineInHours": null,
                "GenerateDocumentName": false,
                "AutoNumbering": false,
                "ProjectsAccounting": false,
                "GrantRightsToProject": false,
                "IsDefault": true,
                "Code": null,
                "DocumentFlow": "Inner",
                "NumberingType": "NotNumerable",
                "Status": "Active",
                "Id": 1
            }
        }
    ]
}

Чтобы получить конкретную сущность по идентификатору и ее свойства-ссылки, используйте GET-запрос с URL в формате:

{Протокол https или http}://{имя сервера, на котором установлен сервис интеграции}/{имя сервиса интеграции}/odata/{Интерфейс типа сущности во множественном числе}(ИД)?$expand={Имя свойства-ссылки 1},{Имя свойства-ссылки 2}...

Пример:

GET /Integration/odata/ISimpleDocuments(79)?$expand=Author,DocumentKind HTTP/1.1
Host: DirectumRXServer.com
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json
Accept: application/json

Чтение свойства-ссылки

Чтение свойства-ссылки