The Quality Feedback Template 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
The Quality Feedback Template object 
{
  "id": "quality-feedback-template_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "template": "template_example"
}
GET /api/quality_management/quality-feedback-template/{id}

Retrieve a quality feedback template

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

Path parameters

id string required

The identifier of the quality feedback template to retrieve.

Returns

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

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

List all quality feedback templates

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

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

Create a quality feedback template

Creates a new quality feedback template object.

Body parameters

template string required

Returns

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

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

Update a quality feedback template

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

Body parameters

template string

Returns

Returns the updated quality feedback template object.

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

Delete a quality feedback template

Permanently deletes a quality feedback template. This cannot be undone.

Path parameters

id string required

The identifier of the quality feedback template to delete.

Returns

Returns a confirmation that the quality feedback template has been deleted.

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

Line items

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

Quality Feedback Template Parameter

Attributes

idx integer
quality_feedback_template_id string required
parameter string

Endpoints

GET /api/quality_management/quality-feedback-template-parameter?parent_id={id}
POST /api/quality_management/quality-feedback-template-parameter
PATCH /api/quality_management/quality-feedback-template-parameter/{id}
DELETE /api/quality_management/quality-feedback-template-parameter/{id}
POST /api/quality_management/quality-feedback-template-parameter/reorder
Quality Feedback Template Parameter object 
{
  "id": "quality-feedback-template-parameter_abc123",
  "idx": 1,
  "quality_feedback_template_id": "quality_feedback_template_id_example",
  "parameter": "parameter_example"
}