Get a list of all available QKBs
Returns a list of all QKBs in a specified execution environment that are available to the user.
1{2 "links": [3 {4 "method": "GET",5 "rel": "collection",6 "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs",7 "uri": "/dataQuality/environments/CAS/contexts/casqkb/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/environments/CAS/contexts/casqkb/qkbs?sortBy=name&start=0&limit=10",15 "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs?sortBy=name&start=0&limit=10",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/environments/CAS/contexts/casqkb/",23 "uri": "/dataQuality/environments/CAS/contexts/casqkb/",24 "type": "application/vnd.sas.data.quality.context"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": 267}
| Name | Type | Required | Description |
|---|---|---|---|
contextName | string | true | Specifies the name of the execution environment. |
environmentName | string | true | Specifies the name of the execution environment. |
| Name | Type | Required | Description |
|---|---|---|---|
sessionId | string | false | Specifies the session identifier. |
filter | string<filter-criteria> | false | Specifies filter criteria for the returned QKB names. 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 QKB names 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 QKB names. Sorting is supported for 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 | Specifies a 0-based index of the first QKB to return. Defaults to 0. |