Jump to

• Request
• Response
• Examples

Get All BML Lookup Values

get

/rest/v19/bml/lookups/{lookupType}/lookupValues

This operation returns all BML lookup values for the specified lookup type.

Request

Path Parameters

• lookupType(required): string
  Name of the lookup type to fetch lookup values.

Query Parameters

• excludeLinks: string
  Exclude specified link types.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Lookup Function Values.

Body ()

Root Schema : attributeLookupValues

Type: object

Show Source

• dataType: object lookupValue
• description: string
  Title: description

  Description of the lookup.
• displayLabel: string
  Title: displayLabel

  Name of the lookup.
• lookupCode: string
  Title: lookupCode

  Attribute look field name.

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Attribute look field name.",
            "title":"lookupCode"
        },
        "displayLabel":{
            "type":"string",
            "description":"Name of the lookup.",
            "title":"displayLabel"
        },
        "description":{
            "type":"string",
            "description":"Description of the lookup.",
            "title":"description"
        },
        "dataType":{
            "description":"Parameter Data Type.",
            "title":"dataType",
            "$ref":"#/definitions/lookupValue"
        }
    }
}

Nested Schema : lookupValue

Type: object

Show Source

• displayLabel: string
  Title: displayLabel

  Lookup value data type.
• lookupCode: integer
  Title: lookupCode

  Unique number of the lookup value.

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "type":"integer",
            "description":"Unique number of the lookup value.",
            "title":"lookupCode"
        },
        "displayLabel":{
            "type":"string",
            "description":"Lookup value data type.",
            "title":"displayLabel"
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve all BML 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/lookups/functionCategory/lookupValues

Response Body Sample

{
    "items": [
        {
            "lookupCode": "ALL",
            "displayLabel": "All Functions"
        },
        {
            "lookupCode": "MATH",
            "displayLabel": "Math"
        },
        {
            "lookupCode": "URL",
            "displayLabel": "URL Access"
        },
        {
            "lookupCode": "ARRAY",
            "displayLabel": "Array"
        },
        {
            "lookupCode": "JSON",
            "displayLabel": "Json"
        },
        {
            "lookupCode": "DIRECT_DB_ACCESS",
            "displayLabel": "Direct DB Access"
        },
        {
            "lookupCode": "XML",
            "displayLabel": "XML"
        },
        {
            "lookupCode": "LOGICAL",
            "displayLabel": "Conditional"
        },
        {
            "lookupCode": "STRING",
            "displayLabel": "String"
        },
        {
            "lookupCode": "OTHERS",
            "displayLabel": "Others"
        },
        {
            "lookupCode": "DATE",
            "displayLabel": "Date"
        },
        {
            "lookupCode": "DICTIONARY",
            "displayLabel": "Dictionary"
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups/functionCategory/lookupValues"
        },
        {
            "rel": "parent",
            "href": "https://sitename.oracle.com/cpq/rest/v19/bml/lookups/functionCategory"
        }
    ]
}

Back to Top