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

quality_inspection_template_name string required
The Quality Inspection Template object 
{
  "id": "quality-inspection-template_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "quality_inspection_template_name": "quality_inspection_template_name_example"
}
GET /api/stock/quality-inspection-template/{id}

Retrieve a quality inspection template

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

Path parameters

id string required

The identifier of the quality inspection template to retrieve.

Returns

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

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

List all quality inspection templates

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

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

Create a quality inspection template

Creates a new quality inspection template object.

Body parameters

quality_inspection_template_name string required

Returns

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

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

Update a quality inspection template

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

Body parameters

quality_inspection_template_name string

Returns

Returns the updated quality inspection template object.

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

Delete a quality inspection template

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

Path parameters

id string required

The identifier of the quality inspection template to delete.

Returns

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

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

Line items

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

Item Quality Inspection Parameter

Attributes

idx integer
quality_inspection_template_id string required
specification string required
value string
acceptance_formula string
formula_based_criteria boolean
min_value number
max_value number
numeric boolean
parameter_group string

Endpoints

GET /api/stock/item-quality-inspection-parameter?parent_id={id}
POST /api/stock/item-quality-inspection-parameter
PATCH /api/stock/item-quality-inspection-parameter/{id}
DELETE /api/stock/item-quality-inspection-parameter/{id}
POST /api/stock/item-quality-inspection-parameter/reorder
Item Quality Inspection Parameter object 
{
  "id": "item-quality-inspection-parameter_abc123",
  "idx": 1,
  "quality_inspection_template_id": "quality_inspection_template_id_example",
  "specification": "specification_example",
  "value": "value_example",
  "acceptance_formula": "acceptance_formula_example",
  "formula_based_criteria": false,
  "min_value": 0,
  "max_value": 0,
  "numeric": true,
  "parameter_group": "parameter_group_example"
}