Jump to

• Request
• Response
• Examples

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.

Back to Top

Response

Supported Media Types

• application/json

Default Response

BML Look Function

Body ()

Root Schema : lookupFunction

Type: object

Show Source

• description: string
  Title: description

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

  Name of the lookup.
• links: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects
• lookupType: string
  Title: lookupType

  Type of the lookup.

{
    "type":"object",
    "properties":{
        "lookupType":{
            "type":"string",
            "description":"Type of the lookup.",
            "title":"lookupType"
        },
        "displayLabel":{
            "type":"string",
            "description":"Name of the lookup.",
            "title":"displayLabel"
        },
        "description":{
            "type":"string",
            "description":"Description of the lookup.",
            "title":"description"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/referenceLinks"
            }
        }
    }
}

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

Back to Top