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

group_name string required
The Quality Inspection Parameter Group object 
{
  "id": "quality-inspection-parameter-group_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "group_name": "group_name_example"
}
GET /api/stock/quality-inspection-parameter-group/{id}

Retrieve a quality inspection parameter group

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

Path parameters

id string required

The identifier of the quality inspection parameter group to retrieve.

Returns

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

GET /api/stock/quality-inspection-parameter-group/{id} 
curl https://api.overplane.dev/api/stock/quality-inspection-parameter-group/quality-inspection-parameter-group_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "quality-inspection-parameter-group_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "group_name": "group_name_example"
}
GET /api/stock/quality-inspection-parameter-group

List all quality inspection parameter groups

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

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

Create a quality inspection parameter group

Creates a new quality inspection parameter group object.

Body parameters

group_name string required

Returns

Returns the newly created quality inspection parameter group object if the call succeeded.

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

Update a quality inspection parameter group

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

Body parameters

group_name string

Returns

Returns the updated quality inspection parameter group object.

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

Delete a quality inspection parameter group

Permanently deletes a quality inspection parameter group. This cannot be undone.

Path parameters

id string required

The identifier of the quality inspection parameter group to delete.

Returns

Returns a confirmation that the quality inspection parameter group has been deleted.

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