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

goal string
date string
procedure string
status string

Default: Open

corrective_preventive string

Default: Corrective

review string
feedback string
The Quality Action object 
{
  "id": "quality-action_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "goal": "goal_example",
  "date": "2024-01-15",
  "procedure": "procedure_example",
  "status": "Open",
  "corrective_preventive": "Corrective",
  "review": "review_example",
  "feedback": "feedback_example"
}
GET /api/quality_management/quality-action/{id}

Retrieve a quality action

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

Path parameters

id string required

The identifier of the quality action to retrieve.

Returns

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

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

List all quality actions

Returns a list of quality actions. 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 action objects.

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

Create a quality action

Creates a new quality action object.

Body parameters

goal string
date string
procedure string
status string

Default: Open

corrective_preventive string

Default: Corrective

review string
feedback string

Returns

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

POST /api/quality_management/quality-action 
curl https://api.overplane.dev/api/quality_management/quality-action \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "quality-action_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "goal": "goal_example",
  "date": "2024-01-15",
  "procedure": "procedure_example",
  "status": "Open",
  "corrective_preventive": "Corrective",
  "review": "review_example",
  "feedback": "feedback_example"
}
PATCH /api/quality_management/quality-action/{id}

Update a quality action

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

Body parameters

goal string
date string
procedure string
status string

Default: Open

corrective_preventive string

Default: Corrective

review string
feedback string

Returns

Returns the updated quality action object.

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

Delete a quality action

Permanently deletes a quality action. This cannot be undone.

Path parameters

id string required

The identifier of the quality action to delete.

Returns

Returns a confirmation that the quality action has been deleted.

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

Line items

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

Quality Action Resolution

Attributes

idx integer
quality_action_id string required
problem string
resolution string
status string
responsible string
completion_by string

Endpoints

GET /api/quality_management/quality-action-resolution?parent_id={id}
POST /api/quality_management/quality-action-resolution
PATCH /api/quality_management/quality-action-resolution/{id}
DELETE /api/quality_management/quality-action-resolution/{id}
POST /api/quality_management/quality-action-resolution/reorder
Quality Action Resolution object 
{
  "id": "quality-action-resolution_abc123",
  "idx": 1,
  "quality_action_id": "quality_action_id_example",
  "problem": "problem_example",
  "resolution": "resolution_example",
  "status": "draft",
  "responsible": "responsible_example",
  "completion_by": "completion_by_example"
}