Get a list of data quality definitions

get/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions
Internal-Use Only

Returns a list of data quality definitions that are supported by a specified locale and QKB.

Request Samples

1

Response Samples

1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "collection",
6      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
7      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
8      "type": "application/vnd.sas.collection",
9      "itemType": "application/vnd.sas.data.quality.definition"
10    },
11    {
12      "method": "GET",
13      "rel": "next",
14      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions?sortBy=name&start=2&limit=2",
15      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions?sortBy=name&start=2&limit=2",
16      "type": "application/vnd.sas.collection",
17      "itemType": "application/vnd.sas.data.quality.definition"
18    },
19    {
20      "method": "GET",
21      "rel": "last",
22      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions?sortBy=name&start=24&limit=2",
23      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions?sortBy=name&start=24&limit=2",
24      "type": "application/vnd.sas.collection",
25      "itemType": "application/vnd.sas.data.quality.definition"
26    },
27    {
28      "method": "GET",
29      "rel": "self",
30      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions?sortBy=name&start=0&limit=2",
31      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions?sortBy=name&start=0&limit=2",
32      "type": "application/vnd.sas.collection",
33      "itemType": "application/vnd.sas.data.quality.definition"
34    },
35    {
36      "method": "GET",
37      "rel": "up",
38      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/",
39      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/",
40      "type": "application/vnd.sas.data.quality.function"
41    }
42  ],
43  "name": "definitions",
44  "accept": "application/vnd.sas.data.quality.definition",
45  "items": [
46    {
47      "version": 1,
48      "name": "Account Number",
49      "links": [
50        {
51          "method": "GET",
52          "rel": "self",
53          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Account%20Number",
54          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Account%20Number",
55          "type": "application/vnd.sas.data.quality.definition"
56        },
57        {
58          "method": "GET",
59          "rel": "up",
60          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
61          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
62          "type": "application/vnd.sas.collection",
63          "itemType": "application/vnd.sas.data.quality.definition"
64        },
65        {
66          "method": "GET",
67          "rel": "tokens",
68          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Account%20Number/tokens",
69          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Account%20Number/tokens",
70          "type": "application/vnd.sas.collection",
71          "itemType": "application/vnd.sas.data.quality.token"
72        }
73      ]
74    },
75    {
76      "version": 1,
77      "name": "Address",
78      "links": [
79        {
80          "method": "GET",
81          "rel": "self",
82          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address",
83          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address",
84          "type": "application/vnd.sas.data.quality.definition"
85        },
86        {
87          "method": "GET",
88          "rel": "up",
89          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
90          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
91          "type": "application/vnd.sas.collection",
92          "itemType": "application/vnd.sas.data.quality.definition"
93        },
94        {
95          "method": "GET",
96          "rel": "tokens",
97          "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
98          "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
99          "type": "application/vnd.sas.collection",
100          "itemType": "application/vnd.sas.data.quality.token"
101        }
102      ]
103    }
104  ],
105  "version": 2
106}

Path Parameters

NameTypeRequiredDescription
contextName
string
true

Specifies the name of the execution environment.

environmentName
string
true

Specifies the name of the execution environment.

functionName
string
true

Specifies the name of the data quality definition that is supported by the specified QKB and locale.

localeName
string
true

Specifies the name of the locale that is supported by the specified QKB.

qkbName
string
true

Specifies the name of the QKB that is available in the specified execution environment.

Query Parameters

NameTypeRequiredDescription
sessionId
string
false

Specifies the session identifier.

filter
string<filter-criteria>
false

Specifies filter criteria for the returned definitions. Filtering is supported on the name field. 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 'A': /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions/Match/definitions?filter=startsWith(name, 'A') Filter by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions/Match/definitions?filter=eq(name, 'Account Number') Search for multiple definitions /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions/Match/definitions?filter=in(name, 'Account Number', 'Address', 'Business Title')

limit
integer
false

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

sortBy
string<sort-criteria>
false

Specifies sort criteria for the returned definitions. Sorting is supported on the name field. The default sort order is ascending on the name field. Some sample sorts Sort ascending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions/Match/definitions?sortBy=id:ascendingSort descending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions/Match/definitions?sortBy=name:descending

start
integer
false

Specifies a 0-based index of the first definition to return. Defaults to 0.

Responses

StatusMeaningDescription
200OKThe request succeeded. Data quality definitions were returned for the specified QKB and locale.Schema
404Not FoundThe requested function does not exist for the specified qkb and locale.Schema