Get all rate dimensions

get

/fscmRestApi/resources/11.13.18.05/rateDimensions

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds the rate dimension by RateDimensionId.
      Finder Variables:
      • RateDimensionId; integer; The unique identifier of the rate dimension.
  • 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.
  • 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
  • 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 fields. 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
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date and time when the record was created.
    • Description; string; The additional details added by the user related to rate dimensions.
    • LastUpdateDate; string; The date and time when the record was last updated.
    • LastUpdateLogin; string; The session login associated with the user who last updated the record.
    • LastUpdatedBy; string; The user who last updated the record.
    • Name; string; The name of the rate dimension.
    • NumberTier; integer; The number of tiers for rate dimensions. The default value is 0.
    • OrgId; integer; The unique identifier of the business unit. The value can be updated from a list of acceptable values in the Manage Business Units task in Setup and Maintenance.
    • RateDimensionId; integer; The unique identifier for the rate dimension record.
    • RateDimensionType; string; The unit of measurement for a rate dimension. Possible values include AMOUNT, EXPRESSION, PERCENT, and STRING. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_DIM_UNIT_CODE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : rateDimensions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : rateDimensions-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Title: Description
    Maximum Length: 1000
    The additional details added by the user related to rate dimensions.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login associated with the user who last updated the record.
  • Links
  • Title: Name
    Maximum Length: 80
    The name of the rate dimension.
  • Title: Number of Tiers
    Read Only: true
    Default Value: 0
    The number of tiers for rate dimensions. The default value is 0.
  • Title: Business Unit
    The unique identifier of the business unit. The value can be updated from a list of acceptable values in the Manage Business Units task in Setup and Maintenance.
  • Read Only: true
    The unique identifier for the rate dimension record.
  • Rate Dimension - Tiers
    Title: Rate Dimension - Tiers
    The rate dimensions tiers resource is used to create, update, or delete the association of tiers to a rate dimension. It can also be used to display all the details of the tiers in a dimension.
  • Title: Type
    Maximum Length: 30
    Default Value: AMOUNT
    The unit of measurement for a rate dimension. Possible values include AMOUNT, EXPRESSION, PERCENT, and STRING. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_DIM_UNIT_CODE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
Nested Schema : Rate Dimension - Tiers
Type: array
Title: Rate Dimension - Tiers
The rate dimensions tiers resource is used to create, update, or delete the association of tiers to a rate dimension. It can also be used to display all the details of the tiers in a dimension.
Show Source
Nested Schema : rateDimensions-RateDimensionTiers-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all rate dimension tiers 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/300100089570738/child/RateDimensionTiers

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
   "items":    [
            {
         "RateDimTierId": 300100089570739,
         "RateDimensionId": 300100089570738,
         "TierSequence": 1,
         "MinimumAmount": 0,
         "MaximumAmount": 1000,
         "StringValue": null,
         "MinimumExpressionId": null,
         "MaximumExpressionId": null,
         "MinimumExpressionName": null,
         "MaximumExpressionName": null,
         "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
         "CreationDate": "2016-09-21T21:31:16+05:30",
         "LastUpdateDate": "2016-09-21T21:31:16+05:30",
         "LastUpdateLogin": "3CEB7E6D973C0A67E053CB90B10AABA3",
         "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
         "links":          [
                        {
               "rel": "self",
               "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers/300100089570739",
               "name": "RateDimensionTiers",
               "kind": "item",
               "properties": {"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"}
            },
                        {
               "rel": "canonical",
               "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers/300100089570739",
               "name": "RateDimensionTiers",
               "kind": "item"
            },
                        {
               "rel": "parent",
               "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738",
               "name": "rateDimensions",
               "kind": "item"
            },
                        {
               "rel": "lov",
               "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers/300100089570739/lov/MinimumExpressionVO",
               "name": "MinimumExpressionVO",
               "kind": "collection"
            },
                        {
               "rel": "lov",
               "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers/300100089570739/lov/MaximumExpressionVO",
               "name": "MaximumExpressionVO",
               "kind": "collection"
            }
         ]
      },
            {
         "RateDimTierId": 300100089570740,
         "RateDimensionId": 300100089570738,
         "TierSequence": 2,
         "MinimumAmount": 1000,
         "MaximumAmount": 2000,
         "StringValue": null,
         "MinimumExpressionId": null,
         "MaximumExpressionId": null,
         "MinimumExpressionName": null,
         "MaximumExpressionName": null,
         "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
         "CreationDate": "2016-09-21T21:31:16+05:30",
         "LastUpdateDate": "2016-09-21T21:31:16+05:30",
         "LastUpdateLogin": "3CEB7E6D973C0A67E053CB90B10AABA3",
         "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
         "links":          [
                        {
               "rel": "self",
               "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers/300100089570740",
               "name": "RateDimensionTiers",
               "kind": "item",
               "properties": {"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"}
            },
                        {
               "rel": "canonical",
               "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers/300100089570740",
               "name": "RateDimensionTiers",
               "kind": "item"
            },
                        {
               "rel": "parent",
               "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738",
               "name": "rateDimensions",
               "kind": "item"
            },
                        {
               "rel": "lov",
               "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers/300100089570740/lov/MinimumExpressionVO",
               "name": "MinimumExpressionVO",
               "kind": "collection"
            },
                        {
               "rel": "lov",
               "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers/300100089570740/lov/MaximumExpressionVO",
               "name": "MaximumExpressionVO",
               "kind": "collection"
            }
         ]
      },
        
	. . .


   ],
   "count": 4,
   "hasMore": false,
   "limit": 25,
   "offset": 0,
   "links": [   {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089570738/child/RateDimensionTiers",
      "name": "RateDimensionTiers",
      "kind": "collection"
   }]
}
Back to Top