Get a token list from a QKB

get/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens

Returns a list of tokens for a specified data quality function, definition. QKB, and locale.

Request Samples

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

Path Parameters


environmentName	string	true	Specifies the name of the execution environment.
contextName	string	true	Specifies the name of the execution environment.
qkbName	string	true	Specifies the name of the QKB in the specified execution environment.
localeName	string	true	Specifies the name of the locale that is supported by the specified QKB.
functionName	string	true	Specifies the name of the function that is supported by the specified QKB and locale.
definitionName	string	true	Specifies the name of the definition that is supported by the specified QKB and locale.

Query Parameters


filter	string<filter-criteria>	false	Specifies filter criteria for the returned tokens. 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/Address/tokens?filter=startsWith(name, 'A') Filter by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions/Match/definitions/Address/tokens?filter=eq(name, 'Extension') Filter for multiple tokens /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales?filter=in(id, 'locale1', 'locale2', 'locale3')
limit	integer	false	Specifies the maximum number of tokens to return in a single page of results. The actual number of returned tokens can be less if the collection has been exhausted. Defaults to 10.
sessionId	string	false	Specifies the session identifier.
sortBy	string<sort-criteria>	false	Specifies sort criteria for the returned tokens. The only valid sorting option is 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}/tokens?sortBy=name:ascending Sort descending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/tokens?sortBy=name:descending
start	integer	false	Specifies a 0-based index of the first locale to return. Defaults to 0.

Responses

Status	Meaning	Description
200	OK	The request succeeded. A list of available tokens was returned for the specified context.		Schema
404	Not Found	The requested definition does not exist for the specified qkb, locale and function.		Schema