Get a locale list

get/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales

Returns a list of the locales in a specified QKB and execution environment.

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

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.

Query Parameters


filter	string<filter-criteria>	false	Specifies filter criteria for the returned locales. Filtering is supported on the name and description 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 'EN': /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales?filter=startsWith(name, 'EN') Filter by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales?filter=eq(name, 'AFZAF') Filter for multiple locales /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales?filter=in(name, 'ENUSA', 'ENGBR')
limit	integer	false	Specifies the maximum number of locales to return in a single page of results. The actual number of returned locales 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 locales. Sorting is supported on the name and description fields. 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?sortBy=name:ascending Sort descending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales?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 locales was successfully returned.		Schema
404	Not Found	The requested qkb does not exist for the given environment and context.		Schema