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

Creodock API

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

Получить список: материалы

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

OpenAPI: List workspace material folders and files

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

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

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

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

Параметры

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

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
folderIdНеобязательно
querystring · uuid
Параметр фильтрации или управления выдачей: folderId.
scopeНеобязательно
queryMaterialScope
Параметр фильтрации или управления выдачей: scope.Допустимо: all, trashПример: all
qНеобязательно
querystring
Параметр фильтрации или управления выдачей: q.Максимальная длина: 240
sortНеобязательно
queryMaterialSort
Параметр фильтрации или управления выдачей: sort.Допустимо: name_asc, name_desc, updated_desc, updated_asc, size_descПример: name_asc
cursorНеобязательно
querystring
Непрозрачный курсор следующей страницы из предыдущего ответа.

Ответы

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

200

Material explorer page

application/json

Схема: MaterialExplorerResponse

ПолеТипОписание
availableActionsНеобязательно
string[]
Поле «availableActions» в структуре запроса или ответа.
filesОбязательно
MaterialFile[]
Поле «files» в структуре запроса или ответа.
folderIdНеобязательно
object
Поле «folderId» в структуре запроса или ответа.
foldersОбязательно
MaterialFolder[]
Поле «folders» в структуре запроса или ответа.
nextCursorНеобязательно
object
Непрозрачный курсор следующей страницы; отсутствует на последней странице.
pathОбязательно
Option[]
Поле «path» в структуре запроса или ответа.
quotaНеобязательно
object
Поле «quota» в структуре запроса или ответа.
scopeОбязательно
MaterialScope
Поле «scope» в структуре запроса или ответа.Допустимо: all, trashПример: all
totalОбязательно
integer
Поле «total» в структуре запроса или ответа.
treeОбязательно
Option[]
Поле «tree» в структуре запроса или ответа.
{
  "availableActions": [
    "upload"
  ],
  "files": [
    {
      "availableActions": [
        "open"
      ],
      "byteSize": 1,
      "createdAt": "2026-09-05T12:00:00Z",
      "folderId": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "kind": "string",
      "mimeType": "string",
      "name": "string",
      "path": "string",
      "previewKind": "image",
      "scanStatus": "pending",
      "updatedAt": "2026-09-05T12:00:00Z",
      "uploadedBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      }
    }
  ],
  "folderId": "00000000-0000-0000-0000-000000000000",
  "folders": [
    {
      "availableActions": [
        "open"
      ],
      "id": "00000000-0000-0000-0000-000000000000",
      "kind": "string",
      "name": "string",
      "parentId": "00000000-0000-0000-0000-000000000000",
      "updatedAt": "2026-09-05T12:00:00Z"
    }
  ],
  "path": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string"
    }
  ],
  "quota": {},
  "scope": "all",
  "total": 1,
  "tree": [
    {
      "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": "Выберите формат." }
  ]
}