DQI types

methods allow you to get a list of portal dqis or information on a specific dqi get get /dqi types return a list of dqis { "tab" "request", "url" "https //instance name/api/data/v1 1/dqi types/", "name" "request example", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[ { "kind" "optional", "name" "limit", "type" "integer", "description" "the number of results to return per page " }, { "kind" "optional", "name" "offset", "type" "integer", "description" "the initial index from which to return the results " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "fj3zsbaijz6tuvfi40xny", "code" "{\n \\"count\\" 12,\n \\"next\\"\ null,\n \\"previous\\"\ null,\n \\"results\\" \[\n {\n \\"id\\" 1,\n \\"uuid\\" \\"844e8e37 e4b5 4c8f 9fa8 933e3726e526\\",\n \\"cid\\" \\"dqi image perspective angle horizontal\\",\n \\"created at\\" \\"2021 09 22t13 27 05 049034z\\",\n \\"updated at\\" \\"2021 10 22t15 53 40 395212z\\",\n \\"name\\" \\"perspective angle horizontal\\",\n \\"description\\" \\"\\",\n \\"related to\\" \\"image\\",\n \\"severity\\" \\"info\\",\n \\"threshold\\" 0 3\n },\n {\n \\"id\\" 2,\n \\"uuid\\" \\"ae2858eb 60a3 4f3e b591 03a380615f33\\",\n \\"cid\\" \\"dqi image perspective angle vertical\\",\n \\"created at\\" \\"2021 09 22t13 27 05 053373z\\",\n \\"updated at\\" \\"2021 10 22t15 53 40 396190z\\",\n \\"name\\" \\"perspective angle vertical\\",\n \\"description\\" \\"\\",\n \\"related to\\" \\"image\\",\n \\"severity\\" \\"info\\",\n \\"threshold\\" 0 3\n },\n {\n \\"id\\" 3,\n \\"uuid\\" \\"cf6ceaa1 8ba4 45d0 9bdc d1455f2ad2cd\\",\n \\"cid\\" \\"dqi scene invalid category\\",\n \\"created at\\" \\"2021 09 22t13 27 05 057785z\\",\n \\"updated at\\" \\"2021 10 22t15 53 40 392974z\\",\n \\"name\\" \\"invalid category\\",\n \\"description\\" \\"\\",\n \\"related to\\" \\"scene\\",\n \\"severity\\" \\"info\\",\n \\"threshold\\" 0 5\n }\n ]\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "fj3zsbaijz6tuvfi40xny" }, "examples" { "languages" \[ { "id" "dpmodah zaotktusexn5x", "code" "curl –i –x get\n https //test eyrene com/api/data/v1 1/dqi types/\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’\n f \\"limit=1\\" \\\\\n f \\"offset=0\\" ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "dpmodah zaotktusexn5x" }, "description" "get /dqi types", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } response parameters ​ https //help inspector cloud com/en/docs/api/backend/methods/v1/agents/agents list#response definitions count integer the number of dqis next string (uri) nullable nullable next page previous string (uri) nullable 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 <= 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 ] \[ 1 255 ] characters characters dqi name description string <= 255 characters nullable <= 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 get /dqi types/{id} returns information about the dqi by id { "tab" "request", "url" "https //instance name/api/data/v1 1/dqi types/{id}", "name" "request example", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "dqi id " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "fj3zsbaijz6tuvfi40xny", "code" "{\n \\"id\\" 1979894965,\n \\"uuid\\" \\"844e8e37 e4b5 4c8f 9fa8 933e3726e526\\",\n \\"cid\\" \\"dqi image perspective angle horizontal\\",\n \\"created at\\" \\"2021 09 22t13 27 05 049034z\\",\n \\"updated at\\" \\"2021 10 22t15 53 40 395212z\\",\n \\"name\\" \\"perspective angle horizontal\\",\n \\"description\\" \\"\\",\n \\"related to\\" \\"image\\",\n \\"severity\\" \\"info\\",\n \\"threshold\\" 0 3\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "fj3zsbaijz6tuvfi40xny" }, "examples" { "languages" \[ { "id" "dpmodah zaotktusexn5x", "code" "curl –i –x get\n https //test eyrene com/api/data/v1 1/dqi types/1979894965/\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "dpmodah zaotktusexn5x" }, "description" "get /dqi types/{id}", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } response parameters id integer (bigint) dqi id uuid string universal unique identifier of dqi cid string <= 255 characters nullable <= 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 ] \[ 1 255 ] characters characters dqi name description string <= 255 characters nullable <= 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