DQI types
Methods allow you to get a list of portal DQIs or information on a specific DQI.
GET /dqi_types
Return a list of DQIs.
Response parameters
count integer
The number of DQIs.
next string (uri) Nullable
Next page.
previous string (uri) Nullable
Previous page.
results array of objects
An array of objects with information about DQI types.
- id integer (bigint) DQI ID.
- uuid string Universal unique identifier of DQI.
- cid string <= 255 characters Nullable DQI ID in the user's system.
- created_at string (date-time) Date of creation of the DQI in the format «YYYY-MM-DDTHH:MM:SSZ».
- updated_at string (date-time) DQI update date in the format «YYYY-MM-DDTHH:MM:SSZ».
- name string [ 1 .. 255 ] characters DQI name.
- description string <= 255 characters Nullable DQI description.
- related_to string Indicates what the DQI indicator refers to.
- severity string DQI severity.
- threshold float The threshold below or above which the DQI should not fall.
GET /dqi_types/{id}
Returns information about the DQI by ID.
Response parameters
id integer (bigint)
DQI ID.
uuid string
Universal unique identifier of DQI.
cid string <= 255 characters Nullable
DQI ID in the user's system.
created_at string (date-time)
Date of creation of the DQI in the format «YYYY-MM-DDTHH:MM:SSZ».
updated_at string (date-time)
DQI update date in the format «YYYY-MM-DDTHH:MM:SSZ».
name string [ 1 .. 255 ] characters
DQI name.
description string <= 255 characters Nullable
DQI description.
related_to string
Indicates what the DQI indicator refers to.
severity string
DQI severity.
threshold float
The threshold below or above which the DQI should not fall.