Jump to

• Request
• Response
• Examples

Update a rate dimension tier

patch

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

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.
• RateDimensionId: integer (int64)
  The unique identifier of a rate dimension record.
• StringValue: string
  Title: String

  Maximum Length: 30

  The alphanumeric value of a rate dimension tier with type set as string.

{
    "type":"object",
    "properties":{
        "MaximumAmount":{
            "title":"To",
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "MaximumExpressionId":{
            "title":"To",
            "type":"integer",
            "description":"This is a unique identifier for maximum expression. This represents the rate dimension ending tier where tiers are expressions.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "MinimumAmount":{
            "title":"From",
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "MinimumExpressionId":{
            "title":"From",
            "type":"integer",
            "description":"This is a unique identifier for minimum expression. This represents the rate dimension starting tier where tiers are expressions.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "RateDimensionId":{
            "type":"integer",
            "description":"The unique identifier of a rate dimension record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StringValue":{
            "title":"String",
            "maxLength":30,
            "type":"string",
            "description":"The alphanumeric value of a rate dimension tier with type set as string.",
            "nullable":true
        }
    }
}

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 : rateDimensions-RateDimensionTiers-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 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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the 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
        },
        "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 to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumAmount":{
            "title":"To",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumExpressionId":{
            "title":"To",
            "type":"integer",
            "description":"This is a unique identifier for maximum expression. This represents the rate dimension ending tier where tiers are expressions.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "MaximumExpressionName":{
            "title":"To",
            "type":"string",
            "description":"The name of the maximum expression.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumAmount":{
            "title":"From",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumExpressionId":{
            "title":"From",
            "type":"integer",
            "description":"This is a unique identifier for minimum expression. This represents the rate dimension starting tier where tiers are expressions.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "MinimumExpressionName":{
            "title":"From",
            "type":"string",
            "description":"The name of the minimum expression.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "RateDimensionId":{
            "type":"integer",
            "description":"The unique identifier of a rate dimension record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StringValue":{
            "title":"String",
            "maxLength":30,
            "type":"string",
            "description":"The alphanumeric value of a rate dimension tier with type set as string.",
            "nullable":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"
            }
        }
    }
}

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 : 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."
        }
    }
}

Links

MaximumExpressionVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionUsagesLOV

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

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationExpressionUsagesLOV

The expression usages list of values resource is used to view the list of expression usages which indicate where an expression can be used.

Back to Top

Examples

The following example shows how to update a rate dimension tier by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584746/child/RateDimensionTiers/300100089584748

Example of Request Body

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

{

 "MaximumAmount": 4000

}

Example of Response Body

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

{
   "RateDimTierId": 300100089584748,
   "RateDimensionId": 300100089584746,
   "TierSequence": 2,
   "MinimumAmount": 1000,
   "MaximumAmount": 4000,
   "StringValue": null,
   "MinimumExpressionId": null,
   "MaximumExpressionId": null,
   "MinimumExpressionName": null,
   "MaximumExpressionName": null,
   "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
   "CreationDate": "2017-04-13T13:05:38+05:30",
   "LastUpdateDate": "2017-04-13T14:04:59+05:30",
   "LastUpdateLogin": "4D08BCC1FBB47D7CE053CB90B10AEB84",
   "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/300100089584748",
         "name": "RateDimensionTiers",
         "kind": "item",
         "properties": {"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"}
      },
            {
         "rel": "canonical",
         "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateDimensions/300100089584746/child/RateDimensionTiers/300100089584748",
         "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/300100089584748/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/300100089584748/lov/MaximumExpressionVO",
         "name": "MaximumExpressionVO",
         "kind": "collection"
      }
   ]
}

Back to Top