Get Price Models Linked to Pricing Rule
get
/rest/v16/pricingSetup/rules/{ruleVarName}/ruleModels
Use this endpoint to retrieve all price models linked to the specified pricing rule.
Request
Path Parameters
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.
-
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".
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : PricingResourceCollection_PricingRuleModel
Type:
Show Source
object
-
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. -
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. -
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.
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 : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : UserDetails
Type:
Show Source
object
-
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
Nested Schema : PricingRuleModel
Type:
Show Source
object
-
adjustmentType:
string()
Title:
The Adjustment Type of price model
Read Only:true
Allowed Values:[ "discountPercent", "discountAmount", "markupPercent", "markupAmount" ]
Adjustment Type. -
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 Price Model to Pricing Rule link. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last modified date of the Price Model to Pricing Rule link. -
description:
string()
Title:
Description
Read Only:true
The description of the linked Price Model. -
dynamicPricingType:
string()
Title:
Dynamic Pricing Type
Read Only:true
Allowed Values:[ "static", "advanced", "volume", "tiered", "rateCard", "attributeBasedCharge" ]
The type of dynamic pricing applied by the linked Price Model. -
editRestriction:
string()
Title:
Edit Restriction
Read Only:true
Allowed Values:[ "UNRESTRICTED", "ONLY_REORDERABLE", "RESTRICTED" ]
Pricing Edit Restriction. -
hasBomItem:
boolean()
Title:
Has BOM Item
Read Only:true
Indicates whether this model has prices defined for BOM Items. -
hasChargeSupport:
boolean()
Title:
Has Charge Support
Read Only:true
Indicates whether this model has charge support. -
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. -
listType:
string()
Title:
The List Type for the price model
Read Only:true
Allowed Values:[ "priceList", "discountList", "advanced", "markupList" ]
List Type. -
name:
string()
Title:
Name
Read Only:true
The name of the linked Price Model. -
orderNumber:
integer()
Title:
Order Number
The position(starting from 1) of the linked Price Model within the Pricing Rule. -
ruleCount:
integer()
Title:
Linked Pricing Rules Count
Read Only:true
The count of pricing rules linked to this model. -
valueType:
string()
Title:
Value Type
Read Only:true
Allowed Values:[ "absolutePrice", "discountAmount", "discountPercent", "markupAmount", "markupPercent" ]
The type of discount applied by the linked Price Model. -
variableName:
string()
Title:
Variable Name
The Unique Variable Name of the linked Price Model.
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 : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Examples
The following examples show how to retrieve all the price models that are linked to the specified pricing rule in Pricing Engine by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v16/pricingSetup/rules/oRCLpRCrunAllProfiles/ruleModels
Response Body Sample
{ "items": [{ "variableName": "subscriptionCharges", "orderNumber": 1, "dateModified": "2019-05-06T05:03:51Z", "dateAdded": "2019-05-02T13:37:28Z", "name": "Subscription Charges", "ruleCount": 1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/pricingSetup/rules/oRCLpRCrunAllProfiles/ruleModels/subscriptionCharges" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/pricingSetup/rules/oRCLpRCrunAllProfiles/ruleModels" } ], "valueType": "absolutePrice", "dynamicPricingType": "advanced" }, { "variableName": "configSMS", "orderNumber": 2, "dateModified": "2020-04-20T16:14:23Z", "dateAdded": "2020-04-20T16:14:23Z", "name": "Config SMS", "ruleCount": 1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/pricingSetup/rules/oRCLpRCrunAllProfiles/ruleModels/configSMS" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/pricingSetup/rules/oRCLpRCrunAllProfiles/ruleModels" } ], "valueType": "absolutePrice", "dynamicPricingType": "advanced" } ], "offset": 0, "limit": 1000, "count": 2, "hasMore": false, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/pricingSetup/rules/oRCLpRCrunAllProfiles" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/pricingSetup/rules/oRCLpRCrunAllProfiles/ruleModels" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v16/pricingSetup/rules/oRCLpRCrunAllProfiles/ruleModels?offset=0&limit=1000" } ] }