Jobs

The jobs resource.

Basehttps://rest.carbon.ms/jobs

GET/jobs

List jobss

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

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

Response

[
  {
    "id": "abc123def456",
    "jobMakeMethodId": "xyz789",
    "modelId": "xyz789",
    "name": "Example",
    "jobId": "xyz789",
    "itemId": "xyz789",
    "unitOfMeasureCode": "string",
    "customerId": "xyz789"
  }
]

GET/jobs

Retrieve a jobs

Fetch a single jobs by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/jobs

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

Response

{
  "id": "abc123def456",
  "jobMakeMethodId": "xyz789",
  "modelId": "xyz789",
  "name": "Example",
  "jobId": "xyz789",
  "itemId": "xyz789",
  "unitOfMeasureCode": "string",
  "customerId": "xyz789"
}