Документация · v1

Creodock API

Все операции
GETИнтерфейс Creodock

Получить: клиентов

Возвращает клиентов. Запрос предназначен для чтения и не изменяет данные.

OpenAPI: Read the client operational overview

GEThttps://api.creodock.com/api/v1/organizations/{organizationId}/clients/{clientId}/overview
Кто вызывает
Интерфейс Creodock
Операция выполняется от имени вошедшего пользователя через защищённую cookie-сессию.
Доступ
Определяется ролью и принадлежностью объекта
Отдельный scope не объявлен в OpenAPI. Сервер проверяет роль и рабочую область.

Что произойдёт

Поведение, которое важно учесть до отправки запроса.

  • Не изменяет данные и подходит для безопасного повторного чтения.
  • Повторный запрос возвращает актуальное состояние ресурса.

Параметры

Где передать значение, обязательно ли оно и откуда его получить.

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
clientIdОбязательно
pathstring · uuid
ID клиента, полученный при создании клиента или в ответе списка клиентов.

Ответы

Все состояния ответа, объявленные этой операцией в OpenAPI.

200

Client overview

application/json

Схема: ClientOverview

{}