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

template string required
document_type string required
document_name string required
The Quality Feedback object 
{
  "id": "quality-feedback_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "template": "template_example",
  "document_type": "document_type_example",
  "document_name": "document_name_example"
}
GET /api/quality_management/quality-feedback/{id}

Retrieve a quality feedback

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

Path parameters

id string required

The identifier of the quality feedback to retrieve.

Returns

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

GET /api/quality_management/quality-feedback/{id} 
curl https://api.overplane.dev/api/quality_management/quality-feedback/quality-feedback_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "quality-feedback_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "template": "template_example",
  "document_type": "document_type_example",
  "document_name": "document_name_example"
}
GET /api/quality_management/quality-feedback

List all quality feedbacks

Returns a list of quality feedbacks. 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 feedback objects.

GET /api/quality_management/quality-feedback 
curl https://api.overplane.dev/api/quality_management/quality-feedback \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "quality-feedback_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "template": "template_example",
      "document_type": "document_type_example",
      "document_name": "document_name_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/quality_management/quality-feedback

Create a quality feedback

Creates a new quality feedback object.

Body parameters

template string required
document_type string required
document_name string required

Returns

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

POST /api/quality_management/quality-feedback 
curl https://api.overplane.dev/api/quality_management/quality-feedback \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"template":"template_example","document_type":"document_type_example","document_name":"document_name_example"}'
Response 
{
  "id": "quality-feedback_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "template": "template_example",
  "document_type": "document_type_example",
  "document_name": "document_name_example"
}
PATCH /api/quality_management/quality-feedback/{id}

Update a quality feedback

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

Body parameters

template string
document_type string
document_name string

Returns

Returns the updated quality feedback object.

PATCH /api/quality_management/quality-feedback/{id} 
curl https://api.overplane.dev/api/quality_management/quality-feedback/quality-feedback_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"template":"template_example","document_type":"document_type_example"}'
Response 
{
  "id": "quality-feedback_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "template": "template_example",
  "document_type": "document_type_example",
  "document_name": "document_name_example"
}
DELETE /api/quality_management/quality-feedback/{id}

Delete a quality feedback

Permanently deletes a quality feedback. This cannot be undone.

Path parameters

id string required

The identifier of the quality feedback to delete.

Returns

Returns a confirmation that the quality feedback has been deleted.

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

Line items

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

Quality Feedback Parameter

Attributes

idx integer
quality_feedback_id string required
parameter string
rating string
feedback string

Endpoints

GET /api/quality_management/quality-feedback-parameter?parent_id={id}
POST /api/quality_management/quality-feedback-parameter
PATCH /api/quality_management/quality-feedback-parameter/{id}
DELETE /api/quality_management/quality-feedback-parameter/{id}
POST /api/quality_management/quality-feedback-parameter/reorder
Quality Feedback Parameter object 
{
  "id": "quality-feedback-parameter_abc123",
  "idx": 1,
  "quality_feedback_id": "quality_feedback_id_example",
  "parameter": "parameter_example",
  "rating": "1",
  "feedback": "feedback_example"
}