The Non Conformance object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

subject string required
procedure string required
status string required
details string
process_owner string
full_name string
corrective_action string
preventive_action string
The Non Conformance object 
{
  "id": "non-conformance_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "subject": "subject_example",
  "procedure": "procedure_example",
  "status": "draft",
  "details": "details_example",
  "process_owner": "process_owner_example",
  "full_name": "full_name_example",
  "corrective_action": "corrective_action_example",
  "preventive_action": "preventive_action_example"
}
GET /api/quality_management/non-conformance/{id}

Retrieve a non conformance

Retrieves the details of an existing non conformance. Supply the unique non conformance ID that was returned from a previous request.

Path parameters

id string required

The identifier of the non conformance to retrieve.

Returns

Returns the non conformance object if a valid identifier was provided.

GET /api/quality_management/non-conformance/{id} 
curl https://api.overplane.dev/api/quality_management/non-conformance/non-conformance_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "non-conformance_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "subject": "subject_example",
  "procedure": "procedure_example",
  "status": "draft",
  "details": "details_example",
  "process_owner": "process_owner_example",
  "full_name": "full_name_example",
  "corrective_action": "corrective_action_example",
  "preventive_action": "preventive_action_example"
}
GET /api/quality_management/non-conformance

List all non conformances

Returns a list of non conformances. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of non conformance objects.

GET /api/quality_management/non-conformance 
curl https://api.overplane.dev/api/quality_management/non-conformance \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "non-conformance_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "subject": "subject_example",
      "procedure": "procedure_example",
      "status": "draft",
      "details": "details_example",
      "process_owner": "process_owner_example",
      "full_name": "full_name_example",
      "corrective_action": "corrective_action_example",
      "preventive_action": "preventive_action_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/quality_management/non-conformance

Create a non conformance

Creates a new non conformance object.

Body parameters

subject string required
procedure string required
status string required
details string
process_owner string
full_name string
corrective_action string
preventive_action string

Returns

Returns the newly created non conformance object if the call succeeded.

POST /api/quality_management/non-conformance 
curl https://api.overplane.dev/api/quality_management/non-conformance \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"subject":"subject_example","procedure":"procedure_example","status":"draft"}'
Response 
{
  "id": "non-conformance_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "subject": "subject_example",
  "procedure": "procedure_example",
  "status": "draft",
  "details": "details_example",
  "process_owner": "process_owner_example",
  "full_name": "full_name_example",
  "corrective_action": "corrective_action_example",
  "preventive_action": "preventive_action_example"
}
PATCH /api/quality_management/non-conformance/{id}

Update a non conformance

Updates the specified non conformance by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the non conformance to update.

Body parameters

subject string
procedure string
status string
details string
process_owner string
full_name string
corrective_action string
preventive_action string

Returns

Returns the updated non conformance object.

PATCH /api/quality_management/non-conformance/{id} 
curl https://api.overplane.dev/api/quality_management/non-conformance/non-conformance_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"subject":"subject_example","procedure":"procedure_example"}'
Response 
{
  "id": "non-conformance_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "subject": "subject_example",
  "procedure": "procedure_example",
  "status": "draft",
  "details": "details_example",
  "process_owner": "process_owner_example",
  "full_name": "full_name_example",
  "corrective_action": "corrective_action_example",
  "preventive_action": "preventive_action_example"
}
DELETE /api/quality_management/non-conformance/{id}

Delete a non conformance

Permanently deletes a non conformance. This cannot be undone.

Path parameters

id string required

The identifier of the non conformance to delete.

Returns

Returns a confirmation that the non conformance has been deleted.

DELETE /api/quality_management/non-conformance/{id} 
curl https://api.overplane.dev/api/quality_management/non-conformance/non-conformance_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "non-conformance_abc123",
  "deleted": true
}