Get information about a token

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

Returns information about a token from a specified QKB, locale, function, and definition.

Request Samples

1

Response Samples

1{
2  "version": 1,
3  "name": "PO Box",
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/tokens/PO%20Box",
9      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens/PO%20Box",
10      "type": "application/vnd.sas.data.quality.token"
11    },
12    {
13      "method": "GET",
14      "rel": "up",
15      "href": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
16      "uri": "/dataQuality/environments/CAS/contexts/casqkb/qkbs/QKB_USPOCH/locales/ENUSA/functions/Match/definitions/Address/tokens",
17      "type": "application/vnd.sas.collection",
18      "itemType": "application/vnd.sas.data.quality.token"
19    }
20  ]
21}

Path Parameters

NameTypeRequiredDescription
contextName
string
true

Specifies the name of the execution environment.

definitionName
string
true

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

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

tokenName
string
true

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

Query Parameters

NameTypeRequiredDescription
sessionId
string
false

Specifies the session identifier.

Responses

StatusMeaningDescription
200OKThe request succeeded. Token information was returned for the specified context.Schema
404Not FoundThe requested token does not exist for the specified qkb, locale, function and definition.Schema