Каталоги
Актуальную спецификацию можно скачать и использовать в привычном инструменте.
Перед началом работы
Для работы с API личного кабинета Cloud.ru потребуется:
эндпоинт для запросов — https://organization.api.cloud.ru;
customer_id — его можно скопировать в личном кабинете.
Набор методов для управления каталогами
Получение списка каталогов, удовлетворяющих фильтру.
customer_ids (array) – Фильтр поиска по идентификаторам клиентов.
page_filter.limit (integer) – Количество сущностей на странице.
page_filter.page (integer) – Номер страницы. Нумерация начинается с 1.
organization_unit_ids (array) – Фильтр поиска по идентификаторам каталогов.
200 OK – A successful response.
400 Bad Request – Некорректный запрос
401 Unauthorized – Необходима авторизация
403 Forbidden – Доступ запрещен
404 Not Found – Ресурс не найден
500 Internal Server Error – Внутренняя ошибка сервера
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) – Идентификатор последнего пользователя, обновившего каталог.
Создание каталога.
customer_id (string) – Идентификатор клиента.
description (string) – Описание каталога.
name (string) – Название каталога.
200 OK – A successful response.
400 Bad Request – Некорректный запрос
401 Unauthorized – Необходима авторизация
403 Forbidden – Доступ запрещен
404 Not Found – Ресурс не найден
500 Internal Server Error – Внутренняя ошибка сервера
created_at (string) – Дата создания каталога.
created_by (string) – Идентификатор пользователя, создавшего каталог.
customer_id (string) – Идентификатор клиента.
description (string) – Описание каталога.
id (string) – Идентификатор каталога
name (string) – Название каталога.
updated_at (string) – Дата последнего обновления каталога.
updated_by (string) – Идентификатор последнего пользователя, обновившего каталог.
Получение каталога по id.
id (string) – Идентификатор каталога.
200 OK – A successful response.
400 Bad Request – Некорректный запрос
401 Unauthorized – Необходима авторизация
403 Forbidden – Доступ запрещен
404 Not Found – Ресурс не найден
500 Internal Server Error – Внутренняя ошибка сервера
created_at (string) – Дата создания каталога.
created_by (string) – Идентификатор пользователя, создавшего каталог.
customer_id (string) – Идентификатор клиента.
description (string) – Описание каталога.
id (string) – Идентификатор каталога
name (string) – Название каталога.
updated_at (string) – Дата последнего обновления каталога.
updated_by (string) – Идентификатор последнего пользователя, обновившего каталог.
Удаление каталога по id.
id (string) – Идентификатор каталога.
200 OK – A successful response.
400 Bad Request – Некорректный запрос
401 Unauthorized – Необходима авторизация
403 Forbidden – Доступ запрещен
404 Not Found – Ресурс не найден
500 Internal Server Error – Внутренняя ошибка сервера
- PATCH /v1/organization-unit/{id}
- Parameters
id (string) – Идентификатор каталога.
- Request JSON Object
description (string) – Описание каталога.
name (string) – Название каталога.
- Status Codes
200 OK – A successful response.
400 Bad Request – Некорректный запрос
401 Unauthorized – Необходима авторизация
403 Forbidden – Доступ запрещен
404 Not Found – Ресурс не найден
500 Internal Server Error – Внутренняя ошибка сервера
- Response JSON Object
created_at (string) – Дата создания каталога.
created_by (string) – Идентификатор пользователя, создавшего каталог.
customer_id (string) – Идентификатор клиента.
description (string) – Описание каталога.
id (string) – Идентификатор каталога
name (string) – Название каталога.
updated_at (string) – Дата последнего обновления каталога.
updated_by (string) – Идентификатор последнего пользователя, обновившего каталог.
Обновление каталога по id.
Обновляет каталог по id. Незаполненные поля не обновляются.
- Перед началом работы
- Набор методов для управления каталогами