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

Организации

Списки организаций и записи управляемых организаций.

Автоматически переведено с английского. Смотреть оригинал на английском

Песочница

Отправьте эти запросы на свою работающую сайдкар. Значения остаются в этом браузере.

Не подключено

Базовый URL Токен на предъявителя необязательный Токен сеанса необязательный

Как это работает

Сайдкар прослушивает порт обратной связи, выбранный при запуске, и печатает его в своем ready линия; используйте этот URL-адрес и CADCAMFUN_TOKEN с этого началось. Запросы идут прямо с этой страницы на этот адрес.

Sidecar отправляет заголовки CORS только источникам Tauri и http://localhost или http://127.0.0.1 в любом порту. Из размещенных документов браузер блокирует ответ, поэтому запускайте документы локально (bun run dev в packages/web), чтобы использовать игровую площадку, или скопируйте запрос как завиток. Чтобы поэкспериментировать, не затрагивая реальные данные, запустите сайдкар с помощью CADCAMFUN_DATA_DIR указал на одноразовый каталог — см. пошаговое руководство по API.

Операции

5 endpoint в organizations группа, созданная на основе собственной сайдкара документ OpenAPI. Защищенные операции занимают Authorization: Bearer $CADCAMFUN_TOKEN; видеть аутентификация. Поведение и ограничения находятся в руководство по подсистеме.

получать	/api/organizations	organizations.list
почта	/api/organizations	organizations.create
получать	/api/organizations/{id}	organizations.get
помещать	/api/organizations/{id}	organizations.update
удалить	/api/organizations/{id}	organizations.remove

Деятельность организаций в 3D Перетащите на орбиту · прокрутите, чтобы увеличить · перетащите вправо, чтобы панорамировать

Один блок на операцию (5), сгруппированный в каждом разделе ресурсов на этой странице и окрашенный в зависимости от метода: зеленый GET, оранжевый POST, синий PUT, фиолетовый PATCH, красный DELETE. Создается из документа OpenAPI во время сборки.

/api/organizations

получать /api/organizations # organizations.list

Требует Authorization: Bearer <token>.

Ответы

200 Массив<объект> application/json

Array<{
  id: string
  name: string
  description: string | null
  createdAt: string
  updatedAt: string
  role: "ADMIN" | "MANAGER" | "MEMBER"
  userCount: number | "Infinity" | "-Infinity" | "NaN"
  projectCount: number | "Infinity" | "-Infinity" | "NaN"
}>

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример ответа пойман · 200

ПОЛУЧИТЬ /api/организации

[]

Пример SDK

organizations.list

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// no input
const result = await client.organizations.list()

curl

ПОЛУЧИТЬ /api/организации

curl --request GET "${CADCAMFUN_URL}/api/organizations" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Попробуйте это

почта /api/organizations # organizations.create

Требует Authorization: Bearer <token>.

Тело запроса · обязательно · приложение/json

{
  name: string
  description?: string | null
}

Ответы

201 объект application/json

{
  id: string
  name: string
  description: string | null
  createdAt: string
  updatedAt: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

organizations.create

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// OrganizationsCreateInput
const result = await client.organizations.create({
  name: "",
  description: ""
})

curl

POST /api/организации

curl --request POST "${CADCAMFUN_URL}/api/organizations" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Попробуйте это

Тело запроса application/json

получать /api/organizations/{id} # organizations.get

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый

Ответы

200 объект application/json

{
  id: string
  name: string
  description: string | null
  createdAt: string
  updatedAt: string
  members: Array<{
    id: string
    name: string | null
    email: string | null
    image: string | null
    role: "ADMIN" | "MANAGER" | "MEMBER"
    joinedAt: string
  }>
  projectCount: number | "Infinity" | "-Infinity" | "NaN"
  userRole: "ADMIN" | "MANAGER" | "MEMBER"
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

organizations.get

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// OrganizationsGetInput
const result = await client.organizations.get({
  id: "<id>"
})

curl

ПОЛУЧИТЬ /api/organizations/{id}

curl --request GET "${CADCAMFUN_URL}/api/organizations/<id>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Попробуйте это

идентификатор путь · требуется

помещать /api/organizations/{id} # organizations.update

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый

Тело запроса · обязательно · приложение/json

{
  name: string
  description?: string | null
}

Ответы

200 объект application/json

{
  id: string
  name: string
  description: string | null
  createdAt: string
  updatedAt: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

organizations.update

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// OrganizationsUpdateInput
const result = await client.organizations.update({
  id: "<id>",
  name: "",
  description: ""
})

curl

PUT /api/organizations/{id}

curl --request PUT "${CADCAMFUN_URL}/api/organizations/<id>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Попробуйте это

идентификатор путь · требуется

Тело запроса application/json

удалить /api/organizations/{id} # organizations.remove

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый

Ответы

200 объект application/json

{
  message: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

organizations.remove

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// OrganizationsRemoveInput
const result = await client.organizations.remove({
  id: "<id>"
})

curl

УДАЛИТЬ /api/organizations/{id}

curl --request DELETE "${CADCAMFUN_URL}/api/organizations/<id>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Попробуйте это

идентификатор путь · требуется

Схемы

Именованные схемы, доступные из параметров, тел и ответов этой группы. А ? отмечает необязательное поле; | null отмечает поле, которое может иметь нулевое значение.

BadRequestEncoded

{
  _tag: "BadRequest"
  message: string
}

ForbiddenEncoded

{
  _tag: "Forbidden"
  message: string
}

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

NotFoundEncoded

{
  _tag: "NotFound"
  message: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

Звонок в эту группу

Идентификаторы операций имеют вид organizations.<name>. Сгенерированный Promise SDK (@cadcamfun/api/sdk) выставляет большинство из них как client.<namespace>.<method>(input), где input представляет собой один плоский объект параметров пути и полей тела; В примере SDK каждой карты показаны точный метод доступа и тип ввода. Многочастные загрузки, двоичные ответы или ответы JavaScript, а также необработанные веб-перехватчики не генерируются; эти карты показывают fetch вместо этого.

Ошибки Promise SDK

import { CadCam, ClientError } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

try {
  await client.projects.list()
} catch (error) {
  if (error instanceof ClientError) {
    // Transport | UnexpectedStatus | UnsupportedContentType | MalformedResponse | SseEventTooLarge
  } else {
    // a declared error body: switch on error._tag
  }
}

Поиск неисправностей

Симптом	Вероятная причина	Исправить
401 на каждый вызов	Токен от предыдущего запуска или отсутствует `Bearer` префикс	Отправлять `Authorization: Bearer <token>` с жетоном, с которого была запущена сайдкар.
400 до того как что-либо произойдёт	Тело или параметр не соответствует схеме	Сравните полезную нагрузку со схемой запроса на карте.
403 или 404 у записи, которую видно в другом месте	Действующий счет отличается	Отправить право `x-session-token`или используйте локальный профиль, которому принадлежит запись.
409	Конфликтующее состояние, например повторяющееся имя или устаревший заголовок ветки.	Перечитайте ресурс и повторите попытку с текущими данными.
Попробуйте, написано «заблокировано CORS».	Документы подаются из источника без обратной связи.	Запустите документы локально или скопируйте запрос как curl.
В соединении отказано	Сайдкар перезапустилась в новом порту	Прочтите порт из нового `ready` строка.