The Quality Review 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.

date string
procedure string
additional_information string
status string

Default: Open

goal string required
The Quality Review object 
{
  "id": "quality-review_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "date": "2024-01-15",
  "procedure": "procedure_example",
  "additional_information": "additional_information_example",
  "status": "Open",
  "goal": "goal_example"
}
GET /api/quality_management/quality-review/{id}

Retrieve a quality review

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

Path parameters

id string required

The identifier of the quality review to retrieve.

Returns

Returns the quality review object if a valid identifier was provided.

GET /api/quality_management/quality-review/{id} 
curl https://api.overplane.dev/api/quality_management/quality-review/quality-review_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "quality-review_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "date": "2024-01-15",
  "procedure": "procedure_example",
  "additional_information": "additional_information_example",
  "status": "Open",
  "goal": "goal_example"
}
GET /api/quality_management/quality-review

List all quality reviews

Returns a list of quality reviews. 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 quality review objects.

GET /api/quality_management/quality-review 
curl https://api.overplane.dev/api/quality_management/quality-review \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "quality-review_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "date": "2024-01-15",
      "procedure": "procedure_example",
      "additional_information": "additional_information_example",
      "status": "Open",
      "goal": "goal_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/quality_management/quality-review

Create a quality review

Creates a new quality review object.

Body parameters

date string
procedure string
additional_information string
status string

Default: Open

goal string required

Returns

Returns the newly created quality review object if the call succeeded.

POST /api/quality_management/quality-review 
curl https://api.overplane.dev/api/quality_management/quality-review \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"goal":"goal_example"}'
Response 
{
  "id": "quality-review_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "date": "2024-01-15",
  "procedure": "procedure_example",
  "additional_information": "additional_information_example",
  "status": "Open",
  "goal": "goal_example"
}
PATCH /api/quality_management/quality-review/{id}

Update a quality review

Updates the specified quality review 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 quality review to update.

Body parameters

date string
procedure string
additional_information string
status string

Default: Open

goal string

Returns

Returns the updated quality review object.

PATCH /api/quality_management/quality-review/{id} 
curl https://api.overplane.dev/api/quality_management/quality-review/quality-review_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"date":"2024-01-15","procedure":"procedure_example"}'
Response 
{
  "id": "quality-review_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "date": "2024-01-15",
  "procedure": "procedure_example",
  "additional_information": "additional_information_example",
  "status": "Open",
  "goal": "goal_example"
}
DELETE /api/quality_management/quality-review/{id}

Delete a quality review

Permanently deletes a quality review. This cannot be undone.

Path parameters

id string required

The identifier of the quality review to delete.

Returns

Returns a confirmation that the quality review has been deleted.

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

Line items

Child objects that belong to this quality review. These are accessed via the parent's ID.

Quality Review Objective

Attributes

idx integer
quality_review_id string required
objective string
target string
uom string
review string
status string

Endpoints

GET /api/quality_management/quality-review-objective?parent_id={id}
POST /api/quality_management/quality-review-objective
PATCH /api/quality_management/quality-review-objective/{id}
DELETE /api/quality_management/quality-review-objective/{id}
POST /api/quality_management/quality-review-objective/reorder
Quality Review Objective object 
{
  "id": "quality-review-objective_abc123",
  "idx": 1,
  "quality_review_id": "quality_review_id_example",
  "objective": "objective_example",
  "target": "target_example",
  "uom": "uom_example",
  "review": "review_example",
  "status": "Open"
}