REST API Services for Oracle CPQ

Get All Pricing Lookup Values

get

/rest/v19/pricingSetup/pricingLookups/{lookupTypeVariableName}/lookupValues

Use this endpoint to retrieve all pricing lookup values for the specified lookup type.

Request

Path Parameters

lookupTypeVariableName(required): string

Query Parameters

fields: string

This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.
finder: string
Used as a predefined finder to search the collection.

Format: ?finder=<finderName>;<variableName>=<variableValue>
The following are the available finder names and corresponding finder variables:
- findByKeyword: Find lookup values using lookup type and lookup code.
  Finder Variable:
  - keyword;string:The search text.
- findLookupItems: Find active or inactive lookup values using the active field.
  Finder Variable:
  - isActive;string:The active field of the lookup value when true will return only active lookup values and false will return only inactive lookup values.
limit: integer

This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
offset: integer

Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).
orderby: string

This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "ASC" or "DESC". Specify "ASC" for ascending and "DESC" for descending. The default value is "ASC". For example, ?orderby=field1:ASC,field2:DESC.
q: string

Filter (a ???where???clause) to restrict the items returned in the collection. By default, no filtering is applied.
totalResults: boolean

The resource collection representation will include the total row count when "?totalResults=true", otherwise the count is not included. The default value is "false".

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : PricingResourceCollection_LookupValue

Type: object

Show Source

count: integer()

Title: Count

Read Only: true

The number of resource instances returned in the current range.
createdBy: Created By

Title: Created By

Read Only: true

The details of the user who created the record.
groupAccessEnabled: boolean()

Title: Group Access Enabled

Read Only: true

Indicates whether the user has access to the groups segment
hasMore: boolean()

Title: HasMore

Read Only: true

Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
items: array items
lastModifiedBy: Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.
limit: integer()

Title: Limit

Read Only: true

The actual paging size used by the server.
links: array Links

Title: Links

Read Only: true

The link relations associated with the resource instance.
offset: integer()

Title: OffSet

Read Only: true

The offset value used in the current page.
segmentLevelAccessType: string()

Title: Segment-level Access Type

Read Only: true

Segment-level Access Type
totalResults: integer()

Title: Total Results

Read Only: true

Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "properties":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LookupValue"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

Array of: object LookupValue

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LookupValue"
    }
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : UserDetails

Type: object

Show Source

emailId: string()

Title: Email Id

Email Id of the user
firstName: string()

Title: First Name

First Name of the user
lastName: string()

Title: Last Name

Last Name of the user

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : LookupValue

Type: object

Show Source

active: boolean()

Title: Active

Indicates if the lookup value is active.
createdBy: Created By

Title: Created By

Read Only: true

The details of the user who created the record.
dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

Title: Date Added

Read Only: true

Creation date of the lookup value.
dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

Title: Date Modified

Read Only: true

Last modified date of the lookup value.
description: string()

Title: Description

The description of the lookup value.
displayLabel: string()

Title: Display Label

The display label of the lookup value.
groupAccessEnabled: boolean()

Title: Group Access Enabled

Read Only: true

Indicates whether the user has access to the groups segment
id: integer()

Title: ID

Read Only: true

The ID of the lookup value.
integrationId: string()

Title: Integration ID

The integration ID of the lookup value.
lastModifiedBy: Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.
links: array Links

Title: Links

Read Only: true

The link relations associated with the resource instance.
lookupCode: string()

Title: Lookup Code

The lookup code of the lookup value.
lookupType: string()

Title: Lookup Type

The lookup type of the lookup value.
orderNumber: integer()

Title: Order Number

The position(starting from 1) in a ordered list of Lookup Values.
parentLookupCode: string()

Title: Parent Lookup Code

The parent lookup code for the lookup value.
segmentLevelAccessType: string()

Title: Segment-level Access Type

Read Only: true

Segment-level Access Type
type: string()

Title: Type

Read Only: true

Allowed Values: [ "Standard Value", "Custom Value" ]

The type of the lookup value.

{
    "properties":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the lookup value.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date of the lookup value.",
            "title":"Date Added",
            "readOnly":true
        },
        "lookupType":{
            "type":"string",
            "format":"",
            "description":"The lookup type of the lookup value.",
            "title":"Lookup Type"
        },
        "lookupCode":{
            "type":"string",
            "format":"",
            "description":"The lookup code of the lookup value.",
            "title":"Lookup Code"
        },
        "displayLabel":{
            "type":"string",
            "format":"",
            "description":"The display label of the lookup value.",
            "title":"Display Label"
        },
        "parentLookupCode":{
            "type":"string",
            "format":"",
            "description":"The parent lookup code for the lookup value.",
            "title":"Parent Lookup Code"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"The description of the lookup value.",
            "title":"Description"
        },
        "integrationId":{
            "type":"string",
            "format":"",
            "description":"The integration ID of the lookup value.",
            "title":"Integration ID"
        },
        "active":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the lookup value is active.",
            "title":"Active"
        },
        "type":{
            "type":"string",
            "format":"",
            "description":"The type of the lookup value.",
            "title":"Type",
            "readOnly":true,
            "enum":[
                "Standard Value",
                "Custom Value"
            ]
        },
        "orderNumber":{
            "type":"integer",
            "format":"",
            "description":"The position(starting from 1) in a ordered list of Lookup Values.",
            "title":"Order Number"
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The ID of the lookup value.",
            "title":"ID",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

href: string
name: string
rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Examples

The following example shows how to retrieve all pricing 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" http://sitename.oracle.com/rest/v19/pricingSetup/pricingLookups/pricePeriods/lookupValues

Response Body

{
  "items": [{
      "dateModified": "2022-12-16T02:12:35Z",
      "dateAdded": "2022-12-16T02:12:35Z",
      "lookupType": "pricePeriods",
      "lookupCode": "monthly",
      "displayLabel": "Month",
      "description": "",
      "active": true,
      "type": "Standard Value",
      "orderNumber": 0,
      "links": [{
          "rel": "self",
          "href": "http://sitename.oracle.com/rest/v19/pricingSetup/pricingLookups/pricePeriods/lookupValues/monthly"
        }, {
          "rel": "parent",
          "href": "http://sitename.oracle.com/rest/v19/pricingSetup/pricingLookups/pricePeriods/lookupValues"
        }
      ]
    }, {
      "dateModified": "2022-12-16T02:12:35Z",
      "dateAdded": "2022-12-16T02:12:35Z",
      "lookupType": "pricePeriods",
      "lookupCode": "yearly",
      "displayLabel": "Year",
      "description": "",
      "active": true,
      "type": "Standard Value",
      "orderNumber": 4,
      "links": [{
          "rel": "self",
          "href": "http://sitename.oracle.com/rest/v19/pricingSetup/pricingLookups/pricePeriods/lookupValues/yearly"
        }, {
          "rel": "parent",
          "href": "http://sitename.oracle.com/rest/v19/pricingSetup/pricingLookups/pricePeriods/lookupValues"
        }
      ]
    }
  ],
  "offset": 0,
  "limit": 1000,
  "count": 2,
  "hasMore": false,
  "links": [{
      "rel": "parent",
      "href": "http://sitename.oracle.com/rest/v19/pricingSetup/pricingLookups/pricePeriods"
    }, {
      "rel": "canonical",
      "href": "http://sitename.oracle.com/rest/v19/pricingSetup/pricingLookups/pricePeriods/lookupValues"
    }, {
      "rel": "self",
      "href": "http://sitename.oracle.com/rest/v19/pricingSetup/pricingLookups/pricePeriods/lookupValues?offset=0&limit=1000"
    }
  ]
}