Carbon

Job Operation Parameter

The job operation parameter resource.

Basehttps://rest.carbon.ms/jobOperationParameter
GET/jobOperationParameter

List job operation parameters

Retrieve a paginated list of job operation parameters. 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/jobOperationParameter
curl --request GET \
  --url 'https://rest.carbon.ms/jobOperationParameter?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "key": "string",
    "value": "string",
    "operationId": "xyz789",
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]
GET/jobOperationParameter

Retrieve a job operation parameter

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/jobOperationParameter
curl --request GET \
  --url 'https://rest.carbon.ms/jobOperationParameter?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "key": "string",
  "value": "string",
  "operationId": "xyz789",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}
POST/jobOperationParameter

Create a job operation parameter

Create a new job operation parameter.

Body parameters

keystringrequired
valuestringrequired
operationIdstringrequired

References jobOperation.id

companyIdstringrequired
POSThttps://rest.carbon.ms/jobOperationParameter
curl --request POST \
  --url https://rest.carbon.ms/jobOperationParameter \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"key":"string","value":"string","operationId":"xyz789","companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "key": "string",
  "value": "string",
  "operationId": "xyz789",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}
PATCH/jobOperationParameter

Update a job operation parameter

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

Body parameters

keystringrequired
valuestringrequired
operationIdstringrequired

References jobOperation.id

companyIdstringrequired
PATCHhttps://rest.carbon.ms/jobOperationParameter
curl --request PATCH \
  --url 'https://rest.carbon.ms/jobOperationParameter?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"key":"string"}'
Response
{
  "id": "abc123def456",
  "key": "string",
  "value": "string",
  "operationId": "xyz789",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}
DELETE/jobOperationParameter

Delete a job operation parameter

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

Query parameters

idstring

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

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