Jump to

• Request
• Response
• Examples

Get a rate dimension details within a rate table

get

/fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableDimensions/{RateTableDimId}

Request

Path Parameters

• RateTableDimId(required): integer(int64)
  The unique identifier for the rate table's dimension record.
• RateTableId(required): integer(int64)
  The unique identifier for the rate table.

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 Top

Response

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.

Body ()

Root Schema : rateTables-RateTableDimensions-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created this 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 this record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated this 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.
• NumberTier: integer (int64)
  Title: Number of Tiers

  Read Only: true

  Default Value: 0

  The number of tiers in the rate table dimension within the rate table.
• RateDimensionId: integer (int64)
  Title: Name

  The unique identifier for a rate dimension record.
• RateDimensionName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  The name of the rate dimension. A rate table can have one or more rate dimensions.
• RateDimensionType: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Default Value: AMOUNT

  The unit of measurement for a rate table 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.
• RateDimSequence: integer (int32)
  Title: Sequence

  Read Only: true

  The specified order of a rate dimension within a rate table.
• RateTableDimensionsUpdateFlag: boolean
  Read Only: true

  Indicates whether the rate table dimension can be updated.
• RateTableDimensionTiers: array Rate Dimensions Tiers
  Title: Rate Dimensions Tiers

  The rate dimensions tiers resource is only used to view all the details of the tiers in a rate dimension of the rate table.
• RateTableDimId: integer (int64)
  The unique identifier for the rate table's dimension record.
• RateTableId: integer (int64)
  Title: Name

  The unique identifier for a rate table.
• RateTableName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  The name of the rate table. A rate table is used to establish compensation percentage rates or fixed amounts for different performance levels.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated this record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created this record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableDimensionsUpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the rate table dimension can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimensionId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier for a rate dimension record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateDimensionName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the rate dimension. A rate table can have one or more rate dimensions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the rate table. A rate table is used to establish compensation percentage rates or fixed amounts for different performance levels.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableDimensionTiers":{
            "title":"Rate Dimensions Tiers",
            "type":"array",
            "description":"The rate dimensions tiers resource is only used to view all the details of the tiers in a rate dimension of the rate table.",
            "items":{
                "$ref":"#/components/schemas/rateTables-RateTableDimensions-RateTableDimensionTiers-item-response"
            }
        },
        "RateTableDimId":{
            "type":"integer",
            "description":"The unique identifier for the rate table's dimension record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RateDimSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The specified order of a rate dimension within a rate table.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "NumberTier":{
            "title":"Number of Tiers",
            "type":"integer",
            "description":"The number of tiers in the rate table dimension within the rate table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateDimensionType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The unit of measurement for a rate table 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.",
            "nullable":false,
            "readOnly":true,
            "default":"AMOUNT",
            "x-queryable":true
        },
        "RateTableId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier for a rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when this record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Rate Dimensions Tiers

Type: array

Title: Rate Dimensions Tiers

The rate dimensions tiers resource is only used to view all the details of the tiers in a rate dimension of the rate table.

Show Source

• Array of: object rateTables-RateTableDimensions-RateTableDimensionTiers-item-response

{
    "title":"Rate Dimensions Tiers",
    "type":"array",
    "description":"The rate dimensions tiers resource is only used to view all the details of the tiers in a rate dimension of the rate table.",
    "items":{
        "$ref":"#/components/schemas/rateTables-RateTableDimensions-RateTableDimensionTiers-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : rateTables-RateTableDimensions-RateTableDimensionTiers-item-response

Type: object

Show Source

• 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 with 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 tier. This attribute is only used when the rate dimension type is set as amount or percent. If the rate dimension type is percent, then the maximum amount stored here needs to be divided by 100 to get the actual value. For example, if the rate dimension is percent and the maximum amount is 20%, then 20 is maximum amount value.
• MaximumExpressionId: integer (int64)
  Title: To

  The unique identifier of the maximum expression. This represents the rate dimension ending tier only when rate dimension type is set as Expression.
• MaximumExpressionName: string
  Title: To

  Read Only: true

  The name of the maximum expression.
• MinimumAmount: number
  Title: From

  The minimum amount of the rate tier. This attribute is only used when the rate dimension type is set as amount or percent. If the rate dimension type is percent, then the minimum amount stored here needs to be divided by 100 to get the actual value. For example, if the rate dimension is percent and the minimum amount is 10%, then 10 is the minimum amount value.
• MinimumExpressionId: integer (int64)
  Title: From

  The unique identifier of the minimum expression. This represents the rate dimension starting tier only when rate dimension type is set as Expression.
• MinimumExpressionName: string
  Title: From

  Read Only: true

  The name of the minimum expression.
• RateDimensionId: integer (int64)
  The unique identifier of a rate dimension.
• RateDimTierId: integer (int64)
  Read Only: true

  The unique identifier of a rate dimension tier.
• RateTableDimensionTiersDeleteFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether the rate table dimension tiers record can be deleted using this service.
• RateTableDimensionTiersUpdateFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether the rate table dimension tiers record can be updated using this service.
• StringValue: string
  Title: String

  Maximum Length: 30

  The alphanumeric value of a rate tier. This attribute is only used when the rate dimension type is set as string.
• TierSequence: integer (int32)
  Title: Sequence

  Read Only: true

  The specified order of a tier within a rate dimension.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableDimensionTiersDeleteFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether the rate table dimension tiers record can be deleted using this service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"N"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimensionId":{
            "type":"integer",
            "description":"The unique identifier of a rate dimension.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateDimTierId":{
            "type":"integer",
            "description":"The unique identifier of a rate dimension tier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MaximumAmount":{
            "title":"To",
            "type":"number",
            "description":"The maximum amount of the rate tier. This attribute is only used when the rate dimension type is set as amount or percent. If the rate dimension type is percent, then the maximum amount stored here needs to be divided by 100 to get the actual value. For example, if the rate dimension is percent and the maximum amount is 20%, then 20 is maximum amount value.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumExpressionId":{
            "title":"From",
            "type":"integer",
            "description":"The unique identifier of the minimum expression. This represents the rate dimension starting tier only when rate dimension type is set as Expression.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "MaximumExpressionId":{
            "title":"To",
            "type":"integer",
            "description":"The unique identifier of the maximum expression. This represents the rate dimension ending tier only when rate dimension type is set as Expression.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateTableDimensionTiersUpdateFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether the rate table dimension tiers record can be updated using this service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"N"
            }
        },
        "MinimumExpressionName":{
            "title":"From",
            "type":"string",
            "description":"The name of the minimum expression.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The specified order of a tier within a rate dimension.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MinimumAmount":{
            "title":"From",
            "type":"number",
            "description":"The minimum amount of the rate tier. This attribute is only used when the rate dimension type is set as amount or percent. If the rate dimension type is percent, then the minimum amount stored here needs to be divided by 100 to get the actual value. For example, if the rate dimension is percent and the minimum amount is 10%, then 10 is the minimum amount value.",
            "nullable":true,
            "x-queryable":true
        },
        "StringValue":{
            "title":"String",
            "maxLength":"30",
            "type":"string",
            "description":"The alphanumeric value of a rate tier. This attribute is only used when the rate dimension type is set as string.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumExpressionName":{
            "title":"To",
            "type":"string",
            "description":"The name of the maximum expression.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated with the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

RateDimensionsVO

Operation: /fscmRestApi/resources/11.13.18.05/rateDimensions

The rate dimensions resource is used to create, update or delete a rate dimension. It can also be used to display all the details of rate dimensions. Rate tables contain one or more dimensions. Rate dimensions define the nature of the tiers that is used in a rate table.

RateTableDimensionTiers

Operation: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableDimensions/{RateTableDimId}/child/RateTableDimensionTiers

Parameters:

• RateTableDimId: $request.path.RateTableDimId
• RateTableId: $request.path.RateTableId

The rate dimensions tiers resource is only used to view all the details of the tiers in a rate dimension of the rate table.

Back to Top

Examples

The following example shows how to get a rate table dimension 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/rateTables/300100007837032/child/RateTableDimensions/300100007837039

Example of Response Body

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

{
  "RateTableDimId": 300100007837039,
  "RateTableId": 300100007837032,
  "RateDimensionId": 300100007837033,
  "RateDimSequence": 1,
  "RateTableName": "QA rate table for scenario 800",
  "RateDimensionName": "QA percent dimension for calc scenario 800",
  "NumberTier": 5,
  "RateDimensionType": "PERCENT",
  "RateTableDimensionsUpdateFlag": false,
  "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "CreationDate": "2012-04-23T23:40:20.671-07:00",
  "LastUpdateDate": "2012-04-23T23:40:42.882-07:00",
  "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "LastUpdateLogin": "BE55AD2BE2450B7DE0432220F00A4B43",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100007837032/child/RateTableDimensions/300100007837039",
      "name": "RateTableDimensions",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100007837032/child/RateTableDimensions/300100007837039",
      "name": "RateTableDimensions",
      "kind": "item"
    },
    {
      "rel": "parent",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100007837032",
      "name": "rateTables",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100007837032/child/RateTableDimensions/300100007837039/lov/RateDimensionsVO",
      "name": "RateDimensionsVO",
      "kind": "collection"
    }
  ]
}

Back to Top