Get function information

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

Returns function information for a specified locale, QKB, and execution environment.

Request Samples

1

Response Samples

1{
2  "version": 1,
3  "name": "Match",
4  "links": [
5    {
6      "method": "GET",
7      "rel": "self",
8      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match",
9      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match",
10      "type": "application/vnd.sas.data.quality.function"
11    },
12    {
13      "method": "GET",
14      "rel": "up",
15      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
16      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions",
17      "type": "application/vnd.sas.collection",
18      "itemType": "application/vnd.sas.data.quality.function"
19    },
20    {
21      "method": "GET",
22      "rel": "definitions",
23      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
24      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions",
25      "type": "application/vnd.sas.collection",
26      "itemType": "application/vnd.sas.data.quality.definition"
27    }
28  ]
29}

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 function that is supported by the locale and QKB.

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 in the specified execution environment.

Query Parameters

NameTypeRequiredDescription
sessionId
string
false

Specifies the session identifier.

Responses

StatusMeaningDescription
200OKThe request succeeded. Function information was returned for the specified locale and QKB.Schema
404Not FoundThe requested function does not exist for the specified qkb and locale.Schema