Jump to

• Request
• Response

Initialize HCM parameters for salary history notification

post

/hcmRestApi/resources/11.13.18.05/salaries/action/setSalaryHistoryCache

Initializes HCM Parameters, such as Person Identifier and Assignment Identifier, for salary history Business Intelligence Publisher notification.

Request

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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• asgId: number
  Unique identifier of a worker assignment.
• personId: number
  Unique identifier for the person.
• salaryChildRowMaps: object salaryChildRowMaps
  Additional Properties Allowed: additionalProperties

  Maps containing salary component rows with details, such as component and amount or percentage.
• salaryHistParamsMap: object salaryHistParamsMap
  Additional Properties Allowed: additionalProperties

  Map containing various salary history parameters, such as number of rows created, updated, and deleted.
• salaryRowMaps: object salaryRowMaps
  Additional Properties Allowed: additionalProperties

  Maps containing salary rows with details, such as start date, end date, and salary basis.

{
    "type":"object",
    "properties":{
        "salaryHistParamsMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Map containing various salary history parameters, such as number of rows created, updated, and deleted.",
            "nullable":true
        },
        "salaryChildRowMaps":{
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            },
            "description":"Maps containing salary component rows with details, such as component and amount or percentage.",
            "nullable":true
        },
        "personId":{
            "type":"number",
            "description":"Unique identifier for the person.",
            "nullable":true
        },
        "salaryRowMaps":{
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            },
            "description":"Maps containing salary rows with details, such as start date, end date, and salary basis.",
            "nullable":true
        },
        "asgId":{
            "type":"number",
            "description":"Unique identifier of a worker assignment.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : salaryChildRowMaps

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    },
    "description":"Maps containing salary component rows with details, such as component and amount or percentage.",
    "nullable":true
}

Maps containing salary component rows with details, such as component and amount or percentage.

Nested Schema : salaryHistParamsMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Map containing various salary history parameters, such as number of rows created, updated, and deleted.",
    "nullable":true
}

Map containing various salary history parameters, such as number of rows created, updated, and deleted.

Nested Schema : salaryRowMaps

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    },
    "description":"Maps containing salary rows with details, such as start date, end date, and salary basis.",
    "nullable":true
}

Maps containing salary rows with details, such as start date, end date, and salary basis.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Search response for a query.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Search response for a query."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Search response for a query."
}

Search response for a query.

Back to Top