Quality Document

The quality document resource.

Basehttps://rest.carbon.ms/qualityDocument

GET/qualityDocument

List quality documents

Retrieve a paginated list of quality documents. 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/qualityDocument

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

Response

[
  {
    "id": "abc123def456",
    "name": "Example",
    "version": 0,
    "status": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string",
    "description": "string",
    "content": "string"
  }
]

GET/qualityDocument

Retrieve a quality document

Fetch a single quality document by filtering on `id`.

Query parameters

idstring

Match on the quality document's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/qualityDocument

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "version": 0,
  "status": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "description": "string",
  "content": "string"
}

POST/qualityDocument

Create a quality document

Create a new quality document.

Body parameters

namestringrequired

descriptionstring

versionnumberrequired

statusqualityDocumentStatusrequired

contentobject

assigneestring

References user.id

companyIdstring

References company.id

tagsarray

POSThttps://rest.carbon.ms/qualityDocument

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "version": 0,
  "status": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "description": "string",
  "content": "string"
}

PATCH/qualityDocument

Update a quality document

Update an existing quality document, matched on `id`.

Body parameters

namestringrequired

descriptionstring

versionnumberrequired

statusqualityDocumentStatusrequired

contentobject

assigneestring

References user.id

companyIdstring

References company.id

tagsarray

PATCHhttps://rest.carbon.ms/qualityDocument

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "version": 0,
  "status": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "description": "string",
  "content": "string"
}

DELETE/qualityDocument

Delete a quality document

Delete a quality document, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the quality document to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/qualityDocument

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

204 No Content