Jump to

• Request
• Response

Update a simple component

patch

/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salarySimpleComponents/{SimpleSalaryCompntId}

Request

Path Parameters

• SalaryId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• SimpleSalaryCompntId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdjustmentAmount: number
  Title: Adjustment Amount

  Change amount for a simple component.
• AdjustmentPercent: number
  Title: Adjustment Percentage

  Change percentage for a simple component.
• Amount: number
  Title: Amount

  Amount of the person's salary entered on the simple component
• AnnualAmount: number
  Title: Annual Amount

  Annual value of the simple component amount.
• AnnualFtAmount: number
  Title: Annualized Full-Time Amount

  Annual value of the simple component amount, if the person worked full time.
• BasedOnComponentCode: string
  Maximum Length: 30

  Code of the simple component that the percentage applies to.
• BasedOnComponentName: string
  Name of the simple component that the percentage applies to.
• BasisSimpleComponentId: integer (int64)
  Unique identifier of the simple component that the percentage applies to.
• ComponentCode: string
  Title: Salary Component Code

  Maximum Length: 30

  Code of the salary simple component, such as ORA_BASIC.
• ComponentName: string
  Title: Component

  Name of the simple component, which can be configured to accept an amount or percentage.
• ComponentType: string
  Title: Type

  Maximum Length: 30

  Code for the simple component type.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 30

  Currency code that the simple component value is stored in, such as USD.
• DisplaySequence: integer (int32)
  Title: Display Sequence

  Display sequence of the simple component.
• OverallSalaryAffect: string
  Title: Overall Salary

  Maximum Length: 30

  Code for the effect of overall salary.
• OverrideGspRate: string
  Maximum Length: 30

  Indicates whether a user can override the value defaulted from the progression ladder.
• Percentage: number
  Title: Percentage

  Percentage entered for the simple component. This percentage is applied to the specified based on simple component, to calculate the component amount. For example, apply 5% to the Base Salary simplified component.
• PreviousAmount: number
  Title: Previous Rate Amount

  Previous simple component amount.
• SalaryId: integer (int64)
  Unique identifier of the salary.
• Scale: integer (int32)
  Decimal precision of the salary amount, configured in salary basis.
• UserSelectedComponent: string
  Maximum Length: 30

  Property used to specify whether the incremental components type is SELECTED_COMPONENTS or USER_DECIDES_USAGE.

{
    "type":"object",
    "properties":{
        "AdjustmentPercent":{
            "title":"Adjustment Percentage",
            "type":"number",
            "description":"Change percentage for a simple component.",
            "nullable":true
        },
        "ComponentType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Code for the simple component type.",
            "nullable":true
        },
        "BasisSimpleComponentId":{
            "type":"integer",
            "description":"Unique identifier of the simple component that the percentage applies to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "UserSelectedComponent":{
            "maxLength":"30",
            "type":"string",
            "description":"Property used to specify whether the incremental components type is SELECTED_COMPONENTS or USER_DECIDES_USAGE.",
            "nullable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Display sequence of the simple component.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            }
        },
        "Percentage":{
            "title":"Percentage",
            "type":"number",
            "description":"Percentage entered for the simple component. This percentage is applied to the specified based on simple component, to calculate the component amount. For example, apply 5% to the Base Salary simplified component.",
            "nullable":true
        },
        "PreviousAmount":{
            "title":"Previous Rate Amount",
            "type":"number",
            "description":"Previous simple component amount.",
            "nullable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount of the person's salary entered on the simple component",
            "nullable":false
        },
        "ComponentCode":{
            "title":"Salary Component Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the salary simple component, such as ORA_BASIC.",
            "nullable":true
        },
        "Scale":{
            "type":"integer",
            "description":"Decimal precision of the salary amount, configured in salary basis.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            }
        },
        "AnnualFtAmount":{
            "title":"Annualized Full-Time Amount",
            "type":"number",
            "description":"Annual value of the simple component amount, if the person worked full time.",
            "nullable":true
        },
        "OverallSalaryAffect":{
            "title":"Overall Salary",
            "maxLength":"30",
            "type":"string",
            "description":"Code for the effect of overall salary.",
            "nullable":true
        },
        "AnnualAmount":{
            "title":"Annual Amount",
            "type":"number",
            "description":"Annual value of the simple component amount.",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"30",
            "type":"string",
            "description":"Currency code that the simple component value is stored in, such as USD.",
            "nullable":true
        },
        "SalaryId":{
            "type":"integer",
            "description":"Unique identifier of the salary.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BasedOnComponentName":{
            "type":"string",
            "description":"Name of the simple component that the percentage applies to.",
            "nullable":true
        },
        "OverrideGspRate":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether a user can override the value defaulted from the progression ladder.",
            "nullable":true
        },
        "BasedOnComponentCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code of the simple component that the percentage applies to.",
            "nullable":true
        },
        "AdjustmentAmount":{
            "title":"Adjustment Amount",
            "type":"number",
            "description":"Change amount for a simple component.",
            "nullable":true
        },
        "ComponentName":{
            "title":"Component",
            "type":"string",
            "description":"Name of the simple component, which can be configured to accept an amount or percentage.",
            "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 : salaries-salarySimpleComponents-item-response

Type: object

Show Source

• AdjustmentAmount: number
  Title: Adjustment Amount

  Change amount for a simple component.
• AdjustmentPercent: number
  Title: Adjustment Percentage

  Change percentage for a simple component.
• Amount: number
  Title: Amount

  Amount of the person's salary entered on the simple component
• AnnualAmount: number
  Title: Annual Amount

  Annual value of the simple component amount.
• AnnualFtAmount: number
  Title: Annualized Full-Time Amount

  Annual value of the simple component amount, if the person worked full time.
• BasedOnComponentCode: string
  Maximum Length: 30

  Code of the simple component that the percentage applies to.
• BasedOnComponentName: string
  Name of the simple component that the percentage applies to.
• BasisSimpleComponentId: integer (int64)
  Unique identifier of the simple component that the percentage applies to.
• ComponentCode: string
  Title: Salary Component Code

  Maximum Length: 30

  Code of the salary simple component, such as ORA_BASIC.
• ComponentName: string
  Title: Component

  Name of the simple component, which can be configured to accept an amount or percentage.
• ComponentType: string
  Title: Type

  Maximum Length: 30

  Code for the simple component type.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 30

  Currency code that the simple component value is stored in, such as USD.
• DisplaySequence: integer (int32)
  Title: Display Sequence

  Display sequence of the simple component.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OverallSalaryAffect: string
  Title: Overall Salary

  Maximum Length: 30

  Code for the effect of overall salary.
• OverrideGspRate: string
  Maximum Length: 30

  Indicates whether a user can override the value defaulted from the progression ladder.
• Percentage: number
  Title: Percentage

  Percentage entered for the simple component. This percentage is applied to the specified based on simple component, to calculate the component amount. For example, apply 5% to the Base Salary simplified component.
• PreviousAmount: number
  Title: Previous Rate Amount

  Previous simple component amount.
• SalaryId: integer (int64)
  Unique identifier of the salary.
• Scale: integer (int32)
  Decimal precision of the salary amount, configured in salary basis.
• SimpleSalaryCompntId: integer (int64)
  Unique identifier of the salary simple component.
• UserSelectedComponent: string
  Maximum Length: 30

  Property used to specify whether the incremental components type is SELECTED_COMPONENTS or USER_DECIDES_USAGE.

{
    "type":"object",
    "properties":{
        "AdjustmentPercent":{
            "title":"Adjustment Percentage",
            "type":"number",
            "description":"Change percentage for a simple component.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Code for the simple component type.",
            "nullable":true,
            "x-queryable":true
        },
        "BasisSimpleComponentId":{
            "type":"integer",
            "description":"Unique identifier of the simple component that the percentage applies to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserSelectedComponent":{
            "maxLength":"30",
            "type":"string",
            "description":"Property used to specify whether the incremental components type is SELECTED_COMPONENTS or USER_DECIDES_USAGE.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Display sequence of the simple component.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "Percentage":{
            "title":"Percentage",
            "type":"number",
            "description":"Percentage entered for the simple component. This percentage is applied to the specified based on simple component, to calculate the component amount. For example, apply 5% to the Base Salary simplified component.",
            "nullable":true,
            "x-queryable":true
        },
        "PreviousAmount":{
            "title":"Previous Rate Amount",
            "type":"number",
            "description":"Previous simple component amount.",
            "nullable":true,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount of the person's salary entered on the simple component",
            "nullable":false,
            "x-queryable":true
        },
        "ComponentCode":{
            "title":"Salary Component Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the salary simple component, such as ORA_BASIC.",
            "nullable":true,
            "x-queryable":true
        },
        "Scale":{
            "type":"integer",
            "description":"Decimal precision of the salary amount, configured in salary basis.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "AnnualFtAmount":{
            "title":"Annualized Full-Time Amount",
            "type":"number",
            "description":"Annual value of the simple component amount, if the person worked full time.",
            "nullable":true,
            "x-queryable":true
        },
        "OverallSalaryAffect":{
            "title":"Overall Salary",
            "maxLength":"30",
            "type":"string",
            "description":"Code for the effect of overall salary.",
            "nullable":true,
            "x-queryable":true
        },
        "AnnualAmount":{
            "title":"Annual Amount",
            "type":"number",
            "description":"Annual value of the simple component amount.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"30",
            "type":"string",
            "description":"Currency code that the simple component value is stored in, such as USD.",
            "nullable":true,
            "x-queryable":true
        },
        "SalaryId":{
            "type":"integer",
            "description":"Unique identifier of the salary.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BasedOnComponentName":{
            "type":"string",
            "description":"Name of the simple component that the percentage applies to.",
            "nullable":true,
            "x-queryable":true
        },
        "SimpleSalaryCompntId":{
            "type":"integer",
            "description":"Unique identifier of the salary simple component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OverrideGspRate":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether a user can override the value defaulted from the progression ladder.",
            "nullable":true,
            "x-queryable":true
        },
        "BasedOnComponentCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code of the simple component that the percentage applies to.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentAmount":{
            "title":"Adjustment Amount",
            "type":"number",
            "description":"Change amount for a simple component.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ComponentName":{
            "title":"Component",
            "type":"string",
            "description":"Name of the simple component, which can be configured to accept an amount or percentage.",
            "nullable":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 : 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."
        }
    }
}

Back to Top