Get a list of all QKBs on all contexts

get/qkbs
Internal-Use Only

Returns a list of all available QKBs on all execution contexts that are available to the user.

Request Samples

1

Response Samples

1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "collection",
6      "href": "/dataQuality/qkbs",
7      "uri": "/dataQuality/qkbs",
8      "type": "application/vnd.sas.collection",
9      "itemType": "application/vnd.sas.data.quality.qkb"
10    },
11    {
12      "method": "GET",
13      "rel": "self",
14      "href": "/dataQuality/qkbs?start=0&limit=10&sortBy=name",
15      "uri": "/dataQuality/qkbs?start=0&limit=10&sortBy=name",
16      "type": "application/vnd.sas.collection",
17      "itemType": "application/vnd.sas.data.quality.qkb"
18    },
19    {
20      "method": "GET",
21      "rel": "up",
22      "href": "/dataQuality/",
23      "uri": "/dataQuality/",
24      "type": "application/vnd.sas.api"
25    }
26  ],
27  "name": "qkbs",
28  "accept": "application/vnd.sas.data.quality.qkb",
29  "items": [
30    {
31      "version": "1",
32      "name": "QKB_USPOCH",
33      "product": "CI",
34      "productVersion": "v27",
35      "isDefault": false,
36      "creationTimeStamp": "2017-01-06T14:59:27Z",
37      "context": "casqkb",
38      "environment": "CAS",
39      "links": [
40        {
41          "method": "GET",
42          "rel": "self",
43          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH",
44          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH",
45          "type": "application/vnd.sas.data.quality.qkb"
46        },
47        {
48          "method": "GET",
49          "rel": "up",
50          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
51          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",
52          "type": "application/vnd.sas.collection",
53          "itemType": "application/vnd.sas.data.quality.qkb"
54        },
55        {
56          "method": "GET",
57          "rel": "locales",
58          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
59          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales",
60          "type": "application/vnd.sas.collection",
61          "itemType": "application/vnd.sas.data.quality.locale"
62        }
63      ]
64    },
65    {
66      "version": "1",
67      "name": "31",
68      "productVersion": "v31",
69      "isDefault": true,
70      "context": "a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f",
71      "environment": "compute",
72      "links": [
73        {
74          "method": "GET",
75          "rel": "self",
76          "href": "/dataQuality/environments/compute/contexts/a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f/qkbs/31",
77          "uri": "/dataQuality/environments/compute/contexts/a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f/qkbs/31",
78          "type": "application/vnd.sas.data.quality.qkb"
79        },
80        {
81          "method": "GET",
82          "rel": "up",
83          "href": "/dataQuality/environments/compute/contexts/a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f/qkbs",
84          "uri": "/dataQuality/environments/compute/contexts/a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f/qkbs",
85          "type": "application/vnd.sas.collection",
86          "itemType": "application/vnd.sas.data.quality.qkb"
87        },
88        {
89          "method": "GET",
90          "rel": "locales",
91          "href": "/dataQuality/environments/compute/contexts/a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f/qkbs/31/locales",
92          "uri": "/dataQuality/environments/compute/contexts/a61e76ef-2bf9-4f87-9fbb-a85ad4b4f13f/qkbs/31/locales",
93          "type": "application/vnd.sas.collection",
94          "itemType": "application/vnd.sas.data.quality.locale"
95        }
96      ]
97    }
98  ],
99  "version": 2
100}

Query Parameters

NameTypeRequiredDescription
filter
string<filter-criteria>
false

Specifies filter criteria for the returned QKBs. Filtering is supported on the name, product, version, default, created, context, and environment fields. The supported functions are and, or, not, in, eq, lt, le, gt, ge, contains, startsWith, endsWith, and isNull. Some sample queries Filter by name starting with 'qkb': /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs?filter=startsWith(name, 'qkb') Filter by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs?filter=eq(name, 'qkb1') Filter for multiple QKBs /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs?filter=in(name, 'qkb1', 'qkb2', 'qkb')

limit
integer
false

Specifies the maximum number of QKBs to return in a single page of results. The actual number of returned QKBs can be less if the collection has been exhausted. Defaults to 10.

sortBy
string<sort-criteria>
false

Specifies sort criteria for the returned QKBs. Sorting is supported on the name, product, version, default, created, context, and environment fields. The default sort order is ascending on the name field. Some sample sorts Sort ascending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs?sortBy=name:ascending Sort descending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs?sortBy=name:descending

start
integer
false

0-based index of first QKB to return. Defaults to 0.

Responses

StatusMeaningDescription
200OKThe request succeeded. A list of available QKBs was returned.Schema