Procedure Step

The procedure step resource.

Basehttps://rest.carbon.ms/procedureStep

GET/procedureStep

List procedure steps

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

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

Response

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

GET/procedureStep

Retrieve a procedure step

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/procedureStep

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

Response

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

POST/procedureStep

Create a procedure step

Create a new procedure step.

Body parameters

procedureIdstringrequired

References procedure.id

namestringrequired

requiredboolean

sortOrdernumberrequired

typeprocedureStepTyperequired

unitOfMeasureCodestring

minValuenumber

maxValuenumber

listValuesarray

fileTypesarray

companyIdstring

References company.id

descriptionobject

POSThttps://rest.carbon.ms/procedureStep

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

Response

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

PATCH/procedureStep

Update a procedure step

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

Body parameters

procedureIdstringrequired

References procedure.id

namestringrequired

requiredboolean

sortOrdernumberrequired

typeprocedureStepTyperequired

unitOfMeasureCodestring

minValuenumber

maxValuenumber

listValuesarray

fileTypesarray

companyIdstring

References company.id

descriptionobject

PATCHhttps://rest.carbon.ms/procedureStep

curl --request PATCH \
  --url 'https://rest.carbon.ms/procedureStep?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",
  "name": "Example",
  "sortOrder": 0,
  "type": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "required": true
}

DELETE/procedureStep

Delete a procedure step

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/procedureStep

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

204 No Content