Configuration Parameter Group

The configuration parameter group resource.

Basehttps://rest.carbon.ms/configurationParameterGroup

GET/configurationParameterGroup

List configuration parameter groups

Retrieve a paginated list of configuration parameter groups. 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/configurationParameterGroup

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

Response

[
  {
    "id": "abc123def456",
    "itemId": "xyz789",
    "name": "Example",
    "sortOrder": 0,
    "isUngrouped": true,
    "companyId": "xyz789"
  }
]

GET/configurationParameterGroup

Retrieve a configuration parameter group

Fetch a single configuration parameter group by filtering on `id`.

Query parameters

idstring

Match on the configuration parameter group's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/configurationParameterGroup

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

Response

{
  "id": "abc123def456",
  "itemId": "xyz789",
  "name": "Example",
  "sortOrder": 0,
  "isUngrouped": true,
  "companyId": "xyz789"
}

POST/configurationParameterGroup

Create a configuration parameter group

Create a new configuration parameter group.

Body parameters

itemIdstringrequired

References item.id

namestringrequired

sortOrdernumberrequired

isUngroupedbooleanrequired

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/configurationParameterGroup

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

Response

{
  "id": "abc123def456",
  "itemId": "xyz789",
  "name": "Example",
  "sortOrder": 0,
  "isUngrouped": true,
  "companyId": "xyz789"
}

PATCH/configurationParameterGroup

Update a configuration parameter group

Update an existing configuration parameter group, matched on `id`.

Body parameters

itemIdstringrequired

References item.id

namestringrequired

sortOrdernumberrequired

isUngroupedbooleanrequired

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/configurationParameterGroup

curl --request PATCH \
  --url 'https://rest.carbon.ms/configurationParameterGroup?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",
  "name": "Example",
  "sortOrder": 0,
  "isUngrouped": true,
  "companyId": "xyz789"
}

DELETE/configurationParameterGroup

Delete a configuration parameter group

Delete a configuration parameter group, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the configuration parameter group to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/configurationParameterGroup

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

204 No Content