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

Можно написать GET-запрос, который вернет все сущности, созданные на основе одного базового типа.

Формат URL:

Например, чтобы получить всех наследников от OfficialDocument, используйте запрос:

GET /Integration/odata/IOfficialDocuments HTTP/1.1
Host: DirectumRXServer.com
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json
Accept: application/json

Чтобы получить свойство-ссылку базового типа, используйте параметр $expand, например:

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

В ответе для каждой полученной сущности в поле @odata.type будет указан тип конкретной сущности.

{
    "@odata.context": "https://DirectumRXServer.com/odata/$metadata#IOfficialDocuments(Author())",
    "value": [
        {
            "@odata.type": "#Sungero.IntegrationService.Models.Generated.Contracts.IContractDto",
            "Name": "Договор аренды №001-2021 от 12.05.2021 с Рим \"Насос Quattro Elementi Giardino 801 Ci\"",
            "Created": "2021-05-12T09:23:18Z",
            "Modified": "2021-05-12T09:23:20Z",
            "HasRelations": true,
            "LastVersionSignatureType": null,
            "LastVersionApproved": false,
            "HasVersions": true,
            "HasPublicBody": false,
            "VersionsLocked": false,
            "Id": 82,
            ...
            "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
            }
        },
        {
            "@odata.type": "#Sungero.IntegrationService.Models.Generated.Contracts.ISupAgreementDto",
            "Name": "Доп. соглашение №1 от 12.05.2021 к договор аренды №001-2021 с Рим \"График технического обслуживания\"",
            "Created": "2021-05-12T09:24:57Z",
            "Modified": "2021-05-12T10:08:18Z",
            "HasRelations": true,
            "LastVersionSignatureType": null,
            "LastVersionApproved": false,
            "HasVersions": true,
            "HasPublicBody": false,
            "VersionsLocked": false,
            "Id": 83,
            ...
            "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
            }
        },
        {
            "@odata.type": "#Sungero.IntegrationService.Models.Generated.Docflow.ISimpleDocumentDto",
            "Name": "Заметки к совещанию",
            "Created": "2021-05-12T11:28:29Z",
            "Modified": "2021-05-12T11:28:43Z",
            "HasRelations": false,
            "LastVersionSignatureType": null,
            "LastVersionApproved": false,
            "HasVersions": true,
            "HasPublicBody": false,
            "VersionsLocked": false,
            "Id": 87,
            ...
            "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
            }
        }
    ]
}

При обращении к базовым типам можно сразу запросить свойства-ссылки дочерних типов. Например, нужно получить всех наследников от OfficialDocument. Для каждого дочернего типа отобразить значения для свойства-ссылки Автор (Author). А для документов с типом «Договор» (Contract) дополнительно показать значения для свойства-ссылки Подписал (OurSignatory).

Формат URL:

{Протокол https или http}://{имя сервера, на котором установлен сервис интеграции}/{имя сервиса интеграции}/odata/{Интерфейс базового типа сущности во множественном числе}?$expand={Имя свойства-ссылки},Sungero.IntegrationService.Models.Generated.Contracts.{Интерфейс типа сущности с постфиксом Dto}/{Имя свойства-ссылки}

Пример:

GET /Integration/odata/IOfficialDocuments?$expand=Author,Sungero.IntegrationService.Models.Generated.Contracts.IContractDto/OurSignatory HTTP/1.1
Host: DirectumRXServer.com
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json
Accept: application/json

{
    "@odata.context": "https://DirectumRXServer.com/odata/$metadata#IOfficialDocuments(Author(),Sungero.IntegrationService.Models.Generated.Contracts.IContractDto/OurSignatory())",
    "value": [
            "@odata.type": "#Sungero.IntegrationService.Models.Generated.Contracts.IContractDto",
            "Name": "Договор аренды №001-2021 от 12.05.2021 с Рим \"Насос Quattro Elementi Giardino 801 Ci\"",
            "Created": "2021-05-12T09:23:18Z",
            "Modified": "2021-05-12T09:23:20Z",
            "HasRelations": true,
            "LastVersionSignatureType": null,
            "LastVersionApproved": false,
            "HasVersions": true,
            "HasPublicBody": false,
            "VersionsLocked": false,
            "Id": 82,
            ...
            "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
            },
            "OurSignatory": {
                "Sid": "ae92b447-bdce-488c-b6ef-71f80bb668f0",
                "Name": "Новиков Алексей Игоревич",
                "Description": null,
                "IsSystem": null,
                "Status": "Active",
                "Id": 104,
                "PersonalPhotoHash": null,
                "Phone": null,
                "Note": null,
                "Email": null,
                "NeedNotifyExpiredAssignments": false,
                "NeedNotifyNewAssignments": false,
                "PersonnelNumber": null
            }
        }
    ]
}