Get All Rate Cards
get
/rest/v19/pricingSetup/rateCards
Use this endpoint to retrieve all rate cards.
Request
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=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.
-
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 pricing matrixes using name,variableName and description.
Finder Variable:- keyword;string:The search text. The character '%' if present will be treated as a wild card otherwise, the default is 'contains' search
- findByTemplateVarName: Find pricing matrixes related to a pricing matrix template.
Finder Variable:- templateVariableName;string:The pricing matrix template variable name
- findByKeyword: Find pricing matrixes using name,variableName and description.
-
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_PricingMatrix
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. -
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.
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
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
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 : PricingMatrix
Type:
Show Source
object
-
active:
boolean()
Title:
Active
Indicates if the pricing matrix is active. -
allowedChargeDefinitions:
array Allowed Charge Definitions
Title:
Allowed Charge Definitions
The list of charge definitions that this pricing matrix will apply to. -
allowedUsageUOM:
Allowed Usage UOM
Title:
Allowed Usage UOM
The usage UOM lookup code that this pricing matrix will apply to. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
data:
Pricing Matrix data
Title:
Pricing Matrix data
Read Only:true
List of Pricing Matrix data. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation Date of the Pricing Matrix. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last Modified date of the Pricing Matrix. -
description:
string()
Title:
Description
Description of the Pricing Matrix. -
groupAccessEnabled:
boolean()
Title:
Group Access Enabled
Read Only:true
Indicates whether the user has access to the groups segment -
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 Matrix. -
priceModelCount:
integer()
Title:
Linked Pricing Models Count
Read Only:true
The count of price models linked to this pricing matrix. -
segmentLevelAccessType:
string()
Title:
Segment-level Access Type
Read Only:true
Segment-level Access Type -
template:
Pricing Matrix template
Title:
Pricing Matrix template
Read Only:true
Pricing Matrix template name and variableName -
templateVariableName(required):
string()
Title:
Pricing Matrix Template Variable Name
Variable Name of the Pricing Matrix Template. -
variableName:
string()
Title:
Variable Name
Unique Variable Name of the Pricing Matrix.
Nested Schema : Allowed Charge Definitions
Type:
array
Title:
Allowed Charge Definitions
The list of charge definitions that this pricing matrix will apply to.
Show Source
Nested Schema : Allowed Usage UOM
Title:
Allowed Usage UOM
The usage UOM lookup code that this pricing matrix will apply to.
Match All
The usage UOM lookup code that this pricing matrix will apply to.
Show Source
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
Nested Schema : Pricing Matrix data
Title:
Pricing Matrix data
Read Only:
true
List of Pricing Matrix data.
Match All
List of Pricing Matrix data.
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
The details of the user who modified the record.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : Pricing Matrix template
Title:
Pricing Matrix template
Read Only:
true
Pricing Matrix template name and variableName
Match All
Pricing Matrix template name and variableName
Show Source
Nested Schema : PricingMenuItem
Type:
Show Source
object
-
displayValue:
string()
Title:
Display Value
The display value of the menu item. -
value:
string()
Title:
Value
The raw value of the menu item.
Nested Schema : PricingResourceCollection_PricingMatrixData
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. -
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.
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
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
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : PricingMatrixData
Type:
Show Source
object
-
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 Matrix data. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last Modified date of the Pricing Matrix data. -
groupAccessEnabled:
boolean()
Title:
Group Access Enabled
Read Only:true
Indicates whether the user has access to the groups segment -
id:
integer()
Title:
Id
The Unique Identifier of the Pricing Matrix 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. -
segmentLevelAccessType:
string()
Title:
Segment-level Access Type
Read Only:true
Segment-level Access Type
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
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
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to retrieve all Rate Cards 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 "Accept: application/json" https://sitename.oracle.com/rest/v19/pricingSetup/rateCards
Response Body Sample
{ "items": [{ "name": "NA Phone Call Rate Card", "variableName": "naPhoneRateCard", "description": "", "active": true, "template": { "name": "Zoom Phone Call Template", "variableName": "zoomPhoneCallTemplate" }, "priceModelCount": 3 }, { "name": "APAC Phone Call Rate Card", "variableName": "apacPhoneRateCard", "description": "", "active": true, "template": { "name": "Zoom Phone Call Template", "variableName": "zoomPhoneCallTemplate" }, "priceModelCount": 0 }, { "name": "Enterprise Data Usage Rate Card", "variableName": "enterpriseDataUsageRateCard", "description": "", "active": true, "template": { "name": "Data Usage Rate Template", "variableName": "dataUsageRateTemplate" }, "priceModelCount": 2 } ], "offset": 0, "limit": 25, "count": 3, "totalResults": 3, "hasMore": false, "links": [{ "rel": "string", "href": "string" } ] }