Batch Property

The batch property resource.

Basehttps://rest.carbon.ms/batchProperty

GET/batchProperty

List batch propertys

Retrieve a paginated list of batch propertys. 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/batchProperty

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

Response

[
  {
    "id": "abc123def456",
    "itemId": "xyz789",
    "label": "string",
    "dataType": "string",
    "sortOrder": 0,
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string"
  }
]

GET/batchProperty

Retrieve a batch property

Fetch a single batch property by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/batchProperty

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

Response

{
  "id": "abc123def456",
  "itemId": "xyz789",
  "label": "string",
  "dataType": "string",
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

POST/batchProperty

Create a batch property

Create a new batch property.

Body parameters

itemIdstringrequired

References item.id

labelstringrequired

dataTypeconfigurationParameterDataTyperequired

listOptionsarray

sortOrdernumberrequired

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/batchProperty

curl --request POST \
  --url https://rest.carbon.ms/batchProperty \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"itemId":"xyz789","label":"string","dataType":"string","sortOrder":0,"companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "itemId": "xyz789",
  "label": "string",
  "dataType": "string",
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

PATCH/batchProperty

Update a batch property

Update an existing batch property, matched on `id`.

Body parameters

itemIdstringrequired

References item.id

labelstringrequired

dataTypeconfigurationParameterDataTyperequired

listOptionsarray

sortOrdernumberrequired

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/batchProperty

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

Response

{
  "id": "abc123def456",
  "itemId": "xyz789",
  "label": "string",
  "dataType": "string",
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

DELETE/batchProperty

Delete a batch property

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/batchProperty

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

204 No Content