Procedure Parameter

The procedure parameter resource.

Basehttps://rest.carbon.ms/procedureParameter

GET/procedureParameter

List procedure parameters

Retrieve a paginated list of procedure 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/procedureParameter

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

Response

[
  {
    "id": "abc123def456",
    "procedureId": "xyz789",
    "key": "string",
    "value": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string",
    "companyId": "xyz789",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]

GET/procedureParameter

Retrieve a procedure parameter

Fetch a single procedure parameter by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/procedureParameter

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

Response

{
  "id": "abc123def456",
  "procedureId": "xyz789",
  "key": "string",
  "value": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "companyId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z"
}

POST/procedureParameter

Create a procedure parameter

Create a new procedure parameter.

Body parameters

procedureIdstringrequired

References procedure.id

keystringrequired

valuestringrequired

companyIdstring

References company.id

POSThttps://rest.carbon.ms/procedureParameter

curl --request POST \
  --url https://rest.carbon.ms/procedureParameter \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"procedureId":"xyz789","key":"string","value":"string"}'

Response

{
  "id": "abc123def456",
  "procedureId": "xyz789",
  "key": "string",
  "value": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "companyId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z"
}

PATCH/procedureParameter

Update a procedure parameter

Update an existing procedure parameter, matched on `id`.

Body parameters

procedureIdstringrequired

References procedure.id

keystringrequired

valuestringrequired

companyIdstring

References company.id

PATCHhttps://rest.carbon.ms/procedureParameter

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

Response

{
  "id": "abc123def456",
  "procedureId": "xyz789",
  "key": "string",
  "value": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "companyId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z"
}

DELETE/procedureParameter

Delete a procedure parameter

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/procedureParameter

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

204 No Content