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

Creodock API

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

Получить список: доску заказов

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

OpenAPI: Read the first page of every manager Kanban stage

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

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

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

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

Параметры

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

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
directionIdНеобязательно
querystring · uuid
Параметр фильтрации или управления выдачей: directionId.
qНеобязательно
querystring
Параметр фильтрации или управления выдачей: q.Максимальная длина: 240
clientIdНеобязательно
querystring · uuid
ID клиента, полученный при создании клиента или в ответе списка клиентов.
assigneeIdНеобязательно
querystring · uuid
Параметр фильтрации или управления выдачей: assigneeId.
workTypeIdНеобязательно
querystring · uuid
Параметр фильтрации или управления выдачей: workTypeId.
priorityНеобязательно
queryTaskPriority
Параметр фильтрации или управления выдачей: priority.Допустимо: low, medium, highПример: low
sortНеобязательно
queryQueueSort
Параметр фильтрации или управления выдачей: sort.Допустимо: attention, deadline_asc, deadline_desc, created_descПример: attention

Ответы

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

200

Filtered Kanban columns

application/json

Схема: KanbanResponse

ПолеТипОписание
columnsОбязательно
KanbanColumnPage[]
Поле «columns» в структуре запроса или ответа.
filtersОбязательно
QueueFilters
Поле «filters» в структуре запроса или ответа.
{
  "columns": [
    {
      "data": [
        {}
      ],
      "stage": "awaiting_payment",
      "total": 1
    }
  ],
  "filters": {
    "assignees": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      }
    ],
    "clients": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      }
    ],
    "workTypes": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      }
    ]
  }
}
401

Problem Details response

application/json

Схема: Problem

403

Problem Details response

application/json

Схема: Problem

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

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

СтатусЧто означаетПовторЧто делать
401Нет действующей авторизацииПосле авторизацииПроверьте ключ или пользовательскую сессию.
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.

Формат 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": "Выберите формат." }
  ]
}