Get supported functions for a locale

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

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

Path Parameters

environmentName
string
true

Specifies the name of an execution environment.

contextName
string
true

Specifies the name of an execution environment.

qkbName
string
true

Specifies the name of a QKB in the specified execution environment.

localeName
string
true

Specifies the name of a locale in the specified QKB.

Query Parameters

filter
string<filter-criteria>
false

Specifies filter criteria for the returned functions.
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

  • Search by name starting with 'M': /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions?filter=startsWith(name, 'M')
  • Search by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions?filter=eq(name, 'Standardization')
  • Filter for multiple functions /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions?filter=in(name, 'Match','Standardization')

limit
integer
false

Specifies the maximum number of functions to return in a single page of results. The actual number of returned functions 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 functions.
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?sortBy=name:ascending
  • Sort descending by name /dataQuality/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/ENUSA/functions?sortBy=name:descending

start
integer
false

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

Responses

StatusMeaningDescription
200OK

The request succeeded. A list of available functions was returned for the specified locale and QKB.

Schema
404Not Found

The requested locale does not exist for the specified qkb.

Schema