Job Material

The job material resource.

Basehttps://rest.carbon.ms/jobMaterial

GET/jobMaterial

List job materials

Retrieve a paginated list of job materials. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/jobMaterial

curl --request GET \
  --url 'https://rest.carbon.ms/jobMaterial?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "jobId": "xyz789",
    "itemId": "xyz789",
    "itemType": "string",
    "methodType": "string",
    "order": 0,
    "description": "string",
    "quantity": 10
  }
]

GET/jobMaterial

Retrieve a job material

Fetch a single job material by filtering on `id`.

Query parameters

idstring

Match on the job material's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/jobMaterial

curl --request GET \
  --url 'https://rest.carbon.ms/jobMaterial?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "jobId": "xyz789",
  "itemId": "xyz789",
  "itemType": "string",
  "methodType": "string",
  "order": 0,
  "description": "string",
  "quantity": 10
}

POST/jobMaterial

Create a job material

Create a new job material.

Body parameters

jobIdstringrequired

References job.id

itemIdstringrequired

References item.id

itemTypestringrequired

methodTypemethodTyperequired

ordernumberrequired

descriptionstringrequired

quantitynumberrequired

scrapQuantitynumberrequired

unitOfMeasureCodestring

unitCostnumberrequired

companyIdstringrequired

References company.id

customFieldsobject

jobMakeMethodIdstringrequired

References jobMakeMethod.id

jobOperationIdstring

References jobOperation.id

estimatedQuantitynumber

defaultStorageUnitboolean

storageUnitIdstring

References storageUnit.id

quantityIssuednumber

quantityToIssuenumber

requiresSerialTrackingbooleanrequired

requiresBatchTrackingbooleanrequired

kitbooleanrequired

itemScrapPercentagenumberrequired

Scrap percentage from itemReplenishment at time of job creation

POSThttps://rest.carbon.ms/jobMaterial

curl --request POST \
  --url https://rest.carbon.ms/jobMaterial \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"jobId":"xyz789","itemId":"xyz789","itemType":"string","methodType":"string","order":0,"description":"string","quantity":10,"scrapQuantity":10,"unitCost":0,"companyId":"xyz789","jobMakeMethodId":"xyz789","requiresSerialTracking":true,"requiresBatchTracking":true,"kit":true,"itemScrapPercentage":0}'

Response

{
  "id": "abc123def456",
  "jobId": "xyz789",
  "itemId": "xyz789",
  "itemType": "string",
  "methodType": "string",
  "order": 0,
  "description": "string",
  "quantity": 10
}

PATCH/jobMaterial

Update a job material

Update an existing job material, matched on `id`.

Body parameters

jobIdstringrequired

References job.id

itemIdstringrequired

References item.id

itemTypestringrequired

methodTypemethodTyperequired

ordernumberrequired

descriptionstringrequired

quantitynumberrequired

scrapQuantitynumberrequired

unitOfMeasureCodestring

unitCostnumberrequired

companyIdstringrequired

References company.id

customFieldsobject

jobMakeMethodIdstringrequired

References jobMakeMethod.id

jobOperationIdstring

References jobOperation.id

estimatedQuantitynumber

defaultStorageUnitboolean

storageUnitIdstring

References storageUnit.id

quantityIssuednumber

quantityToIssuenumber

requiresSerialTrackingbooleanrequired

requiresBatchTrackingbooleanrequired

kitbooleanrequired

itemScrapPercentagenumberrequired

Scrap percentage from itemReplenishment at time of job creation

PATCHhttps://rest.carbon.ms/jobMaterial

curl --request PATCH \
  --url 'https://rest.carbon.ms/jobMaterial?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"jobId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "jobId": "xyz789",
  "itemId": "xyz789",
  "itemType": "string",
  "methodType": "string",
  "order": 0,
  "description": "string",
  "quantity": 10
}

DELETE/jobMaterial

Delete a job material

Delete a job material, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the job material to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/jobMaterial

curl --request DELETE \
  --url 'https://rest.carbon.ms/jobMaterial?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content