Documentação

Custos de produção

Estimativas, solicitações de cálculo, custos de materiais, custos operacionais e registros de desgaste de ferramentas.

Traduzido automaticamente do inglês. Ver o original em inglês

Área de testes

Envie essas solicitações para seu próprio sidecar em execução. Os valores permanecem neste navegador.

Não conectado

URL base Token do portador opcional Token de sessão opcional

Como isso funciona

O sidecar escuta em uma porta de loopback escolhida na inicialização e a imprime em seu ready linha; use esse URL e o CADCAMFUN_TOKEN foi iniciado. As solicitações vão direto desta página para esse endereço.

O sidecar envia cabeçalhos CORS apenas para as origens Tauri e para http://localhost ou http://127.0.0.1 em qualquer porto. Nos documentos hospedados, o navegador bloqueia a resposta, então execute os documentos localmente (bun run dev em packages/web) para usar o playground ou copie a solicitação como curl. Para experimentar sem tocar em dados reais, inicie o sidecar com CADCAMFUN_DATA_DIR apontado para um diretório descartável - veja o passo a passo da API.

Operações

21 endpoints no production-costs grupo, gerado a partir do próprio sidecar Documento OpenAPI. As operações protegidas levam Authorization: Bearer $CADCAMFUN_TOKEN; ver autenticação. Comportamento e limites estão em o guia do subsistema.

pegar	/api/production-costs/estimates	production-costs.listEstimates
publicar	/api/production-costs/estimates	production-costs.createEstimate
pegar	/api/production-costs/estimates/{id}	production-costs.getEstimate
colocar	/api/production-costs/estimates/{id}	production-costs.updateEstimate
excluir	/api/production-costs/estimates/{id}	production-costs.deleteEstimate
publicar	/api/production-costs/estimates/calculate	production-costs.calculateEstimate
pegar	/api/production-costs/material-costs	production-costs.listMaterialCosts
publicar	/api/production-costs/material-costs	production-costs.createMaterialCost
pegar	/api/production-costs/material-costs/{id}	production-costs.getMaterialCost
colocar	/api/production-costs/material-costs/{id}	production-costs.updateMaterialCost
excluir	/api/production-costs/material-costs/{id}	production-costs.deleteMaterialCost
pegar	/api/production-costs/operation-costs	production-costs.listOperationCosts
publicar	/api/production-costs/operation-costs	production-costs.createOperationCost
pegar	/api/production-costs/operation-costs/{id}	production-costs.getOperationCost
colocar	/api/production-costs/operation-costs/{id}	production-costs.updateOperationCost
excluir	/api/production-costs/operation-costs/{id}	production-costs.deleteOperationCost
pegar	/api/production-costs/tool-wear	production-costs.listToolWear
publicar	/api/production-costs/tool-wear	production-costs.createToolWear
pegar	/api/production-costs/tool-wear/{id}	production-costs.getToolWear
colocar	/api/production-costs/tool-wear/{id}	production-costs.updateToolWear
excluir	/api/production-costs/tool-wear/{id}	production-costs.deleteToolWear

Operações de custos de produção em 3D Arraste para orbitar · role para ampliar · arraste com o botão direito para deslocar

Um bloco por operação (21), empilhado por seção de recursos desta página e colorido por método: verde GET, laranja POST, azul PUT, violeta PATCH, vermelho DELETE. Gerado a partir do documento OpenAPI em tempo de construção.

/api/production-costs/estimates

pegar /api/production-costs/estimates # production-costs.listEstimates

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
toolpathId	consulta	corda \| null	opcional
projectId	consulta	corda \| null	opcional
organizationId	consulta	"nulo" \| corda \| null	opcional

Respostas

200 Matriz<objeto> application/json

Array<{
  id: string
  createdAt: string
  updatedAt: string
  materialCost: number | "Infinity" | "-Infinity" | "NaN"
  toolWearCost: number | "Infinity" | "-Infinity" | "NaN"
  machineTime: number | "Infinity" | "-Infinity" | "NaN"
  machineTimeCost: number | "Infinity" | "-Infinity" | "NaN"
  operatorTime: number | "Infinity" | "-Infinity" | "NaN"
  operatorTimeCost: number | "Infinity" | "-Infinity" | "NaN"
  setupCost: number | "Infinity" | "-Infinity" | "NaN"
  totalCost: number | "Infinity" | "-Infinity" | "NaN"
  currencyCode: string
  ownerId: string | null
  organizationId: string | null
  toolpathId: string
  details: unknown
  operationCostId: string | null
  costSettingsId?: string | null
  owner: {
    id: string
    name: string | null
    email?: string | null
  } | null
  organization: {
    id: string
    name: string | null
  } | null
  toolpath: {
    id: string
    name: string
    projectId?: string | null
  }
  operationCost: {
    id: string
    createdAt: string
    updatedAt: string
    ownerId: string | null
    organizationId: string | null
    currencyCode: string
    name: string
    machineHourlyRate: number | "Infinity" | "-Infinity" | "NaN"
    operatorHourlyRate: number | "NaN"
    setupTime: number | "NaN"
  } | null
}>

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Resposta de exemplo capturado · 200

GET /api/custos de produção/estimativas

[]

Exemplo de SDK

production-costs.listEstimates

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

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

// ProductionCostsListEstimatesInput
const result = await client["production-costs"].listEstimates({})

curl

GET /api/custos de produção/estimativas

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

Experimente

toolpathId consulta projectId consulta organizationId consulta

publicar /api/production-costs/estimates # production-costs.createEstimate

Requer Authorization: Bearer <token>.

Corpo da solicitação · obrigatório · aplicação/json

{
  toolpathId: string
  totalCost: number | "Infinity" | "-Infinity" | "NaN"
  materialCost?: number | "Infinity" | "-Infinity" | "NaN" | null
  toolWearCost?: number | "Infinity" | "-Infinity" | "NaN" | null
  machineTime?: number | "Infinity" | "-Infinity" | "NaN" | null
  machineTimeCost?: number | "Infinity" | "-Infinity" | "NaN" | null
  operatorTime?: number | "Infinity" | "-Infinity" | "NaN" | null
  operatorTimeCost?: number | "Infinity" | "-Infinity" | "NaN" | null
  setupCost?: number | "Infinity" | "-Infinity" | "NaN" | null
  currencyCode?: string | null
  details?: unknown | null
  operationCostId?: string | null
  costSettingsId?: string | null
  organizationId?: string | null
}

Respostas

201 objeto application/json

{
  id: string
  createdAt: string
  updatedAt: string
  materialCost: number | "Infinity" | "-Infinity" | "NaN"
  toolWearCost: number | "Infinity" | "-Infinity" | "NaN"
  machineTime: number | "Infinity" | "-Infinity" | "NaN"
  machineTimeCost: number | "Infinity" | "-Infinity" | "NaN"
  operatorTime: number | "Infinity" | "-Infinity" | "NaN"
  operatorTimeCost: number | "Infinity" | "-Infinity" | "NaN"
  setupCost: number | "Infinity" | "-Infinity" | "NaN"
  totalCost: number | "Infinity" | "-Infinity" | "NaN"
  currencyCode: string
  ownerId: string | null
  organizationId: string | null
  toolpathId: string
  details: unknown
  operationCostId: string | null
  costSettingsId?: string | null
  owner: {
    id: string
    name: string | null
    email?: string | null
  } | null
  organization: {
    id: string
    name: string | null
  } | null
  toolpath: {
    id: string
    name: string
    projectId?: string | null
  }
  operationCost: {
    id: string
    createdAt: string
    updatedAt: string
    ownerId: string | null
    organizationId: string | null
    currencyCode: string
    name: string
    machineHourlyRate: number | "Infinity" | "-Infinity" | "NaN"
    operatorHourlyRate: number | "NaN"
    setupTime: number | "NaN"
  } | 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

Exemplo de SDK

production-costs.createEstimate

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

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

// ProductionCostsCreateEstimateInput
const result = await client["production-costs"].createEstimate({
  toolpathId: "",
  totalCost: 0,
  materialCost: 0,
  toolWearCost: 0,
  machineTime: 0,
  machineTimeCost: 0,
  operatorTime: 0,
  operatorTimeCost: 0,
  setupCost: 0,
  currencyCode: "",
  details: null,
  operationCostId: "",
  costSettingsId: "",
  organizationId: ""
})

curl

POST /api/custos de produção/estimativas

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

Experimente

Solicitar corpo application/json

pegar /api/production-costs/estimates/{id} # production-costs.getEstimate

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Respostas

200 objeto application/json

{
  id: string
  createdAt: string
  updatedAt: string
  materialCost: number | "Infinity" | "-Infinity" | "NaN"
  toolWearCost: number | "Infinity" | "-Infinity" | "NaN"
  machineTime: number | "Infinity" | "-Infinity" | "NaN"
  machineTimeCost: number | "Infinity" | "-Infinity" | "NaN"
  operatorTime: number | "Infinity" | "-Infinity" | "NaN"
  operatorTimeCost: number | "Infinity" | "-Infinity" | "NaN"
  setupCost: number | "Infinity" | "-Infinity" | "NaN"
  totalCost: number | "Infinity" | "-Infinity" | "NaN"
  currencyCode: string
  ownerId: string | null
  organizationId: string | null
  toolpathId: string
  details: unknown
  operationCostId: string | null
  costSettingsId?: string | null
  owner: {
    id: string
    name: string | null
    email?: string | null
  } | null
  organization: {
    id: string
    name: string | null
  } | null
  toolpath: {
    id: string
    name: string
    projectId?: string | null
  }
  operationCost: {
    id: string
    createdAt: string
    updatedAt: string
    ownerId: string | null
    organizationId: string | null
    currencyCode: string
    name: string
    machineHourlyRate: number | "Infinity" | "-Infinity" | "NaN"
    operatorHourlyRate: number | "NaN"
    setupTime: number | "NaN"
  } | 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

Exemplo de SDK

production-costs.getEstimate

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

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

// ProductionCostsGetEstimateInput
const result = await client["production-costs"].getEstimate({
  id: "<id>"
})

curl

GET /api/custos de produção/estimativas/{id}

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

Experimente

eu ia caminho · obrigatório

colocar /api/production-costs/estimates/{id} # production-costs.updateEstimate

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Corpo da solicitação · obrigatório · aplicação/json

{
  currencyCode?: string | null
  details?: unknown | null
  notes?: string | null
}

Respostas

200 objeto application/json

{
  id: string
  createdAt: string
  updatedAt: string
  materialCost: number | "Infinity" | "-Infinity" | "NaN"
  toolWearCost: number | "Infinity" | "-Infinity" | "NaN"
  machineTime: number | "Infinity" | "-Infinity" | "NaN"
  machineTimeCost: number | "Infinity" | "-Infinity" | "NaN"
  operatorTime: number | "Infinity" | "-Infinity" | "NaN"
  operatorTimeCost: number | "Infinity" | "-Infinity" | "NaN"
  setupCost: number | "Infinity" | "-Infinity" | "NaN"
  totalCost: number | "Infinity" | "-Infinity" | "NaN"
  currencyCode: string
  ownerId: string | null
  organizationId: string | null
  toolpathId: string
  details: unknown
  operationCostId: string | null
  costSettingsId?: string | null
  owner: {
    id: string
    name: string | null
    email?: string | null
  } | null
  organization: {
    id: string
    name: string | null
  } | null
  toolpath: {
    id: string
    name: string
    projectId?: 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

Exemplo de SDK

production-costs.updateEstimate

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

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

// ProductionCostsUpdateEstimateInput
const result = await client["production-costs"].updateEstimate({
  id: "<id>",
  currencyCode: "",
  details: null,
  notes: ""
})

curl

PUT /api/custos de produção/estimativas/{id}

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

Experimente

eu ia caminho · obrigatório

Solicitar corpo application/json

excluir /api/production-costs/estimates/{id} # production-costs.deleteEstimate

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Respostas

200 objeto 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

Exemplo de SDK

production-costs.deleteEstimate

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

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

// ProductionCostsDeleteEstimateInput
const result = await client["production-costs"].deleteEstimate({
  id: "<id>"
})

curl

DELETE /api/custos de produção/estimativas/{id}

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

Experimente

eu ia caminho · obrigatório

publicar /api/production-costs/estimates/calculate # production-costs.calculateEstimate

Requer Authorization: Bearer <token>.

Corpo da solicitação · obrigatório · aplicação/json

{
  toolpathId: string
  costSettingsId?: string | null
  organizationId?: string | null
}

Respostas

200 objeto application/json

{
  materialCost: number | "Infinity" | "-Infinity" | "NaN"
  toolWearCost: number | "Infinity" | "-Infinity" | "NaN"
  machineTime: number | "Infinity" | "-Infinity" | "NaN"
  machineTimeCost: number | "Infinity" | "-Infinity" | "NaN"
  operatorTime: number | "Infinity" | "-Infinity" | "NaN"
  operatorTimeCost: number | "Infinity" | "-Infinity" | "NaN"
  setupCost: number | "Infinity" | "-Infinity" | "NaN"
  totalCost: number | "Infinity" | "-Infinity" | "NaN"
  currencyCode: string
  ownerId: string | null
  organizationId: string | null
  toolpathId: string
  details: {
    sourceSettingsId?: string | null
    inputs: {
      toolpathId: string
      toolId: string | null
      materialId: string | null
    }
    calculatedValues: {
      totalPathLengthMm: number | "Infinity" | "-Infinity" | "NaN"
      materialVolumeM3: number | "Infinity" | "-Infinity" | "NaN"
      feedRateMmMin: number | "Infinity" | "-Infinity" | "NaN"
      machineTimeMinutes: number | "Infinity" | "-Infinity" | "NaN"
      operatorTimeMinutes: number | "Infinity" | "-Infinity" | "NaN"
      totalSetupTimeMinutes: number | "Infinity" | "-Infinity" | "NaN"
    }
    costBreakdown: {
      material: number | "Infinity" | "-Infinity" | "NaN"
      toolWear: number | "Infinity" | "-Infinity" | "NaN"
      machineRun: number | "Infinity" | "-Infinity" | "NaN"
      operator: number | "Infinity" | "-Infinity" | "NaN"
      setup: number | "Infinity" | "-Infinity" | "NaN"
    }
  }
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Exemplo de SDK

production-costs.calculateEstimate

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

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

// ProductionCostsCalculateEstimateInput
const result = await client["production-costs"].calculateEstimate({
  toolpathId: "",
  costSettingsId: "",
  organizationId: ""
})

curl

POST /api/custos de produção/estimativas/calcular

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

Experimente

Solicitar corpo application/json

/api/production-costs/material-costs

pegar /api/production-costs/material-costs # production-costs.listMaterialCosts

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
materialId	consulta	corda \| null	opcional
organizationId	consulta	"nulo" \| corda \| null	opcional

Respostas

200 Matriz<objeto> application/json

Array<{
  id: string
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
  currencyCode: string
  materialId: string
  costPerUnit: number | "Infinity" | "-Infinity" | "NaN"
  wasteFactor: number | "Infinity" | "-Infinity" | "NaN"
  minimumCharge: number | "Infinity" | "-Infinity" | "NaN"
  material: {
    id: string
    name: string
    description: string | null
    properties: unknown
    isPublic: boolean
    createdAt: string
    updatedAt: string
    ownerId: string | null
    organizationId: string | null
  }
  owner: {
    id: string
    name: string | null
    email?: string | null
  } | null
  organization: {
    id: string
    name: string | null
  } | null
}>

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Resposta de exemplo capturado · 200

GET /api/custos de produção/custos de materiais

[]

Exemplo de SDK

production-costs.listMaterialCosts

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

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

// ProductionCostsListMaterialCostsInput
const result = await client["production-costs"].listMaterialCosts({})

curl

GET /api/custos de produção/custos de materiais

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

Experimente

materialId consulta organizationId consulta

publicar /api/production-costs/material-costs # production-costs.createMaterialCost

Requer Authorization: Bearer <token>.

Corpo da solicitação · obrigatório · aplicação/json

{
  costPerUnit: number | "Infinity" | "-Infinity" | "NaN"
  wasteFactor?: number | "Infinity" | "-Infinity" | "NaN" | null
  minimumCharge?: number | "Infinity" | "-Infinity" | "NaN" | null
  currencyCode?: string | null
  materialId: string
  organizationId?: string | null
}

Respostas

201 objeto application/json

{
  id: string
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
  currencyCode: string
  materialId: string
  costPerUnit: number | "Infinity" | "-Infinity" | "NaN"
  wasteFactor: number | "Infinity" | "-Infinity" | "NaN"
  minimumCharge: number | "Infinity" | "-Infinity" | "NaN"
  material: {
    id: string
    name: string
    description: string | null
    properties: unknown
    isPublic: boolean
    createdAt: string
    updatedAt: string
    ownerId: string | null
    organizationId: string | null
  }
}

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

Exemplo de SDK

production-costs.createMaterialCost

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

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

// ProductionCostsCreateMaterialCostInput
const result = await client["production-costs"].createMaterialCost({
  costPerUnit: 0,
  wasteFactor: 0,
  minimumCharge: 0,
  currencyCode: "",
  materialId: "",
  organizationId: ""
})

curl

POST /api/custos de produção/custos de material

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

Experimente

Solicitar corpo application/json

pegar /api/production-costs/material-costs/{id} # production-costs.getMaterialCost

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Respostas

200 objeto | nulo application/json

{
  id: string
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
  currencyCode: string
  materialId: string
  costPerUnit: number | "Infinity" | "-Infinity" | "NaN"
  wasteFactor: number | "NaN"
  minimumCharge: number | "NaN"
  material: {
    id: string
    name: string
    description: string | null
    properties: unknown
    isPublic: boolean
    createdAt: string
    updatedAt: string
    ownerId: string | null
    organizationId: string | null
  }
  owner: {
    id: string
    name: string | null
    email?: string | null
  } | null
  organization: {
    id: string
    name: string | null
} | 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

Exemplo de SDK

production-costs.getMaterialCost

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

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

// ProductionCostsGetMaterialCostInput
const result = await client["production-costs"].getMaterialCost({
  id: "<id>"
})

curl

GET /api/custos de produção/custos de material/{id}

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

Experimente

eu ia caminho · obrigatório

colocar /api/production-costs/material-costs/{id} # production-costs.updateMaterialCost

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Corpo da solicitação · obrigatório · aplicação/json

{
  costPerUnit?: number | "Infinity" | "-Infinity" | "NaN" | null
  wasteFactor?: number | "Infinity" | "-Infinity" | "NaN" | null
  minimumCharge?: number | "Infinity" | "-Infinity" | "NaN" | null
  currencyCode?: string | null
}

Respostas

200 objeto application/json

{
  id: string
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
  currencyCode: string
  materialId: string
  costPerUnit: number | "Infinity" | "-Infinity" | "NaN"
  wasteFactor: number | "Infinity" | "-Infinity" | "NaN"
  minimumCharge: number | "Infinity" | "-Infinity" | "NaN"
  material: {
    id: string
    name: string
    description: string | null
    properties: unknown
    isPublic: boolean
    createdAt: string
    updatedAt: string
    ownerId: string | null
    organizationId: 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

Exemplo de SDK

production-costs.updateMaterialCost

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

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

// ProductionCostsUpdateMaterialCostInput
const result = await client["production-costs"].updateMaterialCost({
  id: "<id>",
  costPerUnit: 0,
  wasteFactor: 0,
  minimumCharge: 0,
  currencyCode: ""
})

curl

PUT /api/custos de produção/custos de material/{id}

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

Experimente

eu ia caminho · obrigatório

Solicitar corpo application/json

excluir /api/production-costs/material-costs/{id} # production-costs.deleteMaterialCost

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Respostas

200 objeto 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

Exemplo de SDK

production-costs.deleteMaterialCost

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

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

// ProductionCostsDeleteMaterialCostInput
const result = await client["production-costs"].deleteMaterialCost({
  id: "<id>"
})

curl

DELETE /api/custos de produção/custos de material/{id}

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

Experimente

eu ia caminho · obrigatório

/api/production-costs/operation-costs

pegar /api/production-costs/operation-costs # production-costs.listOperationCosts

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
organizationId	consulta	"nulo" \| corda \| null	opcional

Respostas

200 Matriz<objeto> application/json

Array<{
  id: string
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
  currencyCode: string
  name: string
  machineHourlyRate: number | "Infinity" | "-Infinity" | "NaN"
  operatorHourlyRate: number | "Infinity" | "-Infinity" | "NaN"
  setupTime: number | "Infinity" | "-Infinity" | "NaN"
  owner: {
    id: string
    name: string | null
    email?: string | null
  } | null
  organization: {
    id: string
    name: string | null
  } | null
}>

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Resposta de exemplo capturado · 200

GET /api/custos de produção/custos de operação

[]

Exemplo de SDK

production-costs.listOperationCosts

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

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

// ProductionCostsListOperationCostsInput
const result = await client["production-costs"].listOperationCosts({})

curl

GET /api/custos de produção/custos de operação

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

Experimente

organizationId consulta

publicar /api/production-costs/operation-costs # production-costs.createOperationCost

Requer Authorization: Bearer <token>.

Corpo da solicitação · obrigatório · aplicação/json

{
  name: string
  machineHourlyRate: number | "Infinity" | "-Infinity" | "NaN"
  operatorHourlyRate: number | "Infinity" | "-Infinity" | "NaN"
  setupTime?: number | "Infinity" | "-Infinity" | "NaN" | null
  currencyCode?: string | null
  organizationId?: string | null
}

Respostas

201 objeto application/json

{
  id: string
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
  currencyCode: string
  name: string
  machineHourlyRate: number | "Infinity" | "-Infinity" | "NaN"
  operatorHourlyRate: number | "Infinity" | "-Infinity" | "NaN"
  setupTime: number | "Infinity" | "-Infinity" | "NaN"
  owner: {
    id: string
    name: string | null
    email?: string | null
  } | null
  organization: {
    id: string
    name: string | null
  } | null
}

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

Exemplo de SDK

production-costs.createOperationCost

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

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

// ProductionCostsCreateOperationCostInput
const result = await client["production-costs"].createOperationCost({
  name: "",
  machineHourlyRate: 0,
  operatorHourlyRate: 0,
  setupTime: 0,
  currencyCode: "",
  organizationId: ""
})

curl

POST /api/custos de produção/custos de operação

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

Experimente

Solicitar corpo application/json

pegar /api/production-costs/operation-costs/{id} # production-costs.getOperationCost

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Respostas

200 objeto | nulo application/json

{
  id: string
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
  currencyCode: string
  name: string
  machineHourlyRate: number | "Infinity" | "-Infinity" | "NaN"
  operatorHourlyRate: number | "NaN"
  setupTime: number | "NaN"
  owner: {
    id: string
    name: string | null
    email?: string | null
  } | null
  organization: {
    id: string
    name: string | null
} | 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

Exemplo de SDK

production-costs.getOperationCost

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

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

// ProductionCostsGetOperationCostInput
const result = await client["production-costs"].getOperationCost({
  id: "<id>"
})

curl

GET /api/custos de produção/custos de operação/{id}

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

Experimente

eu ia caminho · obrigatório

colocar /api/production-costs/operation-costs/{id} # production-costs.updateOperationCost

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Corpo da solicitação · obrigatório · aplicação/json

{
  name?: string | null
  machineHourlyRate?: number | "Infinity" | "-Infinity" | "NaN" | null
  operatorHourlyRate?: number | "Infinity" | "-Infinity" | "NaN" | null
  setupTime?: number | "Infinity" | "-Infinity" | "NaN" | null
  currencyCode?: string | null
}

Respostas

200 objeto application/json

{
  id: string
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
  currencyCode: string
  name: string
  machineHourlyRate: number | "Infinity" | "-Infinity" | "NaN"
  operatorHourlyRate: number | "Infinity" | "-Infinity" | "NaN"
  setupTime: number | "Infinity" | "-Infinity" | "NaN"
  owner: {
    id: string
    name: string | null
    email?: string | null
  } | null
  organization: {
    id: string
    name: string | null
  } | null
}

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

Exemplo de SDK

production-costs.updateOperationCost

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

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

// ProductionCostsUpdateOperationCostInput
const result = await client["production-costs"].updateOperationCost({
  id: "<id>",
  name: "",
  machineHourlyRate: 0,
  operatorHourlyRate: 0,
  setupTime: 0,
  currencyCode: ""
})

curl

PUT /api/custos de produção/custos de operação/{id}

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

Experimente

eu ia caminho · obrigatório

Solicitar corpo application/json

excluir /api/production-costs/operation-costs/{id} # production-costs.deleteOperationCost

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Respostas

200 objeto 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

Exemplo de SDK

production-costs.deleteOperationCost

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

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

// ProductionCostsDeleteOperationCostInput
const result = await client["production-costs"].deleteOperationCost({
  id: "<id>"
})

curl

DELETE /api/custos de produção/custos de operação/{id}

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

Experimente

eu ia caminho · obrigatório

/api/production-costs/tool-wear

pegar /api/production-costs/tool-wear # production-costs.listToolWear

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
toolId	consulta	corda \| null	opcional
organizationId	consulta	"nulo" \| corda \| null	opcional

Respostas

200 Matriz<objeto> application/json

Array<{
  id: string
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
  currencyCode: string
  toolId: string
  wearRatePerMeter: number | "Infinity" | "-Infinity" | "NaN"
  replacementCost: number | "Infinity" | "-Infinity" | "NaN"
  replacementThreshold: number | "Infinity" | "-Infinity" | "NaN"
  tool: {
    id: string
    name: string
    type: string
    diameter: number | "Infinity" | "-Infinity" | "NaN"
    material: string
    numberOfFlutes: number | "Infinity" | "-Infinity" | "NaN" | null
    maxRPM: number | "Infinity" | "-Infinity" | "NaN" | null
    coolantType: string | null
    cuttingLength: number | "Infinity" | "-Infinity" | "NaN" | null
    totalLength: number | "Infinity" | "-Infinity" | "NaN" | null
    shankDiameter: number | "Infinity" | "-Infinity" | "NaN" | null
    cornerRadius?: number | "Infinity" | "-Infinity" | "NaN" | null
    tipAngle?: number | "Infinity" | "-Infinity" | "NaN" | null
    threadPitch?: number | "Infinity" | "-Infinity" | "NaN" | null
    holderDiameter?: number | "Infinity" | "-Infinity" | "NaN" | null
    holderLength?: number | "Infinity" | "-Infinity" | "NaN" | null
    stickout?: number | "Infinity" | "-Infinity" | "NaN" | null
    notes: string | null
    isPublic: boolean
    createdAt: string
    updatedAt: string
    ownerId: string | null
    organizationId: string | null
  }
  owner: {
    id: string
    name: string | null
    email?: string | null
  } | null
  organization: {
    id: string
    name: string | null
  } | null
}>

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Resposta de exemplo capturado · 200

GET /api/custos de produção/desgaste de ferramentas

[]

Exemplo de SDK

production-costs.listToolWear

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

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

// ProductionCostsListToolWearInput
const result = await client["production-costs"].listToolWear({})

curl

GET /api/custos de produção/desgaste de ferramentas

curl --request GET "${CADCAMFUN_URL}/api/production-costs/tool-wear" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Experimente

toolId consulta organizationId consulta

publicar /api/production-costs/tool-wear # production-costs.createToolWear

Requer Authorization: Bearer <token>.

Corpo da solicitação · obrigatório · aplicação/json

{
  wearRatePerMeter: number | "Infinity" | "-Infinity" | "NaN"
  replacementCost: number | "Infinity" | "-Infinity" | "NaN"
  replacementThreshold?: number | "Infinity" | "-Infinity" | "NaN" | null
  currencyCode?: string | null
  toolId: string
  organizationId?: string | null
}

Respostas

201 objeto application/json

{
  id: string
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
  currencyCode: string
  toolId: string
  wearRatePerMeter: number | "Infinity" | "-Infinity" | "NaN"
  replacementCost: number | "Infinity" | "-Infinity" | "NaN"
  replacementThreshold: number | "Infinity" | "-Infinity" | "NaN"
  tool: {
    id: string
    name: string
    type: string
    diameter: number | "Infinity" | "-Infinity" | "NaN"
    material: string
    numberOfFlutes: number | "Infinity" | "-Infinity" | "NaN" | null
    maxRPM: number | "Infinity" | "-Infinity" | "NaN" | null
    coolantType: string | null
    cuttingLength: number | "Infinity" | "-Infinity" | "NaN" | null
    totalLength: number | "Infinity" | "-Infinity" | "NaN" | null
    shankDiameter: number | "Infinity" | "-Infinity" | "NaN" | null
    cornerRadius?: number | "Infinity" | "-Infinity" | "NaN" | null
    tipAngle?: number | "Infinity" | "-Infinity" | "NaN" | null
    threadPitch?: number | "Infinity" | "-Infinity" | "NaN" | null
    holderDiameter?: number | "Infinity" | "-Infinity" | "NaN" | null
    holderLength?: number | "Infinity" | "-Infinity" | "NaN" | null
    stickout?: number | "Infinity" | "-Infinity" | "NaN" | null
    notes: string | null
    isPublic: boolean
    createdAt: string
    updatedAt: string
    ownerId: string | null
    organizationId: string | null
  }
}

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

Exemplo de SDK

production-costs.createToolWear

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

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

// ProductionCostsCreateToolWearInput
const result = await client["production-costs"].createToolWear({
  wearRatePerMeter: 0,
  replacementCost: 0,
  replacementThreshold: 0,
  currencyCode: "",
  toolId: "",
  organizationId: ""
})

curl

POST /api/custos de produção/desgaste de ferramentas

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

Experimente

Solicitar corpo application/json

pegar /api/production-costs/tool-wear/{id} # production-costs.getToolWear

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Respostas

200 objeto | nulo application/json

{
  id: string
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
  currencyCode: string
  toolId: string
  wearRatePerMeter: number | "Infinity" | "-Infinity" | "NaN"
  replacementCost: number | "NaN"
  replacementThreshold: number | "NaN"
  tool: {
    id: string
    name: string
    type: string
    diameter: number | "NaN"
    material: string
    numberOfFlutes: number | "NaN" | null
    maxRPM: number | null
    coolantType: string | null
    cuttingLength: number | null
    totalLength: number | null
    shankDiameter: number | null
    cornerRadius?: number | null
    tipAngle?: number | null
    threadPitch?: number | null
    holderDiameter?: number | null
    holderLength?: number | null
    stickout?: number | null
    notes: string | null
    isPublic: boolean
    createdAt: string
    updatedAt: string
    ownerId: string | null
    organizationId: string | null
  }
  owner: {
    id: string
    name: string | null
    email?: string | null
  } | null
  organization: {
    id: string
    name: string | null
} | 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

Exemplo de SDK

production-costs.getToolWear

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

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

// ProductionCostsGetToolWearInput
const result = await client["production-costs"].getToolWear({
  id: "<id>"
})

curl

GET /api/custos de produção/desgaste de ferramentas/{id}

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

Experimente

eu ia caminho · obrigatório

colocar /api/production-costs/tool-wear/{id} # production-costs.updateToolWear

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Corpo da solicitação · obrigatório · aplicação/json

{
  wearRatePerMeter?: number | "Infinity" | "-Infinity" | "NaN" | null
  replacementCost?: number | "Infinity" | "-Infinity" | "NaN" | null
  replacementThreshold?: number | "Infinity" | "-Infinity" | "NaN" | null
  currencyCode?: string | null
}

Respostas

200 objeto application/json

{
  id: string
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
  currencyCode: string
  toolId: string
  wearRatePerMeter: number | "Infinity" | "-Infinity" | "NaN"
  replacementCost: number | "Infinity" | "-Infinity" | "NaN"
  replacementThreshold: number | "Infinity" | "-Infinity" | "NaN"
  tool: {
    id: string
    name: string
    type: string
    diameter: number | "Infinity" | "-Infinity" | "NaN"
    material: string
    numberOfFlutes: number | "Infinity" | "-Infinity" | "NaN" | null
    maxRPM: number | "Infinity" | "-Infinity" | "NaN" | null
    coolantType: string | null
    cuttingLength: number | "Infinity" | "-Infinity" | "NaN" | null
    totalLength: number | "Infinity" | "-Infinity" | "NaN" | null
    shankDiameter: number | "Infinity" | "-Infinity" | "NaN" | null
    cornerRadius?: number | "Infinity" | "-Infinity" | "NaN" | null
    tipAngle?: number | "Infinity" | "-Infinity" | "NaN" | null
    threadPitch?: number | "Infinity" | "-Infinity" | "NaN" | null
    holderDiameter?: number | "Infinity" | "-Infinity" | "NaN" | null
    holderLength?: number | "Infinity" | "-Infinity" | "NaN" | null
    stickout?: number | "Infinity" | "-Infinity" | "NaN" | null
    notes: string | null
    isPublic: boolean
    createdAt: string
    updatedAt: string
    ownerId: string | null
    organizationId: 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

Exemplo de SDK

production-costs.updateToolWear

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

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

// ProductionCostsUpdateToolWearInput
const result = await client["production-costs"].updateToolWear({
  id: "<id>",
  wearRatePerMeter: 0,
  replacementCost: 0,
  replacementThreshold: 0,
  currencyCode: ""
})

curl

PUT /api/custos de produção/desgaste de ferramentas/{id}

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

Experimente

eu ia caminho · obrigatório

Solicitar corpo application/json

excluir /api/production-costs/tool-wear/{id} # production-costs.deleteToolWear

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Respostas

200 objeto 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

Exemplo de SDK

production-costs.deleteToolWear

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

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

// ProductionCostsDeleteToolWearInput
const result = await client["production-costs"].deleteToolWear({
  id: "<id>"
})

curl

DELETE /api/custos de produção/desgaste de ferramentas/{id}

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

Experimente

eu ia caminho · obrigatório

Esquemas

Esquemas nomeados acessíveis a partir dos parâmetros, corpos e respostas deste grupo. UM ? marca um campo opcional; | null marca um campo que pode estar presente com um valor nulo.

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
}

Chamando este grupo

Os IDs de operação têm o formato production-costs.<name>. O Promise SDK gerado (@cadcamfun/api/sdk) expõe a maioria deles como client.<namespace>.<method>(input), onde input é um objeto plano de parâmetros de caminho e campos de corpo; o exemplo do SDK de cada cartão mostra o acessador e o tipo de entrada exatos. Multipart uploads, respostas binárias ou JavaScript e webhooks brutos não são gerados; essas cartas mostram fetch em vez disso.

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

Solução de problemas

Sintoma	Causa provável	Consertar
401 em cada chamada	Token de um lançamento anterior ou ausente `Bearer` prefixo	Enviar `Authorization: Bearer <token>` com o token com o qual o sidecar foi iniciado.
400 antes que algo aconteça	O corpo ou parâmetro não corresponde ao esquema	Compare a carga útil com o esquema de solicitação no cartão.
403 ou 404 em um registro que você vê em outro lugar	A conta atuante difere	Envie o certo `x-session-token`ou use o perfil local que possui o registro.
409	Estado conflitante, como um nome duplicado ou um cabeçalho de ramificação obsoleto	Leia novamente o recurso e tente novamente com os dados atuais.
Tente dizer "bloqueado pelo CORS"	Os documentos são veiculados a partir de uma origem sem loopback	Execute os documentos localmente ou copie a solicitação como curl.
Ligação recusada	O sidecar foi reiniciado em uma nova porta	Leia a porta do novo `ready` linha.