Qualio Change Management API is one of 11 APIs that Qualio publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Change Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
5 operations
across 2 paths,
and defines 12 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.
5 operations2 paths12 schemas2 GET2 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 Change Management 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 5
Across 2 paths, the API surfaces 5 operations — 2 GET, 2 OPTIONS, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Change Management 5
GET
/v1/change-management/change-controls
List change controls
listChangeControls4 params→ 200400403429
OPTIONS
/v1/change-management/change-controls
Lists change controls for your Qualio instance. A change control (CC) is a formal, auditable record that documents and routes a change for review and approval â typically a change to one or more co…
listChangeControlsOptions4 params→ 200
POST
/v1/change-management/change-controls
Create a change control
createChangeControlbody→ 200400403429
GET
/v1/change-management/change-requests
List change requests
listChangeRequests4 params→ 200400403429
OPTIONS
/v1/change-management/change-requests
Lists change requests for your Qualio instance. A change request (CR) is a formal record used to propose, track, and approve changes to controlled documents. Each entry includes its code (e.g. DCR-1)…
listChangeRequestsOptions4 params→ 200
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are createdCC (7 properties), changeRequestResp (2 properties), genericBadRequestResponse (2 properties), createCC (2 properties). Each schema is shown below with its type and property counts.
changeRequestResp
object
A paginated list of change requests
2 properties2 required
statusParam
string
The status of a domain object
genericForbiddenResponse
object
1 property1 required
limitParam
number
The maximum number of results to return. This is typically used with offset to paginate results.
genericBadRequest400ParametersResponse
object
2 properties2 required
createCC
object
The request to create a change control, the sections must match those in the change control template, and position starts at 1
2 properties2 required
throttledResponse
object
1 property1 required
orderByParam
string
The field to order the results by
genericBadRequestResponse
object
2 properties2 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
createdCC
object
A successfully created change control
7 properties7 required
changeControlResp
object
A series of change control entries
2 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
