Jump to

• Request
• Response

Get the salary details from the transaction cache.

post

/hcmRestApi/resources/11.13.18.05/salaries/action/getTxnCacheSalary

Gets the current and proposed salary details from the transaction cache.

Request

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

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

Root Schema : schema

Type: object

Show Source

• assignmentId: number
  Unique identifier for a worker assignment.
• cacheType: string
  Type of cache being used, such as current, proposed.
• effectiveDate: string (date)
  Date used to find the salary applicable for the day.
• flowMap: object flowMap
  Additional Properties Allowed: additionalProperties

  Map that contains various details of the work assignment.
• flowName: string
  Name of the flow that's using the REST service.
• transactionId: number
  Unique identifier for the salary transaction.

{
    "type":"object",
    "properties":{
        "flowMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Map that contains various details of the work assignment.",
            "nullable":true
        },
        "assignmentId":{
            "type":"number",
            "description":"Unique identifier for a worker assignment.",
            "nullable":true
        },
        "flowName":{
            "type":"string",
            "description":"Name of the flow that's using the REST service.",
            "nullable":true
        },
        "cacheType":{
            "type":"string",
            "description":"Type of cache being used, such as current, proposed.",
            "nullable":true
        },
        "effectiveDate":{
            "type":"string",
            "description":"Date used to find the salary applicable for the day.",
            "format":"date",
            "nullable":true
        },
        "transactionId":{
            "type":"number",
            "description":"Unique identifier for the salary transaction.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : flowMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Map that contains various details of the work assignment.",
    "nullable":true
}

Map that contains various details of the work assignment.

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":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Search response for a query."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

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

Search response for a query.

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

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

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

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

Back to Top