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

Creodock API

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

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

Возвращает organization-scoped настройки и значения заказов по умолчанию. Доступно только через пользовательскую сессию с правом изменения настроек.

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

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

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

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

Параметры

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

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

Ответы

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

200

Настройки рабочей области

application/json

Схема: WorkspaceSettings

ПолеТипОписание
availableActionsОбязательно
string[]
Поле «availableActions» в структуре запроса или ответа.
avatarUrlОбязательно
object
Поле «avatarUrl» в структуре запроса или ответа.
currencyОбязательно
string
Трёхбуквенный код валюты ISO 4217.
idОбязательно
string · uuid
Уникальный идентификатор объекта.
nameОбязательно
string
Отображаемое название.
orderDefaultsОбязательно
object
Поле «orderDefaults» в структуре запроса или ответа.
timezoneОбязательно
string
Поле «timezone» в структуре запроса или ответа.
versionОбязательно
integer · int64
Версия объекта для защиты от конфликтующих изменений.
{
  "availableActions": [
    "edit"
  ],
  "currency": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "orderDefaults": {
    "deadlineLocalTime": "string",
    "defaultDeadlineDays": 1,
    "defaultPriority": "low",
    "defaultVerticalId": "00000000-0000-0000-0000-000000000000",
    "defaultWorkTypeId": "00000000-0000-0000-0000-000000000000"
  },
  "timezone": "string",
  "version": 1
}
403

Problem Details response

application/json

Схема: Problem

404

Problem Details response

application/json

Схема: Problem

Ошибки и восстановление

Не только причина, но и конкретное действие для вызывающей стороны.

СтатусЧто означаетПовторЧто делать
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.
404Объект не найден или скрыт правилами доступаНетПроверьте ID и принадлежность рабочей области.

Формат Problem Details

{
  "type": "https://api.creodock.com/problems/invalid-request",
  "title": "Данные не прошли проверку",
  "status": 422,
  "code": "invalid_request",
  "detail": "Проверьте отмеченные поля.",
  "traceId": "req_01J8M4Y6QX",
  "fieldErrors": [
    { "field": "items[0].formats", "code": "required", "message": "Выберите формат." }
  ]
}