Skip to main content

GET /dqi_types

Returns a list of DQI's.

Address: GET https://instance_name/api/data/v1.3/dqi_types/

Content-type: application/json

Request body parameters

limit integer

Number of results to return per page.

offset integer

The initial index from which to return the results.

Request example

curl –i –X GET
  https://test.inspector-cloud.com/api/data/v1.3/dqi_types/ 
  -H ‘Authorization: Token <<your_token>>’
  -F "limit=1" \
  -F "offset=0"

Response example

Response code: 200

{
  "count": 12,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "uuid": "844e8e37-e4b5-4c8f-9fa8-933e3726e526",
      "cid": "DQI_IMAGE_PERSPECTIVE_ANGLE_HORIZONTAL",
      "created_at": "2021-09-22T13:27:05.049034Z",
      "updated_at": "2021-10-22T15:53:40.395212Z",
      "name": "Perspective angle horizontal",
      "description": "",
      "related_to": "IMAGE",
      "severity": "INFO",
      "threshold": 0.3
    },
    {
      "id": 2,
      "uuid": "ae2858eb-60a3-4f3e-b591-03a380615f33",
      "cid": "DQI_IMAGE_PERSPECTIVE_ANGLE_VERTICAL",
      "created_at": "2021-09-22T13:27:05.053373Z",
      "updated_at": "2021-10-22T15:53:40.396190Z",
      "name": "Perspective angle vertical",
      "description": "",
      "related_to": "IMAGE",
      "severity": "INFO",
      "threshold": 0.3
    },
    {
      "id": 3,
      "uuid": "cf6ceaa1-8ba4-45d0-9bdc-d1455f2ad2cd",
      "cid": "DQI_SCENE_INVALID_CATEGORY",
      "created_at": "2021-09-22T13:27:05.057785Z",
      "updated_at": "2021-10-22T15:53:40.392974Z",
      "name": "Invalid category",
      "description": "",
      "related_to": "SCENE",
      "severity": "INFO",
      "threshold": 0.5
    }
  ]
}

Response definitions

count integer

Required. Number of DQI's.

next string (uri) Nullable

Next page.

previous string (uri) Nullable

Previous page.

results array of objects

Required. Array of objects with information about DQI.
View nested objects

id integer (bigint)

DQI ID.

uuid string

Universal unique identifier of DQI.

cid string <= 255 символов 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 ] символов

Required. DQI name.

description string <= 255 символов Nullable

DQI description.

related_to string

Required. Indicates what the DQI indicator refers to.

severity string

DQI severity.

threshold float

Required. The threshold below or above which the DQI should not fall.