Получить корневые контейнеры

Отдает корневые контейнеры. Если передать id подключения к каталогу, то отдает корневые контейнеры каталога

Request

GET

https://corp.browser.yandex.ru/browser/public/api/browser-management/containers/root

Query parameters

Name	Description
catalog_connection_id	Type: string Уникальный идентификатор подключения к каталогу Example: ``
order_by	Type: string Параметр сортировки данных (доступные значения - id, name), по умолчанию id Example: ``
skip	Type: string Количество записей, которое будет пропущено перед формированием ответа Example: ``
sort_order	Type: string Порядок сортировки (asc - по возрастанию, desc - по убыванию), по умолчанию asc Default: `asc` Enum: `asc`, `desc`
take	Type: string Целое положительное число, обозначающее количество объектов в ответе. Максимум 1000. По умолчанию 1000 Example: ``

Responses

200 OK

Body

application/json

{
  "containerList": [
    {
      "id": "example",
      "name": "example",
      "description": "example",
      "createdAt": "example",
      "partnerId": "example",
      "profileId": "example",
      "hasNestedContainers": true,
      "parentId": "example",
      "catalogConnectionId": "example"
    }
  ]
}

Name

Description

containerList

Type: ExtendedContainer[]

список контейнеров

Example

[
  {
    "id": "example",
    "name": "example",
    "description": "example",
    "createdAt": "example",
    "partnerId": "example",
    "profileId": "example",
    "hasNestedContainers": true,
    "parentId": "example",
    "catalogConnectionId": "example"
  }
]

ContainerId

Уникальный идентификатор контейнера

Type: string

Example: example

PartnerId

Уникальный идентификатор партнера

Type: string

Example: example

ProfileId

Уникальный идентификатор профиля

Type: string

Example: example

Container

Объект контейнера

Name	Description
createdAt	Type: string Timestamp даты создания контейнера Example: `example`
hasNestedContainers	Type: boolean Есть ли у контейнера вложенные контейнеры
id	Type: ContainerId Уникальный идентификатор контейнера Example: `example`
name	Type: string Имя контейнера Example: `example`
partnerId	Type: PartnerId Уникальный идентификатор партнера Example: `example`
profileId	Type: ProfileId \| null Уникальный идентификатор профиля Example: `example`
description	Type: string Описание контейнера Example: `example`

Example

{
  "id": "example",
  "name": "example",
  "description": "example",
  "createdAt": "example",
  "partnerId": "example",
  "profileId": "example",
  "hasNestedContainers": true
}

CatalogConnectionId

Уникальный идентификатор подключения к каталогу

Type: string

Example: example

ExtendedContainer

All of 2 types

Type: Container

Объект контейнера

Example

{
  "id": "example",
  "name": "example",
  "description": "example",
  "createdAt": "example",
  "partnerId": "example",
  "profileId": "example",
  "hasNestedContainers": true
}

Type: object

catalogConnectionId

Type: CatalogConnectionId | null

Уникальный идентификатор подключения к каталогу

Example: example

parentId

Type: string | null

Уникальный идентификатор родителя контейнера

Example: example

Расширенный объект контейнера

Example

{
  "parentId": "example",
  "catalogConnectionId": "example"
}

Example

{
  "id": "example",
  "name": "example",
  "description": "example",
  "createdAt": "example",
  "partnerId": "example",
  "profileId": "example",
  "hasNestedContainers": true,
  "parentId": "example",
  "catalogConnectionId": "example"
}

404 Not Found

У партнера не найдено подключение к каталогу с catalog_connection_id (NO_CATALOG_CONNECTION_FOUND)

Была ли статья полезна?

Список ресурсов

Получить все контейнеры до корня, включая уровень с запрашиваемым контейнером