Get a rate dimension tier
get
/fscmRestApi/resources/11.13.18.05/rateDimensions/{RateDimensionId}/child/RateDimensionTiers/{RateDimTierId}
Request
Path Parameters
-
RateDimTierId(required): integer(int64)
The unique identifier of a rate dimension tier.
-
RateDimensionId(required): integer(int64)
The unique identifier for the rate dimension record.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : rateDimensions-RateDimensionTiers-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumAmount: number
Title:
To
The maximum amount of the rate dimension. If the rate dimension is percentage, then the maximum amount is converted to a number (by dividing it by 100). For example, if the rate dimension is percentage, and the minimum amount is 20% then is it converted to 20. -
MaximumExpressionId: integer
(int64)
Title:
To
This is a unique identifier for maximum expression. This represents the rate dimension ending tier where tiers are expressions. -
MaximumExpressionName: string
Title:
To
Read Only:true
The name of the maximum expression. -
MinimumAmount: number
Title:
From
The minimum amount of the rate dimension. If the rate dimension is percentage, then the minimum amount is converted to a number (by dividing it by 100). For example, if the rate dimension is percentage, and the minimum amount is 10% then is it converted to 10. -
MinimumExpressionId: integer
(int64)
Title:
From
This is a unique identifier for minimum expression. This represents the rate dimension starting tier where tiers are expressions. -
MinimumExpressionName: string
Title:
From
Read Only:true
The name of the minimum expression. -
RateDimensionId: integer
(int64)
The unique identifier of a rate dimension record.
-
RateDimTierId: integer
(int64)
Read Only:
true
The unique identifier of a rate dimension tier. -
StringValue: string
Title:
String
Maximum Length:30
The alphanumeric value of a rate dimension tier with type set as string. -
TierSequence: integer
(int32)
Title:
Sequence
Read Only:true
The specified order of a tier within a rate dimension.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- MaximumExpressionVO
-
The expression usages list of values resource is used to view the list of expression usages which indicate where an expression can be used.
- MinimumExpressionVO
-
The expression usages list of values resource is used to view the list of expression usages which indicate where an expression can be used.
Examples
The following example shows how to get a rate dimension tier by submitting a GET request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584746/child/RateDimensionTiers/300100089585733
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "RateDimTierId": 300100089585733, "RateDimensionId": 300100089584746, "TierSequence": 1, "MinimumAmount": null, "MaximumAmount": null, "StringValue": "North Zone", "MinimumExpressionId": null, "MaximumExpressionId": null, "MinimumExpressionName": null, "MaximumExpressionName": null, "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-04-13T14:22:30+05:30", "LastUpdateDate": "2017-04-13T14:22:30+05:30", "LastUpdateLogin": "4D08BCC1FBC27D7CE053CB90B10AEB84", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584746/child/RateDimensionTiers/300100089585733", "name": "RateDimensionTiers", "kind": "item", "properties": {"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"} }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584746/child/RateDimensionTiers/300100089585733", "name": "RateDimensionTiers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584746", "name": "rateDimensions", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584746/child/RateDimensionTiers/300100089585733/lov/MinimumExpressionVO", "name": "MinimumExpressionVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584746/child/RateDimensionTiers/300100089585733/lov/MaximumExpressionVO", "name": "MaximumExpressionVO", "kind": "collection" } ] }