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

status string

Default: Open

The Quality Meeting object 
{
  "id": "quality-meeting_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "Open"
}
GET /api/quality_management/quality-meeting/{id}

Retrieve a quality meeting

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

Path parameters

id string required

The identifier of the quality meeting to retrieve.

Returns

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

GET /api/quality_management/quality-meeting/{id} 
curl https://api.overplane.dev/api/quality_management/quality-meeting/quality-meeting_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "quality-meeting_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "Open"
}
GET /api/quality_management/quality-meeting

List all quality meetings

Returns a list of quality meetings. 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 meeting objects.

GET /api/quality_management/quality-meeting 
curl https://api.overplane.dev/api/quality_management/quality-meeting \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "quality-meeting_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "Open"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/quality_management/quality-meeting

Create a quality meeting

Creates a new quality meeting object.

Body parameters

status string

Default: Open

Returns

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

POST /api/quality_management/quality-meeting 
curl https://api.overplane.dev/api/quality_management/quality-meeting \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "quality-meeting_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "Open"
}
PATCH /api/quality_management/quality-meeting/{id}

Update a quality meeting

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

Body parameters

status string

Default: Open

Returns

Returns the updated quality meeting object.

PATCH /api/quality_management/quality-meeting/{id} 
curl https://api.overplane.dev/api/quality_management/quality-meeting/quality-meeting_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"Open"}'
Response 
{
  "id": "quality-meeting_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "Open"
}
DELETE /api/quality_management/quality-meeting/{id}

Delete a quality meeting

Permanently deletes a quality meeting. This cannot be undone.

Path parameters

id string required

The identifier of the quality meeting to delete.

Returns

Returns a confirmation that the quality meeting has been deleted.

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

Line items

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

Quality Meeting Agenda

Attributes

idx integer
quality_meeting_id string required
agenda string

Endpoints

GET /api/quality_management/quality-meeting-agenda?parent_id={id}
POST /api/quality_management/quality-meeting-agenda
PATCH /api/quality_management/quality-meeting-agenda/{id}
DELETE /api/quality_management/quality-meeting-agenda/{id}
POST /api/quality_management/quality-meeting-agenda/reorder
Quality Meeting Agenda object 
{
  "id": "quality-meeting-agenda_abc123",
  "idx": 1,
  "quality_meeting_id": "quality_meeting_id_example",
  "agenda": "agenda_example"
}

Quality Meeting Minutes

Attributes

idx integer
quality_meeting_id string required
minute string
document_type string required
document_name string

Endpoints

GET /api/quality_management/quality-meeting-minutes?parent_id={id}
POST /api/quality_management/quality-meeting-minutes
PATCH /api/quality_management/quality-meeting-minutes/{id}
DELETE /api/quality_management/quality-meeting-minutes/{id}
POST /api/quality_management/quality-meeting-minutes/reorder
Quality Meeting Minutes object 
{
  "id": "quality-meeting-minutes_abc123",
  "idx": 1,
  "quality_meeting_id": "quality_meeting_id_example",
  "minute": "minute_example",
  "document_type": "document_type_example",
  "document_name": "document_name_example"
}