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

frequency string

Default: None

procedure string
date string
weekday string
goal string required
The Quality Goal object 
{
  "id": "quality-goal_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "frequency": "None",
  "procedure": "procedure_example",
  "date": "2024-01-15",
  "weekday": "weekday_example",
  "goal": "goal_example"
}
GET /api/quality_management/quality-goal/{id}

Retrieve a quality goal

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

Path parameters

id string required

The identifier of the quality goal to retrieve.

Returns

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

GET /api/quality_management/quality-goal/{id} 
curl https://api.overplane.dev/api/quality_management/quality-goal/quality-goal_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "quality-goal_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "frequency": "None",
  "procedure": "procedure_example",
  "date": "2024-01-15",
  "weekday": "weekday_example",
  "goal": "goal_example"
}
GET /api/quality_management/quality-goal

List all quality goals

Returns a list of quality goals. 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 goal objects.

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

Create a quality goal

Creates a new quality goal object.

Body parameters

frequency string

Default: None

procedure string
date string
weekday string
goal string required

Returns

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

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

Update a quality goal

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

Body parameters

frequency string

Default: None

procedure string
date string
weekday string
goal string

Returns

Returns the updated quality goal object.

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

Delete a quality goal

Permanently deletes a quality goal. This cannot be undone.

Path parameters

id string required

The identifier of the quality goal to delete.

Returns

Returns a confirmation that the quality goal has been deleted.

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

Line items

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

Quality Goal Objective

Attributes

idx integer
quality_goal_id string required
objective string required
target string
uom string

Endpoints

GET /api/quality_management/quality-goal-objective?parent_id={id}
POST /api/quality_management/quality-goal-objective
PATCH /api/quality_management/quality-goal-objective/{id}
DELETE /api/quality_management/quality-goal-objective/{id}
POST /api/quality_management/quality-goal-objective/reorder
Quality Goal Objective object 
{
  "id": "quality-goal-objective_abc123",
  "idx": 1,
  "quality_goal_id": "quality_goal_id_example",
  "objective": "objective_example",
  "target": "target_example",
  "uom": "uom_example"
}