tocdepth

2

Управление каталогами

Подсказка

Актуальную спецификацию можно скачать и использовать в привычном инструменте.

Перед началом работы

Для работы с API личного кабинета Cloud.ru потребуется:

  • эндпоинт для запросов — https://organization.api.cloud.ru;

  • авторизационный токен;

  • customer_id.

    Войдите в личный кабинет и в URL-адресе найдите customer_id вида 158a64c8-3567-41fe-b2b7-43ad1f176057.

    Он отображается в URL-адресе после наименования сервиса https://organization.api.cloud.ru/projects/324af076...customerId=158a64c8-3567-41fe-b2b7-43ad1f176057.

Набор методов для управления каталогами

GET /v1/organization-unit

Получение списка каталогов, удовлетворяющих фильтру.

Query Parameters
  • customer_ids (array) – Фильтр поиска по идентификаторам клиентов.

  • page_filter.limit (integer) – Количество сущностей на странице.

  • page_filter.page (integer) – Номер страницы. Нумерация начинается с 1.

  • organization_unit_ids (array) – Фильтр поиска по идентификаторам каталогов.

Status Codes
Response JSON Object
  • organization_units (array) – Список каталогов.

  • organization_units[].created_at (string) – Дата создания каталога.

  • organization_units[].created_by (string) – Идентификатор пользователя, создавшего каталог.

  • organization_units[].customer_id (string) – Идентификатор клиента.

  • organization_units[].description (string) – Описание каталога.

  • organization_units[].id (string) – Идентификатор каталога

  • organization_units[].name (string) – Название каталога.

  • organization_units[].updated_at (string) – Дата последнего обновления каталога.

  • organization_units[].updated_by (string) – Идентификатор последнего пользователя, обновившего каталог.

POST /v1/organization-unit

Создание каталога.

Request JSON Object
  • customer_id (string) – Идентификатор клиента.

  • description (string) – Описание каталога.

  • name (string) – Название каталога.

Status Codes
Response JSON Object
  • created_at (string) – Дата создания каталога.

  • created_by (string) – Идентификатор пользователя, создавшего каталог.

  • customer_id (string) – Идентификатор клиента.

  • description (string) – Описание каталога.

  • id (string) – Идентификатор каталога

  • name (string) – Название каталога.

  • updated_at (string) – Дата последнего обновления каталога.

  • updated_by (string) – Идентификатор последнего пользователя, обновившего каталог.

GET /v1/organization-unit/{id}

Получение каталога по id.

Parameters
  • id (string) – Идентификатор каталога.

Status Codes
Response JSON Object
  • created_at (string) – Дата создания каталога.

  • created_by (string) – Идентификатор пользователя, создавшего каталог.

  • customer_id (string) – Идентификатор клиента.

  • description (string) – Описание каталога.

  • id (string) – Идентификатор каталога

  • name (string) – Название каталога.

  • updated_at (string) – Дата последнего обновления каталога.

  • updated_by (string) – Идентификатор последнего пользователя, обновившего каталог.

DELETE /v1/organization-unit/{id}

Удаление каталога по id.

Parameters
  • id (string) – Идентификатор каталога.

Status Codes
PATCH /v1/organization-unit/{id}

Обновление каталога по id.

Обновляет каталог по id. Незаполненные поля не обновляются.

Parameters
  • id (string) – Идентификатор каталога.

Request JSON Object
  • description (string) – Описание каталога.

  • name (string) – Название каталога.

Status Codes
Response JSON Object
  • created_at (string) – Дата создания каталога.

  • created_by (string) – Идентификатор пользователя, создавшего каталог.

  • customer_id (string) – Идентификатор клиента.

  • description (string) – Описание каталога.

  • id (string) – Идентификатор каталога

  • name (string) – Название каталога.

  • updated_at (string) – Дата последнего обновления каталога.

  • updated_by (string) – Идентификатор последнего пользователя, обновившего каталог.

Запустили Evolution free tier
для Dev & Test
Получить