Qualio Events API is one of 11 APIs that Qualio publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Events. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
9 operations
across 4 paths,
and defines 29 schemas.
It is described by OpenAPI 3.1.0, at version 0.1.
Requests are made against a single base URL, https://api.qualio.com.
9 operations4 paths29 schemas4 GET4 OPTIONS1 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
0.1
Base URL
https://api.qualio.com
Authentication
API Key
Resource Areas
1
Authentication & Security 1
Qualio Events API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-Api-Key (api_key).
By default, every request must be authenticated.
Paths & Operations 9
Across 4 paths, the API surfaces 9 operations — 4 GET, 4 OPTIONS, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Events 9
GET
/v1/events/events/{code}
Retrieve an event
getEvent1 param→ 200400403404429
OPTIONS
/v1/events/events/{code}
Retrieves a single quality event in full detail by its code (e.g. CAPA-1, NCR-12), as shown in Qualio. A quality event is a structured record of a quality-related incident or action â such as a CAP…
getEventOptions1 param→ 200
GET
/v1/events/events
Query events
queryEvents5 params→ 200400403429
OPTIONS
/v1/events/events
Queries quality events across your Qualio instance, returning a summary of each. Quality events are structured records of quality-related incidents and actions â CAPAs, non-conformances, complaints…
queryEventsOptions5 params→ 200
POST
/v1/events/events
Create an event
createEventbody→ 200400403429
GET
/v1/events/templates
List event templates
listEventTemplates→ 200403429
OPTIONS
/v1/events/templates
Lists all effective event templates in your Qualio instance. An event template defines a type of quality event (e.g. CAPA, NCR, complaint) â its code prefix and the workflow steps that events of th…
listEventTemplatesOptions→ 200
GET
/v1/events/templates/{eventTemplateMatrixId}
Retrieve an event template
getEventTemplate1 param→ 200400403404429
OPTIONS
/v1/events/templates/{eventTemplateMatrixId}
Retrieves a single event template in full detail by its eventtemplatematrixid, including its ordered workflow steps. Steps may be form steps (with fields to complete), content steps (with sections),…
getEventTemplateOptions1 param→ 200
Schemas 29
The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are eventDetailed (15 properties), event (10 properties), eventStepForm (10 properties), eventStepContent (10 properties). Each schema is shown below with its type and property counts.
generic404
A generic response when a resource can't be found
eventTemplateFormFieldMultiOption
object
A multi-option form field in an event template
9 properties6 required
event
object
An event in Qualio, e.g. a corrective action, a complaint, a non-compliance, etc
10 properties10 required
createEventFormStep
object
A object containing form fields to populate
2 properties2 required
eventStatus
string
The status of a given event
eventStepForm
object
A form step in an event
10 properties10 required
eventDetailed
object
A more detailed view of a single event in Qualio, e.g. a corrective action, a complaint, a non-compliance, etc
15 properties15 required
offsetParam
number
A start point for the batch to be returned. For example, a value of 5 will start at the 6th element in the overall population
limitParam
number
The maximum number of results to return. This is typically used with offset to paginate results.
createEventContentStep
object
A object containing content sections to populate
2 properties2 required
eventTemplateFormField
object
A form field in an event template
8 properties5 required
genericBadRequest400ParametersResponse
object
2 properties2 required
eventTemplateContentStep
object
A content step in an event template
5 properties4 required
eventQueryResponse
object
An series of Events, based on the results of your query
2 properties2 required
eventStepTasks
object
A tasks step in an event
4 properties4 required
createEventTaskStep
object
A object containing tasks to create on the step
2 properties2 required
eventTemplateTaskStep
object
A tasks step in an event template
4 properties3 required
userIdParam
number
A unique identifier for a user in Qualio
createEventPayload
object
A request to create an event based on an event template. The eventtemplatematrixid should correspond to the type of event you wish to create, which can be foun…
4 properties2 required
eventTemplateMatrixIdParam
string
A unique identifier for an event template in Qualio, use this to filter the results by event type
throttledResponse
object
1 property1 required
eventTemplateDetailedResp
object
A detailed version of an event template, including steps
6 properties6 required
eventCode
string
A unique identifier for an Event, that includes a prefix that corresponds to its type
genericForbiddenResponse
object
1 property1 required
genericBadRequest400PathResponse
object
2 properties2 required
eventTemplateResp
object
A list of event templates for your Qualio instance
2 properties2 required
eventTemplateFormStep
object
A form step in an event template
5 properties4 required
genericBadRequestResponse
object
2 properties2 required
eventStepContent
object
A content step in an event
10 properties10 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
