Jump to

• Request
• Response
• Examples

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.

Back to Top

Response

Supported Media Types

• application/json

Default Response

BML Attribute Lookup Function Values

Body ()

Root Schema : Lookup values

Type: object

Title: Lookup values

Lookup Values.

Show Source

• items: array Lookups values list
  Title: Lookups values list

  List of Lookups Values.
• links: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Lookups Values.",
            "title":"Lookups values list",
            "items":{
                "$ref":"#/definitions/attributeLookupValues"
            }
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        }
    },
    "title":"Lookup values",
    "description":"Lookup Values."
}

Nested Schema : Lookups values list

Type: array

Title: Lookups values list

List of Lookups Values.

Show Source

• Array of: object attributeLookupValues

{
    "type":"array",
    "description":"List of Lookups Values.",
    "title":"Lookups values list",
    "items":{
        "$ref":"#/definitions/attributeLookupValues"
    }
}

Nested Schema : Links to the related objects

Type: array

Title: Links to the related objects

Links to the related objects

Show Source

• Array of: object referenceLinks
  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects",
    "title":"Links to the related objects",
    "items":{
        "$ref":"#/definitions/referenceLinks"
    }
}

Nested 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"
        }
    }
}

Nested Schema : referenceLinks

Type: object

Reference links for the Parent, Self, Children and Related as applicable

Show Source

• href: string
  Title: URL to the related object

  URL to the related object
• rel: string
  Title: Link Relationship to the current object

  Link Relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        }
    },
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Back to Top

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"
    }
  ]
}

Back to Top