Documentazione

Disegni

Disegni di progetto e geometria salvata, metadati e operazioni di aggiornamento.

Tradotto automaticamente dall'inglese. Vedi l'originale in inglese

Playground

Invia queste richieste al tuo sidecar in corsa. I valori rimangono in questo browser.

Non connesso

URL di base Gettone al portatore opzionale Token di sessione opzionale

Come funziona

Il sidecar resta in ascolto su una porta di loopback scelta all'avvio e la stampa nel suo file ready linea; usa quell'URL e il file CADCAMFUN_TOKEN è stato iniziato con. Le richieste vanno direttamente da questa pagina a quell'indirizzo.

Il sidecar invia intestazioni CORS solo alle origini Tauri e a http://localhost o http://127.0.0.1 su qualsiasi porto. Dai documenti ospitati il browser blocca la risposta, quindi esegui i documenti localmente (bun run dev in packages/web) per utilizzare il parco giochi, oppure copiare la richiesta come ricciolo. Per sperimentare senza toccare i dati reali, avvia il sidecar con CADCAMFUN_DATA_DIR indicato in una directory usa e getta - vedi la procedura dettagliata dell'API.

Operazioni

7 endpoint nel drawings gruppo, generato da quello del sidecar Documento OpenAPI. Le operazioni protette richiedono Authorization: Bearer $CADCAMFUN_TOKEN; vedere autenticazione. Comportamenti e limiti sono entrati la guida del sottosistema.

ottenere	/api/drawings/{id}	drawings.get
mettere	/api/drawings/{id}	drawings.update
eliminare	/api/drawings/{id}	drawings.remove
ottenere	/api/drawings/{id}/versions	drawings.versions
inviare	/api/drawings/{id}/versions/{versionId}/restore	drawings.restoreVersion
ottenere	/api/projects/{id}/drawings	drawings.listForProject
inviare	/api/projects/{id}/drawings	drawings.createForProject

Operazioni di disegno in 3D Trascina per orbitare · scorri per ingrandire · trascina con il tasto destro per eseguire la panoramica

Un blocco per operazione (7), impilato per sezione di risorse di questa pagina e colorato in base al metodo: verde GET, arancione POST, blu PUT, viola PATCH, rosso DELETE. Generato dal documento OpenAPI in fase di compilazione.

/api/drawings

ottenere /api/drawings/{id} # drawings.get

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario

Risposte

200 oggetto application/json

{
  id: string
  name: string
  description: string | null
  data: unknown
  thumbnail: string | null
  createdAt: string
  updatedAt: string
  projectId: string
  project: {
    id: string
    name: string
    ownerId: string
    organization: {
      id: string
      users: Array<{
        role: string
      }>
    } | null
  }
}

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

Esempio dell'SDK

drawings.get

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

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

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

curl

OTTIENI /api/disegni/{id}

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

Provalo

id percorso · richiesto

mettere /api/drawings/{id} # drawings.update

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario

Corpo della richiesta · obbligatorio · application/json

{
  name?: string | null
  description?: string | null
  data?: unknown | null
  thumbnail?: string | null
  baseUpdatedAt?: string | null
  mergeData?: boolean | null
}

Risposte

200 oggetto application/json

{
  id: string
  name: string
  description: string | null
  data: unknown
  thumbnail: string | null
  createdAt: string
  updatedAt: string
  projectId: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Esempio dell'SDK

drawings.update

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

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

// DrawingsUpdateInput
const result = await client.drawings.update({
  id: "<id>",
  name: "",
  description: "",
  data: null,
  thumbnail: "",
  baseUpdatedAt: "",
  mergeData: false
})

curl

PUT /api/disegni/{id}

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

Provalo

id percorso · richiesto

Richiedi corpo application/json

eliminare /api/drawings/{id} # drawings.remove

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario

Risposte

200 oggetto application/json

{
  message: string
}

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

Esempio dell'SDK

drawings.remove

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

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

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

curl

ELIMINA /api/disegni/{id}

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

Provalo

id percorso · richiesto

ottenere /api/drawings/{id}/versions # drawings.versions

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario

Risposte

200 Matrice<oggetto> application/json

Array<{
  id: string
  version: number | "Infinity" | "-Infinity" | "NaN"
  createdAt: string
  elements: number | "Infinity" | "-Infinity" | "NaN"
}>

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

prendere esempio

drawings.versions

// Not generated in the Promise SDK (multipart, binary or raw body): call it with fetch.
const response = await fetch(`${process.env.CADCAMFUN_URL}/api/drawings/${id}/versions`, {
  method: "GET",
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

curl

OTTIENI /api/disegni/{id}/versions

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

Provalo

id percorso · richiesto

inviare /api/drawings/{id}/versions/{versionId}/restore # drawings.restoreVersion

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario
versionId	sentiero	corda	necessario

Risposte

200 oggetto application/json

{
  id: string
  name: string
  description: string | null
  data: unknown
  thumbnail: string | null
  createdAt: string
  updatedAt: string
  projectId: string
}

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

prendere esempio

drawings.restoreVersion

// Not generated in the Promise SDK (multipart, binary or raw body): call it with fetch.
const response = await fetch(`${process.env.CADCAMFUN_URL}/api/drawings/${id}/versions/${versionId}/restore`, {
  method: "POST",
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

curl

POST /api/drawings/{id}/versions/{versionId}/restore

curl --request POST "${CADCAMFUN_URL}/api/drawings/<id>/versions/<versionId>/restore" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Provalo

id percorso · richiesto versionId percorso · richiesto

/api/projects

ottenere /api/projects/{id}/drawings # drawings.listForProject

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario

Risposte

200 Matrice<oggetto> application/json

Array<{
  id: string
  name: string
  description: string | null
  data: unknown
  thumbnail: string | null
  createdAt: string
  updatedAt: string
  projectId: string
}>

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Esempio dell'SDK

drawings.listForProject

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

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

// DrawingsListForProjectInput
const result = await client.drawings.listForProject({
  id: "<id>"
})

curl

OTTIENI /api/projects/{id}/disegni

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

Provalo

id percorso · richiesto

inviare /api/projects/{id}/drawings # drawings.createForProject

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
id	sentiero	corda	necessario

Corpo della richiesta · obbligatorio · application/json

{
  name?: string | null
  description?: string | null
  data?: unknown | null
  thumbnail?: string | null
  baseUpdatedAt?: string | null
  mergeData?: boolean | null
}

Risposte

201 oggetto application/json

{
  id: string
  name: string
  description: string | null
  data: unknown
  thumbnail: string | null
  createdAt: string
  updatedAt: string
  projectId: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Esempio dell'SDK

drawings.createForProject

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

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

// DrawingsCreateForProjectInput
const result = await client.drawings.createForProject({
  id: "<id>",
  name: "",
  description: "",
  data: null,
  thumbnail: "",
  baseUpdatedAt: "",
  mergeData: false
})

curl

POST /api/projects/{id}/disegni

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

Provalo

id percorso · richiesto

Richiedi corpo application/json

Schemi

Schemi denominati raggiungibili dai parametri, dai corpi e dalle risposte di questo gruppo. UN ? contrassegna un campo facoltativo; | null contrassegna un campo che può essere presente con un valore nullo.

BadRequestEncoded

{
  _tag: "BadRequest"
  message: string
}

ConflictEncoded

{
  _tag: "Conflict"
  message: string
}

ForbiddenEncoded

{
  _tag: "Forbidden"
  message: string
}

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

NotFoundEncoded

{
  _tag: "NotFound"
  message: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

Chiamando questo gruppo

Gli ID operazione hanno il formato drawings.<name>. L'SDK Promise generato (@cadcamfun/api/sdk) ne espone la maggior parte come client.<namespace>.<method>(input), dove input è un oggetto piatto di parametri di percorso e campi del corpo; l'esempio dell'SDK di ciascuna scheda mostra l'esatto accessor e il tipo di input. Non vengono generati caricamenti in più parti, risposte binarie o JavaScript e webhook grezzi; quelle carte mostrano fetch invece.

Errori dall'SDK Promise

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
  }
}

Risoluzione dei problemi

Sintomo	Probabile causa	Aggiustare
401 a ogni chiamata	Token di un lancio precedente o mancante `Bearer` prefisso	Inviare `Authorization: Bearer <token>` con il gettone con cui è stato avviato il sidecar.
400 prima che accada qualcosa	Il corpo o il parametro non corrisponde allo schema	Confronta il payload con lo schema di richiesta sulla carta.
403 o 404 su un record visibile altrove	Il resoconto della recitazione è diverso	Invia il diritto `x-session-token`oppure utilizzare il profilo locale proprietario del record.
409	Stato in conflitto, ad esempio un nome duplicato o una testa di ramo obsoleta	Rileggere la risorsa e riprovare con i dati correnti.
Prova, dice "bloccato da CORS"	I documenti vengono serviti da un'origine non di loopback	Esegui i documenti localmente o copia la richiesta come curl.
Connessione rifiutata	Il sidecar è ripartito su una nuova porta	Leggi il porto dal nuovo `ready` riga.