Get a BML Lookup
get
/rest/v19/bml/lookups/{lookupType}
This operation returns 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 Look Function
Root Schema : lookupFunction
Type:
Show Source
object-
description:
string
Title:
descriptionDescription of the lookup. -
displayLabel:
string
Title:
displayLabelName of the lookup. -
links:
array Links to the related objects
Title:
Links to the related objectsLinks to the related objects -
lookupType:
string
Title:
lookupTypeType of the lookup.
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 : 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 the specified BML 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/lookups/functionCategory
Response Body Sample
{
"lookupType": "functionCategory",
"displayLabel": "Function Category",
"description": "BML Function Categories",
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups/functionCategory"
}, {
"rel": "parent",
"href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups/functionCategory/lookupValues"
}
]
}