Job

The job resource.

Basehttps://rest.carbon.ms/job

GET/job

List jobs

Retrieve a paginated list of jobs. 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/job

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

Response

[
  {
    "id": "abc123def456",
    "jobId": "xyz789",
    "itemId": "xyz789",
    "unitOfMeasureCode": "string",
    "locationId": "xyz789",
    "status": "string",
    "deadlineType": "string",
    "quantity": 10
  }
]

GET/job

Retrieve a job

Fetch a single job by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/job

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

Response

{
  "id": "abc123def456",
  "jobId": "xyz789",
  "itemId": "xyz789",
  "unitOfMeasureCode": "string",
  "locationId": "xyz789",
  "status": "string",
  "deadlineType": "string",
  "quantity": 10
}

POST/job

Create a job

Create a new job.

Body parameters

jobIdstringrequired

itemIdstringrequired

References item.id

unitOfMeasureCodestringrequired

customerIdstring

References customer.id

locationIdstringrequired

References location.id

statusjobStatusrequired

dueDatedate

deadlineTypedeadlineTyperequired

quantitynumberrequired

scrapQuantitynumberrequired

productionQuantitynumber

quantityCompletenumberrequired

quantityShippednumberrequired

quantityReceivedToInventorynumberrequired

salesOrderIdstring

References salesOrder.id

salesOrderLineIdstring

References salesOrderLine.id

quoteIdstring

References quote.id

quoteLineIdstring

modelUploadIdstring

notesobject

assigneestring

References user.id

customFieldsobject

companyIdstringrequired

References company.id

tagsarray

configurationobject

releasedDatetimestamp

completedDatetimestamp

estimatedTimenumber

actualTimenumber

secondsToCompletenumber

startDatedate

storageUnitIdstring

References storageUnit.id

prioritynumberrequired

POSThttps://rest.carbon.ms/job

curl --request POST \
  --url https://rest.carbon.ms/job \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"jobId":"xyz789","itemId":"xyz789","unitOfMeasureCode":"string","locationId":"xyz789","status":"string","deadlineType":"string","quantity":10,"scrapQuantity":10,"quantityComplete":10,"quantityShipped":10,"quantityReceivedToInventory":10,"companyId":"xyz789","priority":0}'

Response

{
  "id": "abc123def456",
  "jobId": "xyz789",
  "itemId": "xyz789",
  "unitOfMeasureCode": "string",
  "locationId": "xyz789",
  "status": "string",
  "deadlineType": "string",
  "quantity": 10
}

PATCH/job

Update a job

Update an existing job, matched on `id`.

Body parameters

jobIdstringrequired

itemIdstringrequired

References item.id

unitOfMeasureCodestringrequired

customerIdstring

References customer.id

locationIdstringrequired

References location.id

statusjobStatusrequired

dueDatedate

deadlineTypedeadlineTyperequired

quantitynumberrequired

scrapQuantitynumberrequired

productionQuantitynumber

quantityCompletenumberrequired

quantityShippednumberrequired

quantityReceivedToInventorynumberrequired

salesOrderIdstring

References salesOrder.id

salesOrderLineIdstring

References salesOrderLine.id

quoteIdstring

References quote.id

quoteLineIdstring

modelUploadIdstring

notesobject

assigneestring

References user.id

customFieldsobject

companyIdstringrequired

References company.id

tagsarray

configurationobject

releasedDatetimestamp

completedDatetimestamp

estimatedTimenumber

actualTimenumber

secondsToCompletenumber

startDatedate

storageUnitIdstring

References storageUnit.id

prioritynumberrequired

PATCHhttps://rest.carbon.ms/job

curl --request PATCH \
  --url 'https://rest.carbon.ms/job?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",
  "unitOfMeasureCode": "string",
  "locationId": "xyz789",
  "status": "string",
  "deadlineType": "string",
  "quantity": 10
}

DELETE/job

Delete a job

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/job

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

204 No Content