Метод getConfigurationsReport

Экспорт списка конфигураций.

GET /v1/configurations/report

Параметры запроса

Имя Описание Обязательный Тип Пример

displayName

Название конфигурации, которое отображается в пользовательском интерфейсе

Нет

string

Яндекс браузер

description

Описание конфигурации

Нет

string

Браузер от компании Яндекс

category

Категория конфигурации

Нет

string

Сеть

tag

Тэг конфигурации

Нет

string

Браузер

isApplication

Флаг, который определяет, является ли конфигурация приложением для отображения в магазине ПО. Возможные значения: true, false

Нет

string

true

type

Тип конфигурации. Возможные значения: application, package, default

Нет

string

application

createdAtStartDate

Дата создания, начало интервала, включительно

Нет

string($date-time)

2023-08-27T09:37:40.000Z

createdAtEndDate

Дата создания, конец интервала, включительно

Нет

string($date-time)

2023-08-27T09:37:40.000Z

createdBy

Автор создания

Нет

string

vivanov@domain.local

updatedBy

Автор последнего изменения

Нет

string

vivanov@domain.local

showOnlyActive

Флаг отображения неактивных версий конфигураций. Возможные значения: true, false

Нет

boolean

true

_fields

Список столбцов для добавления в отчет. Возможные значения: displayName, defaultVersion, actualVersionId, actualVersionDisplayName, description, createdBy, createdAt, updatedAt

Нет

array[string]

displayName

_titles

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

Нет

array[string]

Заданы все заголовки

Ответы

Код Сообщение Тип данных / объект схемы (DTO) Пример

200

CSV-файл с информацией о конфигурациях

text/csv

 
Название,Автор,Дата создания,Актуальная версия
Ark,petrov@my.domain.ru,2024-03-29T12:21:41.335Z,22.12.3
Яндекс Браузер,ivanov@my.domain.ru,2024-03-29T12:02:32.771Z,23.9.1.1023

400

Incorrect request params (некорректные параметры запроса)

BasicError

 
{
  "code": "validation_failed",
  "message": "getConfigurationsReport.displayName: : size must be between 3 and 256"
}

401

Auth exception (ошибка аутентификации)