Get definition information

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

Returns definition information for a given QKB, locale, and function.

Request Samples

1

Response Samples

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

Path Parameters

NameTypeRequiredDescription
contextName
string
true

Specifies the name of the execution environment.

definitionName
string
true

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

environmentName
string
true

Specifies the name of the execution environment.

functionName
string
true

Specifies the name of the function 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 in the specified execution environment.

Query Parameters

NameTypeRequiredDescription
sessionId
string
false

Specifies the session identifier.

Responses

StatusMeaningDescription
200OKThe request succeeded. Information was returned for the specified data quality definition.Schema
404Not FoundThe requested definition does not exist for the specified qkb, locale and function.Schema