Get Price Model
get
/rest/v16/pricingSetup/models/{modelVarName}
Use this endpoint retrieve the specified price model.
Request
Path Parameters
Query Parameters
-
expand: string
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=priceModelItems,data. To include all the children and grandchildren, specify the value of this query parameter to be "all".
-
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.
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : PricingModel
Type:
Show Source
object
-
adjustmentType:
string()
Title:
The Adjustment Type of price model
Allowed Values:[ "discountPercent", "discountAmount", "markupPercent", "markupAmount" ]
Adjustment Type. -
conditionType:
string()
Title:
Condition Type
Allowed Values:[ "alwaysTrue", "simple" ]
The condition type of the Price Model. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
data:
Model Data
Title:
Model Data
Read Only:true
List of data for the Price Model. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation Date of the Price Model. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last Modified date of the Price Model. -
description:
string()
Title:
Description
Description of the pricing Model. -
dynamicPricingType:
string()
Title:
Dynamic Pricing Type
Allowed Values:[ "static", "advanced", "volume", "tiered", "rateCard", "attributeBasedCharge" ]
The type of dynamic pricing applied by the Price Model. -
editRestriction:
string()
Title:
Edit Restriction
Read Only:true
Allowed Values:[ "UNRESTRICTED", "ONLY_REORDERABLE", "RESTRICTED" ]
Pricing Edit Restriction. -
endDate:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
End Date
Effective End Date. -
hasBomItem:
boolean()
Title:
Has BOM Item
Read Only:true
Indicates whether this model has prices defined for BOM Items. -
hasCharges:
boolean()
Title:
Has Charges
Read Only:true
Indicates whether this Price Model has any charges. -
hasChargeSupport:
boolean()
Title:
Has Charge Support
Read Only:true
Indicates whether this model has charge support.(Starting V16 this will be always true and will be deprecated) -
hasRateCards:
boolean()
Title:
Has Rate Cards
Read Only:true
Indicates whether this model has any price model data that has linked rate cards. (Preview only) -
hasRatePlans:
boolean()
Title:
Has Rate Plans
Read Only:true
Indicates whether this model has any price model data that has rate plans. -
hasTiers:
boolean()
Title:
Has Tiers
Read Only:true
Indicates whether this model has any price model data that has tiers. -
integrationId:
string()
Title:
Integration Id
Price List ID from SCM. -
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
Allowed Values:[ "priceList", "discountList", "advanced", "markupList" ]
List Type. -
matrixTemplateName:
string()
Title:
Dynamic Matrix Template Name
Read Only:true
The dynamic matrix template name of the Price Model. -
matrixTemplateVariableName:
string()
Title:
Dynamic Matrix Template Variable Name
The dynamic matrix template variable name of the Price Model. -
name:
string()
Title:
Name
Name of the Price Model. -
priceModelItems:
Model Items
Title:
Model Items
Read Only:true
List of model items for the Price Model. -
ruleCount:
integer()
Title:
Linked Pricing Rules Count
Read Only:true
The count of pricing rules linked to this model. - shared: boolean()
-
simpleConditions:
Simple Conditions
Title:
Simple Conditions
A collection of simple Type conditions applied by the Price Model. This is optional for other condition type. -
startDate:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Start Date
Effective Start Date. -
supportedMatrixTemplateVariableName:
string()
Title:
Supported Dynamic Matrix Pricing Template
Read Only:true
The supported dynamic matrix pricing template of the Price Model. -
valueType:
string()
Title:
Value Type
Allowed Values:[ "absolutePrice", "discountAmount", "discountPercent", "markupAmount", "markupPercent" ]
The value type of Price Model. -
variableName:
string()
Title:
Variable Name
Unique Variable Name of the 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 : Model Data
Title:
Model Data
Read Only:
true
List of data for the Price Model.
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 : Model Items
Title:
Model Items
Read Only:
true
List of model items for the Price Model.
Match All
Show Source
Nested Schema : Simple Conditions
Title:
Simple Conditions
A collection of simple Type conditions applied by the Price Model. This is optional for other condition type.
Match All
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 : PricingResourceCollection_PricingModelData
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 : PricingModelData
Type:
Show Source
object
-
blockPrices:
array Block Prices
Title:
Block Prices
The block price. -
blockSize:
number()
Title:
Block Size
The block size. -
bomItemName:
string()
Title:
BOM Item Name
Read Only:true
The BOM item's display name. When clients sets field bomItemVariableName, this field should also be explicitly set in the request. -
bomItemVariableName:
string()
Title:
BOM Item Variable Name
Read Only:true
The BOM Item's variable name. -
chargeDefinition:
string()
Title:
Charge Definition
Read Only:true
Display Name of the Charge Definition. -
chargeDefinitionCode:
string()
Title:
Charge Definition Code
Read Only:true
The unique code of the Charge Definition. -
chargeDefinitionId:
integer()
Title:
Charge Definition ID
Read Only:true
ID of the Charge Definition. -
chargeType:
string()
Title:
Charge Type
Read Only:true
The category of charge. -
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 Data. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last modified date of the Price Model Data. -
description:
string()
Title:
Description
Read Only:true
The description of the Price Model Data -
dynamicPricingType:
string()
Title:
Dynamic Pricing Type
Read Only:true
Allowed Values:[ "static", "advanced", "volume", "tiered", "rateCard", "attributeBasedCharge" ]
The dynamic pricing type of the charge. -
endDate:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
End Date
Read Only:true
The date at which the Charge will end. -
id:
integer()
Title:
Id
Read Only:true
The Unique Identifier of the Price Model Data. -
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. -
partNumber:
string()
Title:
Part Number
Read Only:true
The part Number of the Price Model Data.This should match the Part Lookup's lookupCode. -
pricePeriod:
string()
Title:
Price Period
Read Only:true
The billing period. -
prices:
array Prices
Title:
Prices
The item prices. -
priceType:
string()
Title:
Price Type
Read Only:true
The type of charge. -
primaryCharge:
boolean()
Title:
Primary Charge
Read Only:true
Indicates whether this is the primary charge. -
rangeFrom:
number()
Title:
Range From
Read Only:true
The starting range of the Price Model Data. -
rangeTo:
number()
Title:
Range To
Read Only:true
The ending range of the Price Model Data. -
rateCardName:
string()
Title:
Rate Card Name
Read Only:true
Rate Card name (Preview only. Not available for use.) -
rateCardVariableName:
string()
Title:
Rate Card Variable Name
Read Only:true
Rate Card variable name (Preview only. Not available for use.) -
ratePlanName:
string()
Title:
Rate Plan Name
Read Only:true
Rate Plan name. -
rootBomItemName:
string()
Title:
Root BOM Item Name
Read Only:true
The root BOM item's display name. -
rootBomItemVariableName:
string()
Title:
Root BOM Item Variable Name
Read Only:true
The root BOM item's variable name. -
serviceDuration:
integer()
Title:
Service Duration
Read Only:true
Service duration. -
serviceDurationPeriod:
string()
Title:
Service Duration Period
Read Only:true
Service duration period code. -
serviceDurationType:
string()
Title:
Service Duration Type
Read Only:true
Service duration type. -
startDate:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Start Date
Read Only:true
The date from which the Charge will be applicable. -
usageUOM:
string()
Title:
Usage UOM
Read Only:true
The unit of measure for the charge.
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 : PricingCurrencyValues
Type:
Show Source
object
-
currencyCode:
string()
Title:
Currency Code
The currency code. -
value:
number()
Title:
Value
The currency value.
Nested Schema : PricingResourceCollection_PriceModelItem
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 : PriceModelItem
Type:
Show Source
object
-
bomItemName:
string()
Title:
BOM Item Name
The BOM item's display name. When clients sets field bomItemVariableName, this field should also be explicitly set in the request. -
bomItemVariableName:
string()
Title:
BOM Item Variable Name
The BOM Item's variable name. -
chargeCount:
integer()
Title:
Associated Charges Count
Read Only:true
The count of charges directly associated with this price model item. -
charges:
Associated Charges
Title:
Associated Charges
Read Only:true
The standalone charges associated with this price model item. -
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 Item. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last modified date of the Price Model Item. -
description:
string()
Title:
Part Description
Read Only:true
The description of the Price Model Item. -
hasRatePlanSupport:
boolean()
Title:
Has Rate Plan Support
Read Only:true
Indicates if the Price Model Item supports rate plans. -
id:
integer()
Title:
Id
Read Only:true
The Unique Identifier of the Price Model Data. -
integrationId:
string()
Title:
Integration Id
Read Only:true
Price List Item ID from SCM. -
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. -
partNumber:
string()
Title:
Part Number
The part Number of the Price Model Item.This should match the Part Lookup's lookupCode. -
ratePlanCount:
integer()
Title:
Associated Rate Plans Count
Read Only:true
The count of rate plans linked to this price model item. -
ratePlans:
Associated Rate Plans
Title:
Associated Rate Plans
Read Only:true
The rate plans linked to this price model item. -
rootBomItemName:
string()
Title:
Root BOM Item Name
The root BOM item's display name. -
rootBomItemVariableName:
string()
Title:
Root BOM Item Variable Name
The root BOM item's variable name. -
salesProductType:
string()
Title:
Sales Product Type
Read Only:true
The sales product type of the Price Model Item. -
serviceDuration:
integer()
Title:
Service Duration
The service duration of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types. -
serviceDurationPeriod:
string()
Title:
Service Duration Period
The service duration period code of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types. -
serviceDurationType:
string()
Title:
Service Duration Type
Service duration type.
Nested Schema : Associated Charges
Title:
Associated Charges
Read Only:
true
The standalone charges associated with this price model item.
Match All
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 : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : Associated Rate Plans
Title:
Associated Rate Plans
Read Only:
true
The rate plans linked to this price model item.
Match All
Show Source
Nested Schema : PricingResourceCollection_PricingCharge
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 : PricingCharge
Type:
Show Source
object
-
blockPrices:
array Block Prices
Title:
Block Prices
The block price. -
blockSize:
number()
Title:
Block Size
The block size. -
chargeDefinition:
string()
Title:
Charge Definition
Read Only:true
Display Name of the Charge Definition. -
chargeDefinitionCode:
string()
Title:
Charge Definition Code
The unique code of the Charge Definition. -
chargeDefinitionId:
integer()
Title:
Charge Definition ID
Read Only:true
ID of the Charge Definition. -
chargeType:
string()
Title:
Charge Type
The category of charge. -
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. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last modified date. -
dynamicPricingType:
string()
Title:
Dynamic Pricing Type
Allowed Values:[ "static", "advanced", "volume", "tiered", "rateCard", "attributeBasedCharge" ]
The dynamic pricing type of the charge. -
endDate:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
End Date
The date at which the Charge will end. -
id:
integer()
Title:
Id
Read Only:true
The Unique Identifier of the Charge. -
integrationId:
string()
Title:
Integration Id
Read Only:true
Rate Plan Charge ID from SCM. -
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. -
pricePeriod:
string()
Title:
Price Period
The billing period. -
prices:
array Prices
Title:
Prices
The item prices. -
priceType:
string()
Title:
Price Type
The type of charge. -
pricingMatrixVariableName:
string()
Title:
Pricing Matrix Variable Name
Pricing Matrix variable name (Preview only. Not available for use.) -
primaryCharge:
boolean()
Title:
Primary Charge
Indicates whether this is the primary charge. -
rateCardName:
string()
Title:
Rate Card Name
Read Only:true
Rate Card name (Preview only. Not available for use.) -
rateCardVariableName:
string()
Title:
Rate Card Variable Name
Rate Card variable name (Preview only. Not available for use.) -
startDate:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Start Date
The date from which the Charge will be applicable. -
templateVariableName:
string()
Title:
Pricing Matrix Template Variable Name
The pricing matrix emplate variable name. -
tiers:
array Tiers
Title:
Tiers
The charge tiers. -
usageUOM:
string()
Title:
Usage UOM
The unit of measure for the charge.
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 : ChargeTier
Type:
Show Source
object
-
blockPrices:
array Block Prices
Title:
Block Prices
The block price for the corresponding tier. -
blockSize:
number()
Title:
Block Size
The block size for the corresponding tier. -
prices:
array Prices
Title:
Prices
The prices. -
rangeFrom:
number()
Title:
Range From
The starting range of the Charge. -
rangeTo:
number()
Title:
Range To
Read Only:true
The ending range of the Charge.
Nested Schema : Block Prices
Type:
array
Title:
Block Prices
The block price for the corresponding tier.
Show Source
Nested Schema : PricingResourceCollection_PricingRatePlan
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 : PricingRatePlan
Type:
Show Source
object
-
chargeCount:
integer()
Title:
Associated Charges Count
Read Only:true
The count of charges directly associated with this price model item. -
charges:
Charges
Title:
Charges
Read Only:true
Rate Plan charges -
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 Pricing Rate Plan. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last Modified date of the Pricing Rate Plan. -
description:
string()
Title:
Description
Description of the Pricing Rate Plan. -
endDate:
string()
Title:
End Date
The date after which the Pricing Rate Plan will no longer be applicable. -
integrationId:
string()
Title:
Integration ID
The integration ID of the Pricing rate plan. -
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. -
name:
string()
Title:
Name
Name of the Pricing Rate Plan. -
orderNumber:
integer()
Title:
Order Number
The position in a ordered list of Rate Plan. -
priceModelItemId:
integer()
Title:
Price ModelItem Id
Read Only:true
The Price ModelItem Id. -
ratePlanNumber:
string()
Title:
Rate Plan Number
Unique Variable Name of the Pricing Rate Plan. -
startDate:
string()
Title:
Start Date
The date from which the Pricing Rate Plan will be applicable.
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 : SimpleConditions
Type:
Show Source
object
-
ruleExpression:
string()
Title:
Rule Expression
The rule expression that will be evaluated. -
simpleConditionRows:
array Simple Condition Rows
Title:
Simple Condition Rows
A list of Simple Condition Rows.
Nested Schema : Simple Condition Rows
Type:
array
Title:
Simple Condition Rows
A list of Simple Condition Rows.
Show Source
Nested Schema : SimpleConditionRow
Type:
Show Source
object
-
displayName:
string()
Title:
Display Name
The display name of the Simple Condition Row. -
index:
integer()
Title:
Index
The index (starting from 1) of the Simple Condition Row. -
operator:
string()
Title:
Operator
Allowed Values:[ "NONE", "EQUAL_TO", "NOT_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL_TO", "LESS_THAN", "LESS_THAN_EQUAL_TO", "CONTAINS", "NOT_CONTAINS", "STARTS_WITH", "NOT_STARTS_WITH", "ENDS_WITH", "NOT_ENDS_WITH" ]
The operation of the Simple Condition Row. -
value:
string()
Title:
Target Value
The value to match. -
variableName:
string()
Title:
Simple Condition Row
The variable name of the Simple Condition Row.
Examples
The following examples show how to retrieve the specified price model 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/models/cSPABCCorp
Response Body Sample
{ "dateModified": "2019-11-04T17:01:48Z", "dateAdded": "2019-11-04T15:02:18Z", "name": "CSP ABC Corp", "variableName": "cSPABCCorp", "conditionType": "simple", "simpleConditions": { "ruleExpression": "1 OR 2", "simpleConditionRows": [{ "index": 1, "variableName": "companyName", "displayName": "Company Name", "operator": "EQUAL_TO", "value": "ABC Corp" }, { "index": 2, "variableName": "repeatCustomer", "displayName": "RepeatCustomer", "operator": "EQUAL_TO", "value": "true" } ] }, "shared": false, "ruleCount": 1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/pricingSetup/models/cSPABCCorp" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/pricingSetup/models" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/pricingSetup/models/cSPABCCorp/data" } ], "valueType": "absolutePrice", "dynamicPricingType": "advanced" }