Get Pricing Attributes

get

/rest/v16/pricingSetup/attributes

Use this endpoint to retrieve a list of all pricing attributes.

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). More than one child can be specified using comma as a separator. Example: ?expand=mappings. To include all the children and grandchildren, specify the value of this query parameter to be "all".
  • This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.
  • Used as a predefined finder to search the collection.
    Format: ?finder=<finderName>;<VarName>=<variableValue>
    The following are the available finder names and corresponding finder variables:
    • findByKeyword: Find pricing attributes using name,VarName and attributeLevel.
      Finder Variable:
      • keyword;string: The search text. The character '%' if present will be treated as a wild card otherwise, the default is 'contains' search
  • 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.
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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.
  • Filter (a 'where' clause) to restrict the items returned in the collection. By default, no filtering is applied.
  • 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

200 Response

Success
Body ()
Root Schema : PricingResourceCollection_PricingAttribute
Type: object
Show Source
  • Title: Count
    Read Only: true
    The number of resource instances returned in the current range.
  • Created By
    Title: Created By
    Read Only: true
    The details of the user who created the record.
  • 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
  • Last Modified By
    Title: Last Modified By
    Read Only: true
    The details of the user who modified the record.
  • Title: Limit
    Read Only: true
    The actual paging size used by the server.
  • Links
  • Title: OffSet
    Read Only: true
    The offset value used in the current page.
  • 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.
Nested Schema : Created By
Title: Created By
Read Only: true
The details of the user who created the record.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Last Modified By
Title: Last Modified By
Read Only: true
The details of the user who modified the record.
Match All
Show Source
Nested Schema : UserDetails
Type: object
Show Source
Nested Schema : PricingAttribute
Type: object
Show Source
Nested Schema : Created By
Title: Created By
Read Only: true
The details of the user who created the record.
Match All
Show Source
Nested Schema : Last Modified By
Title: Last Modified By
Read Only: true
The details of the user who modified the record.
Match All
Show Source
Nested Schema : Attribute Mappings
Title: Attribute Mappings
Read Only: true
List of mappings for the Pricing Attribute.
Match All
Show Source
Nested Schema : PricingResourceCollection_PricingMappedDataSourceAttribute
Type: object
Show Source
  • Title: Count
    Read Only: true
    The number of resource instances returned in the current range.
  • Created By
    Title: Created By
    Read Only: true
    The details of the user who created the record.
  • 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
  • Last Modified By
    Title: Last Modified By
    Read Only: true
    The details of the user who modified the record.
  • Title: Limit
    Read Only: true
    The actual paging size used by the server.
  • Links
  • Title: OffSet
    Read Only: true
    The offset value used in the current page.
  • 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.
Nested Schema : Created By
Title: Created By
Read Only: true
The details of the user who created the record.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Last Modified By
Title: Last Modified By
Read Only: true
The details of the user who modified the record.
Match All
Show Source
Nested Schema : PricingMappedDataSourceAttribute
Type: object
Show Source
Nested Schema : Created By
Title: Created By
Read Only: true
The details of the user who created the record.
Match All
Show Source
Nested Schema : Last Modified By
Title: Last Modified By
Read Only: true
The details of the user who modified the record.
Match All
Show Source
Back to Top

Examples

The following examples show how to retrieve a list of all pricing attributes in Pricing Engine by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

The 'limit' query specification is used in the following example to limit the results to five attributes per page.

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/pricingSetup/attributes?limit=5

Response Body Sample

{
  "links": [{
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v16/pricingSetup"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v16/pricingSetup/attributes/mappings"
    }, {
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v16/pricingSetup/attributes"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/pricingSetup/attributes?offset=0&limit=5"
    }, {
      "rel": "next",
      "href": "https://sitename.oracle.com/rest/v16/pricingSetup/attributes?offset=5&limit=5"
    }
  ],
  "hasMore": true,
  "items": [{
      "name": "Quotes - Trigger",
      "variableName": "quotesTrigger",
      "dateModified": "2022-03-01T13:20:20.000Z",
      "dateAdded": "2019-11-15T00:52:33.000Z",
      "dataType": "Boolean",
      "attributeLevel": "Line",
      "templateVariableKey": "Custom",
      "arrayType": false
    }, {
      "name": "Quotes - Calculation Info",
      "variableName": "quotesCalculationInfo",
      "dateModified": "2022-03-01T13:20:20.000Z",
      "dateAdded": "2019-11-15T00:52:33.000Z",
      "dataType": "String",
      "attributeLevel": "Line",
      "templateVariableKey": "Custom",
      "arrayType": false
    }, {
      "name": "Quotes - Price Override",
      "variableName": "quotesPriceOverride",
      "dateModified": "2022-03-01T13:20:20.000Z",
      "dateAdded": "2019-11-15T00:52:33.000Z",
      "dataType": "Currency",
      "attributeLevel": "Line",
      "templateVariableKey": "Custom",
      "arrayType": false
    }, {
      "name": "Pricing Engine Main Boolean",
      "variableName": "pricingEngineMainBoolean",
      "dateModified": "2022-05-13T06:45:15.000Z",
      "dateAdded": "2021-04-06T17:15:43.000Z",
      "dataType": "Boolean",
      "attributeLevel": "Header",
      "templateVariableKey": "Custom",
      "arrayType": false
    }, {
      "name": "Pricing Engine Main Currency",
      "variableName": "pricingEngineMainCurrency",
      "dateModified": "2022-03-01T13:20:20.000Z",
      "dateAdded": "2021-04-06T17:15:43.000Z",
      "dataType": "Currency",
      "attributeLevel": "Header",
      "templateVariableKey": "Custom",
      "arrayType": false
    }
  ],
  "count": 5,
  "limit": 5,
  "offset": 0
}
Back to Top