Get All BML Attribute Lookup Values
get
/rest/v19/bml/attributeLookups/{lookupType}/lookupValues
This operation returns all BML lookup values for the specified lookup type.
Request
Path Parameters
-
lookupType(required): string
Name of the lookup to fetch.
Query Parameters
-
excludeLinks: string
Exclude specified link types.
Response
Supported Media Types
- application/json
Default Response
BML Attribute Lookup Function Values
Root Schema : Lookup values
Type:
objectTitle:
Lookup valuesLookup Values.
Show Source
-
items:
array Lookups values list
Title:
Lookups values listList of Lookups Values. -
links:
array Links to the related objects
Title:
Links to the related objectsLinks to the related objects
Nested Schema : Lookups values list
Type:
arrayTitle:
Lookups values listList of Lookups Values.
Show Source
Nested Schema : Links to the related objects
Type:
arrayTitle:
Links to the related objectsLinks to the related objects
Show Source
-
Array of:
object referenceLinks
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : attributeLookupValues
Type:
Show Source
object-
dataType:
object lookupValue
-
description:
string
Title:
descriptionDescription of the lookup. -
displayLabel:
string
Title:
displayLabelName of the lookup. -
lookupCode:
string
Title:
lookupCodeAttribute look field name.
Nested Schema : lookupValue
Type:
Show Source
object-
displayLabel:
string
Title:
displayLabelLookup value data type. -
lookupCode:
integer
Title:
lookupCodeUnique number of the lookup value.
Nested Schema : referenceLinks
Type:
objectReference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
URL to the related objectURL to the related object -
rel:
string
Title:
Link Relationship to the current objectLink Relationship to the current object
Examples
The following example shows how to retrieve all BML attribute lookup values for the specified lookup type by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json" https://sitename.oracle.com/rest/v19/bml/attributeLookups/commonVariables/lookupValues
Response Body Sample
{
"items": [{
"lookupCode": "_user_billing_city",
"displayLabel": "Current User's Billing City",
"description": "Current User's Billing City",
"dataType": {
"lookupCode": 2,
"displayLabel": "String"
}
}, {
"lookupCode": "_user_shipping_last_name",
"displayLabel": "Current User's Shipping Last Name",
"description": "Current User's Shipping Last Name",
"dataType": {
"lookupCode": 2,
"displayLabel": "String"
}
}, {
"lookupCode": "_user_shipping_zip",
"displayLabel": "Current User's Shipping Zip",
"description": "Current User's Shipping Zip",
"dataType": {
"lookupCode": 2,
"displayLabel": "String"
}
}
],
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/cpq/rest/v19/bml/attributeLookups/commonVariables/lookupValues"
}, {
"rel": "parent",
"href": "https://sitename.oracle.com/cpq/rest/v19/bml/attributeLookups/commonVariables"
}
]
}