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

parent_id string
is_group boolean

Default: false

parent_quality_procedure string
quality_procedure_name string required
process_owner string
process_owner_full_name string
The Quality Procedure object 
{
  "id": "quality-procedure_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "parent_quality_procedure": "parent_quality_procedure_example",
  "quality_procedure_name": "quality_procedure_name_example",
  "process_owner": "process_owner_example",
  "process_owner_full_name": "process_owner_full_name_example"
}
GET /api/quality_management/quality-procedure/{id}

Retrieve a quality procedure

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

Path parameters

id string required

The identifier of the quality procedure to retrieve.

Returns

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

GET /api/quality_management/quality-procedure/{id} 
curl https://api.overplane.dev/api/quality_management/quality-procedure/quality-procedure_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "quality-procedure_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "parent_quality_procedure": "parent_quality_procedure_example",
  "quality_procedure_name": "quality_procedure_name_example",
  "process_owner": "process_owner_example",
  "process_owner_full_name": "process_owner_full_name_example"
}
GET /api/quality_management/quality-procedure

List all quality procedures

Returns a list of quality procedures. 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 procedure objects.

GET /api/quality_management/quality-procedure 
curl https://api.overplane.dev/api/quality_management/quality-procedure \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "quality-procedure_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "parent_id": null,
      "is_group": false,
      "parent_quality_procedure": "parent_quality_procedure_example",
      "quality_procedure_name": "quality_procedure_name_example",
      "process_owner": "process_owner_example",
      "process_owner_full_name": "process_owner_full_name_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/quality_management/quality-procedure

Create a quality procedure

Creates a new quality procedure object.

Body parameters

parent_id string
is_group boolean

Default: false

parent_quality_procedure string
quality_procedure_name string required
process_owner string
process_owner_full_name string

Returns

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

POST /api/quality_management/quality-procedure 
curl https://api.overplane.dev/api/quality_management/quality-procedure \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"quality_procedure_name":"quality_procedure_name_example"}'
Response 
{
  "id": "quality-procedure_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "parent_quality_procedure": "parent_quality_procedure_example",
  "quality_procedure_name": "quality_procedure_name_example",
  "process_owner": "process_owner_example",
  "process_owner_full_name": "process_owner_full_name_example"
}
PATCH /api/quality_management/quality-procedure/{id}

Update a quality procedure

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

Body parameters

parent_id string
is_group boolean

Default: false

parent_quality_procedure string
quality_procedure_name string
process_owner string
process_owner_full_name string

Returns

Returns the updated quality procedure object.

PATCH /api/quality_management/quality-procedure/{id} 
curl https://api.overplane.dev/api/quality_management/quality-procedure/quality-procedure_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"parent_id":null,"is_group":false}'
Response 
{
  "id": "quality-procedure_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "parent_quality_procedure": "parent_quality_procedure_example",
  "quality_procedure_name": "quality_procedure_name_example",
  "process_owner": "process_owner_example",
  "process_owner_full_name": "process_owner_full_name_example"
}
DELETE /api/quality_management/quality-procedure/{id}

Delete a quality procedure

Permanently deletes a quality procedure. This cannot be undone.

Path parameters

id string required

The identifier of the quality procedure to delete.

Returns

Returns a confirmation that the quality procedure has been deleted.

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

Get children

Returns the direct children of the specified node in the tree.

Path parameters

id string required

The identifier of the quality procedure to act on.

Returns

A list of direct child objects.

GET /api/quality_management/quality-procedure/{id}/children 
curl https://api.overplane.dev/api/quality_management/quality-procedure/quality-procedure_abc123/children \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "quality-procedure_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "parent_quality_procedure": "parent_quality_procedure_example",
  "quality_procedure_name": "quality_procedure_name_example",
  "process_owner": "process_owner_example",
  "process_owner_full_name": "process_owner_full_name_example"
}
GET /api/quality_management/quality-procedure/{id}/ancestors

Get ancestors

Returns all ancestors from the immediate parent up to the root of the tree.

Path parameters

id string required

The identifier of the quality procedure to act on.

Returns

A list of ancestor objects from parent to root.

GET /api/quality_management/quality-procedure/{id}/ancestors 
curl https://api.overplane.dev/api/quality_management/quality-procedure/quality-procedure_abc123/ancestors \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "quality-procedure_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "parent_quality_procedure": "parent_quality_procedure_example",
  "quality_procedure_name": "quality_procedure_name_example",
  "process_owner": "process_owner_example",
  "process_owner_full_name": "process_owner_full_name_example"
}
GET /api/quality_management/quality-procedure/{id}/descendants

Get descendants

Returns all descendants of the specified node in the tree.

Path parameters

id string required

The identifier of the quality procedure to act on.

Returns

A list of all descendant objects.

GET /api/quality_management/quality-procedure/{id}/descendants 
curl https://api.overplane.dev/api/quality_management/quality-procedure/quality-procedure_abc123/descendants \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "quality-procedure_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "parent_quality_procedure": "parent_quality_procedure_example",
  "quality_procedure_name": "quality_procedure_name_example",
  "process_owner": "process_owner_example",
  "process_owner_full_name": "process_owner_full_name_example"
}

Line items

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

Quality Procedure Process

Attributes

idx integer
quality_procedure_id string required
process_description string
procedure string

Endpoints

GET /api/quality_management/quality-procedure-process?parent_id={id}
POST /api/quality_management/quality-procedure-process
PATCH /api/quality_management/quality-procedure-process/{id}
DELETE /api/quality_management/quality-procedure-process/{id}
POST /api/quality_management/quality-procedure-process/reorder
Quality Procedure Process object 
{
  "id": "quality-procedure-process_abc123",
  "idx": 1,
  "quality_procedure_id": "quality_procedure_id_example",
  "process_description": "process_description_example",
  "procedure": "procedure_example"
}