Job Operation Step

The job operation step resource.

Basehttps://rest.carbon.ms/jobOperationStep

GET/jobOperationStep

List job operation steps

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

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

Response

[
  {
    "id": "abc123def456",
    "name": "Example",
    "sortOrder": 0,
    "type": "string",
    "operationId": "xyz789",
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string"
  }
]

GET/jobOperationStep

Retrieve a job operation step

Fetch a single job operation step by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/jobOperationStep

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "sortOrder": 0,
  "type": "string",
  "operationId": "xyz789",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

POST/jobOperationStep

Create a job operation step

Create a new job operation step.

Body parameters

namestringrequired

requiredboolean

sortOrdernumberrequired

typeprocedureStepTyperequired

unitOfMeasureCodestring

minValuenumber

maxValuenumber

listValuesarray

fileTypesarray

operationIdstringrequired

References jobOperation.id

companyIdstringrequired

descriptionobject

nonConformanceActionIdstring

References nonConformanceActionTask.id

nonConformanceInvestigationIdstring

POSThttps://rest.carbon.ms/jobOperationStep

curl --request POST \
  --url https://rest.carbon.ms/jobOperationStep \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","sortOrder":0,"type":"string","operationId":"xyz789","companyId":"xyz789","description":"string"}'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "sortOrder": 0,
  "type": "string",
  "operationId": "xyz789",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

PATCH/jobOperationStep

Update a job operation step

Update an existing job operation step, matched on `id`.

Body parameters

namestringrequired

requiredboolean

sortOrdernumberrequired

typeprocedureStepTyperequired

unitOfMeasureCodestring

minValuenumber

maxValuenumber

listValuesarray

fileTypesarray

operationIdstringrequired

References jobOperation.id

companyIdstringrequired

descriptionobject

nonConformanceActionIdstring

References nonConformanceActionTask.id

nonConformanceInvestigationIdstring

PATCHhttps://rest.carbon.ms/jobOperationStep

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "sortOrder": 0,
  "type": "string",
  "operationId": "xyz789",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

DELETE/jobOperationStep

Delete a job operation step

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/jobOperationStep

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

204 No Content