Jump to

• Request
• Response
• Examples

Get All Supported Data Source Lookups

get

/rest/v19/pricingSetup/lookups/dataSources

Use this endpoint to retrieve a list lookup values for supported data sources.

Request

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:

  • findByPricingAttribute: Find datasources using pricing attribute variable name.
    Finder Variable:
    • attributeVariableName;string:The variable name of the pricing attribute.

  • findByAgreementAttribute: Find datasources using agreement attribute variable name.
    Finder Variable:
    • attributeVariableName;string:The variable name of the agreement attribute.
• 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.
• 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".

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PricingResourceCollection_PricingDataSource

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/PricingDataSource"
            }
        },
        "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 PricingDataSource

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

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 : PricingDataSource

Type: object

Show Source

• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dataSourceType: string()
  Title: DataSourceType

  Read Only: true

  Type of Data source.
• description: string
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• id: string()
  Title: Id

  Read Only: true

  The unique identifier of the Pricing DataSource.
• label: string()
  Title: Label

  Read Only: true

  The label of the Pricing DataSource.
• 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
• meaning: string
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• variableName: string()
  Title: VariableName

  Read Only: true

  The unique variable Name of the Pricing DataSource.

{
    "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"
                }
            ]
        },
        "label":{
            "type":"string",
            "format":"",
            "description":"The label of the Pricing DataSource.",
            "title":"Label",
            "readOnly":true
        },
        "dataSourceType":{
            "type":"string",
            "format":"",
            "description":"Type of Data source.",
            "title":"DataSourceType",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string",
            "format":"",
            "description":"The unique identifier of the Pricing DataSource.",
            "title":"Id",
            "readOnly":true
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"The unique variable Name of the Pricing DataSource.",
            "title":"VariableName",
            "readOnly":true
        },
        "lookupCode":{
            "type":"string"
        },
        "meaning":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

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

Back to Top

Examples

The following examples show how to retrieve a list lookup values for supported data source 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"
https://sitename.oracle.com/rest/v19/pricingSetup/lookups/dataSources

Response Body Sample

{
  "items": [{
      "label": "Oracle Quote to Order",
      "dataSourceType": "Commerce Main Doc Attributes",
      "id": "36244034",
      "variableName": "_cm_oraclecpqo_main",
      "lookupCode": "_cm_oraclecpqo_main",
      "meaning": "Commerce Main Doc Attributes",
      "description": "Oracle Quote to Order"
    }, {
      "label": "Oracle Quote to Order",
      "dataSourceType": "Commerce All Doc Attributes",
      "id": "36244034",
      "variableName": "oraclecpqo",
      "lookupCode": "oraclecpqo",
      "meaning": "Commerce All Doc Attributes",
      "description": "Oracle Quote to Order"
    }, {
      "label": "test",
      "dataSourceType": "Commerce Main Doc Attributes",
      "id": "38423181",
      "variableName": "_cm_test_main",
      "lookupCode": "_cm_test_main",
      "meaning": "Commerce Main Doc Attributes",
      "description": "test"
    }, {
      "label": "test",
      "dataSourceType": "Commerce All Doc Attributes",
      "id": "38423181",
      "variableName": "test",
      "lookupCode": "test",
      "meaning": "Commerce All Doc Attributes",
      "description": "test"
    }, {
      "label": "Item Attributes",
      "dataSourceType": "Part Custom Attributes",
      "id": "-1",
      "variableName": "PART_CUSTOM_ATTRS",
      "lookupCode": "PART_CUSTOM_ATTRS",
      "meaning": "Part Custom Attributes",
      "description": "Item Attributes"
    }, {
      "label": "Configuration : Unity INC",
      "dataSourceType": "Configuration Attributes",
      "id": "unityINC",
      "variableName": "CONFIG_ATTRS_unityINC",
      "lookupCode": "CONFIG_ATTRS_unityINC",
      "meaning": "Configuration Attributes",
      "description": "Configuration : Unity INC"
    }, {
      "label": "Configuration : Vario Tablets",
      "dataSourceType": "Configuration Attributes",
      "id": "varioTablets",
      "variableName": "CONFIG_ATTRS_varioTablets",
      "lookupCode": "CONFIG_ATTRS_varioTablets",
      "meaning": "Configuration Attributes",
      "description": "Configuration : Vario Tablets"
    }, {
      "label": "Configuration : Vision Services",
      "dataSourceType": "Configuration Attributes",
      "id": "visionServices",
      "variableName": "CONFIG_ATTRS_visionServices",
      "lookupCode": "CONFIG_ATTRS_visionServices",
      "meaning": "Configuration Attributes",
      "description": "Configuration : Vision Services"
    }, {
      "label": "Configuration : Vision Vehicles",
      "dataSourceType": "Configuration Attributes",
      "id": "visionVehicles",
      "variableName": "CONFIG_ATTRS_visionVehicles",
      "lookupCode": "CONFIG_ATTRS_visionVehicles",
      "meaning": "Configuration Attributes",
      "description": "Configuration : Vision Vehicles"
    }, {
      "label": "Configuration : All Products",
      "dataSourceType": "Configuration Attributes",
      "id": "_all_products",
      "variableName": "CONFIG_ATTRS__all_products",
      "lookupCode": "CONFIG_ATTRS__all_products",
      "meaning": "Configuration Attributes",
      "description": "Configuration : All Products"
    }
  ],
  "offset": 0,
  "limit": 1000,
  "count": 10,
  "hasMore": false,
  "links": [{
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/lookups/dataSources"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/lookups/dataSources?offset=0&limit=1000"
    }
  ]
}

Back to Top