Используйте в запросе параметр $filter, чтобы фильтровать результаты запроса по условию фильтрации. Условие описывается с помощью операторов и функций.

Формат URL:

{Протокол https или http}://{имя сервера, на котором установлен сервис интеграции}/{имя сервиса интеграции}/odata/{Интерфейс типа сущности во множественном числе}?$filter={Имя свойства} {Оператор сравнения} {Значение}

Пример:

GET /Integration/odata/ISimpleDocuments?$filter=HasVersions eq false HTTP/1.1
Host: DirectumRXServer.com
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json
Accept: application/json

В ответе придет список всех простых документов (SimpleDocument), у которых нет версий:

Ответ сервиса интеграции

{

    "@odata.context": "https://DirectumRXServer.com/odata/$metadata#ISimpleDocuments",
    "value": [
        {
            "Id": 188,
            "Name": "Черновик",
            "LastVersionApproved": false,
            "LastVersionSignatureType": null,
            "HasRelations": false,
            "HasVersions": false,
            "VersionsLocked": false,
            "HasPublicBody": false,
            ...
        },
        ...
    ]
}

Пример кода для создания аналогичного запроса, написанного на языке C# с использованием библиотеки Simple.OData.Client:

// URL сервиса интеграции.

private const string IntegrationServiceUrl = "https://DirectumRXServer.com/Integration/odata/";
// Логин для Basic-аутентификации.
private const string Login = "IntegrationUser";
// Пароль для Basic-аутентификации.
private const string Password = "11111";
 
// Настройки Simple OData Client: добавление URL сервиса и заголовка 
// с данными аутентификации ко всем запросам.
var odataClientSettings = new ODataClientSettings(new Uri(IntegrationServiceUrl));
odataClientSettings.BeforeRequest += (HttpRequestMessage message) =>
{
  var authenticationHeaderValue = Convert.ToBase64String(Encoding.UTF8.GetBytes($"{Login}:{Password}"));
  message.Headers.Add("Authorization", "Basic" + authenticationHeaderValue);
};
var odataClient = new ODataClient(odataClientSettings);
// Создание запроса.
var document = await odataClient.For("ISimpleDocuments")
  .Filter("HasVersions eq false")
  .FindEntriesAsync();

Операторы

Функции

Кроме операторов, можно использовать встроенные функции для фильтрации. Функции обрабатывают строки, числа и даты, а также округляют числа.

Формат URL:

{Протокол https или http}://{имя сервера, на котором установлен сервис интеграции}/{имя сервиса интеграции}/odata/{Интерфейс типа сущности во множественном числе}?$filter={Функция}({Условие})

Пример:

GET /Integration/odata/ISimpleDocuments?$filter=contains(Name,'Инструкция') HTTP/1.1
Host: DirectumRXServer.com
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json
Accept: application/json

В ответе придет список всех простых документов, в названии которых есть слово «Инструкция».

Пример кода для создания аналогичного запроса, написанного на языке C# с использованием библиотеки Simple.OData.Client:

// URL сервиса интеграции.

private const string IntegrationServiceUrl = "https://DirectumRXServer.com/Integration/odata/";
// Логин для Basic-аутентификации.
private const string Login = "IntegrationUser";
// Пароль для Basic-аутентификации.
private const string Password = "11111";
 
// Настройки Simple OData Client: добавление URL сервиса и заголовка 
// с данными аутентификации ко всем запросам.
var odataClientSettings = new ODataClientSettings(new Uri(IntegrationServiceUrl));
odataClientSettings.BeforeRequest += (HttpRequestMessage message) =>
{
  var authenticationHeaderValue = Convert.ToBase64String(Encoding.UTF8.GetBytes($"{Login}:{Password}"));
  message.Headers.Add("Authorization", "Basic" + authenticationHeaderValue);
};
var odataClient = new ODataClient(odataClientSettings);
 
// Создание запроса c $filter=contains(Name,'Инструкция')
var document = await odataClient.For("ISimpleDocuments")
  .Filter("contains(Name, 'Инструкция')")
  .FindEntriesAsync();

Условия в запросах можно комбинировать при помощи логических операторов and и or. Например, чтобы получить список всех простых документов, у которых есть версии и свойство Идентификатор (Id) в которых больше 100, используйте запрос:

GET /Integration/odata/ISimpleDocuments?$filter=HasVersions eq true and Id gt 100 HTTP/1.1
Host: DirectumRXServer.com
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json
Accept: application/json

Пример кода для создания аналогичного запроса, написанного на языке C# с использованием библиотеки Simple.OData.Client:

// URL сервиса интеграции.

private const string IntegrationServiceUrl = "https://DirectumRXServer.com/Integration/odata/";
// Логин для Basic-аутентификации.
private const string Login = "IntegrationUser";
// Пароль для Basic-аутентификации.
private const string Password = "11111";
 
// Настройки Simple OData Client: добавление URL сервиса и заголовка 
// с данными аутентификации ко всем запросам.
var odataClientSettings = new ODataClientSettings(new Uri(IntegrationServiceUrl));
odataClientSettings.BeforeRequest += (HttpRequestMessage message) =>
{
  var authenticationHeaderValue = Convert.ToBase64String(Encoding.UTF8.GetBytes($"{Login}:{Password}"));
  message.Headers.Add("Authorization", "Basic" + authenticationHeaderValue);
};
var odataClient = new ODataClient(odataClientSettings);
 
// Создание запроса.
var document = await odataClient.For("ISimpleDocuments")
  .Filter("HasVersions eq true and Id gt 100")
  .FindEntriesAsync();