Non Conformance

The non conformance resource.

Basehttps://rest.carbon.ms/nonConformance

GET/nonConformance

List non conformances

Retrieve a paginated list of non conformances. 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/nonConformance

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

Response

[
  {
    "id": "abc123def456",
    "nonConformanceId": "xyz789",
    "name": "Example",
    "source": "string",
    "status": "string",
    "content": "string",
    "locationId": "xyz789",
    "nonConformanceTypeId": "xyz789"
  }
]

GET/nonConformance

Retrieve a non conformance

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/nonConformance

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

Response

{
  "id": "abc123def456",
  "nonConformanceId": "xyz789",
  "name": "Example",
  "source": "string",
  "status": "string",
  "content": "string",
  "locationId": "xyz789",
  "nonConformanceTypeId": "xyz789"
}

POST/nonConformance

Create a non conformance

Create a new non conformance.

Body parameters

nonConformanceIdstringrequired

namestringrequired

descriptionstring

sourcenonConformanceSourcerequired

statusnonConformanceStatusrequired

prioritynonConformancePriority

approvalRequirementsnonConformanceApproval

nonConformanceWorkflowIdstring

References nonConformanceWorkflow.id

contentobjectrequired

locationIdstringrequired

References location.id

nonConformanceTypeIdstringrequired

References nonConformanceType.id

openDatedaterequired

dueDatedate

closeDatedate

quantitynumberrequired

assigneestring

References user.id

customFieldsobject

tagsarray

companyIdstring

References company.id

requiredActionIdsarray

POSThttps://rest.carbon.ms/nonConformance

curl --request POST \
  --url https://rest.carbon.ms/nonConformance \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"nonConformanceId":"xyz789","name":"Example","description":"string","source":"string","status":"string","content":"string","locationId":"xyz789","nonConformanceTypeId":"xyz789","openDate":"2026-01-01","quantity":10}'

Response

{
  "id": "abc123def456",
  "nonConformanceId": "xyz789",
  "name": "Example",
  "source": "string",
  "status": "string",
  "content": "string",
  "locationId": "xyz789",
  "nonConformanceTypeId": "xyz789"
}

PATCH/nonConformance

Update a non conformance

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

Body parameters

nonConformanceIdstringrequired

namestringrequired

descriptionstring

sourcenonConformanceSourcerequired

statusnonConformanceStatusrequired

prioritynonConformancePriority

approvalRequirementsnonConformanceApproval

nonConformanceWorkflowIdstring

References nonConformanceWorkflow.id

contentobjectrequired

locationIdstringrequired

References location.id

nonConformanceTypeIdstringrequired

References nonConformanceType.id

openDatedaterequired

dueDatedate

closeDatedate

quantitynumberrequired

assigneestring

References user.id

customFieldsobject

tagsarray

companyIdstring

References company.id

requiredActionIdsarray

PATCHhttps://rest.carbon.ms/nonConformance

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

Response

{
  "id": "abc123def456",
  "nonConformanceId": "xyz789",
  "name": "Example",
  "source": "string",
  "status": "string",
  "content": "string",
  "locationId": "xyz789",
  "nonConformanceTypeId": "xyz789"
}

DELETE/nonConformance

Delete a non conformance

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/nonConformance

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

204 No Content