Carbon

Non Conformance Workflow

The non conformance workflow resource.

Basehttps://rest.carbon.ms/nonConformanceWorkflow
GET/nonConformanceWorkflow

List non conformance workflows

Retrieve a paginated list of non conformance workflows. 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/nonConformanceWorkflow
curl --request GET \
  --url 'https://rest.carbon.ms/nonConformanceWorkflow?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "name": "Example",
    "content": "string",
    "priority": "string",
    "source": "string",
    "active": true,
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]
GET/nonConformanceWorkflow

Retrieve a non conformance workflow

Fetch a single non conformance workflow by filtering on `id`.

Query parameters

idstring

Match on the non conformance workflow's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/nonConformanceWorkflow
curl --request GET \
  --url 'https://rest.carbon.ms/nonConformanceWorkflow?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "content": "string",
  "priority": "string",
  "source": "string",
  "active": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}
POST/nonConformanceWorkflow

Create a non conformance workflow

Create a new non conformance workflow.

Body parameters

namestringrequired
descriptionstring
contentobjectrequired
prioritynonConformancePriorityrequired
sourcenonConformanceSourcerequired
approvalRequirementsnonConformanceApproval
activebooleanrequired
tagsarray
companyIdstringrequired

References company.id

requiredActionIdsarray
POSThttps://rest.carbon.ms/nonConformanceWorkflow
curl --request POST \
  --url https://rest.carbon.ms/nonConformanceWorkflow \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","description":"string","content":"string","priority":"string","source":"string","active":true,"companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "content": "string",
  "priority": "string",
  "source": "string",
  "active": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}
PATCH/nonConformanceWorkflow

Update a non conformance workflow

Update an existing non conformance workflow, matched on `id`.

Body parameters

namestringrequired
descriptionstring
contentobjectrequired
prioritynonConformancePriorityrequired
sourcenonConformanceSourcerequired
approvalRequirementsnonConformanceApproval
activebooleanrequired
tagsarray
companyIdstringrequired

References company.id

requiredActionIdsarray
PATCHhttps://rest.carbon.ms/nonConformanceWorkflow
curl --request PATCH \
  --url 'https://rest.carbon.ms/nonConformanceWorkflow?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",
  "content": "string",
  "priority": "string",
  "source": "string",
  "active": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}
DELETE/nonConformanceWorkflow

Delete a non conformance workflow

Delete a non conformance workflow, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the non conformance workflow to delete, e.g. `eq.{id}`.

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