Jump to

• Request
• Response

Perform employee event related actions

post

/hcmRestApi/resources/11.13.18.05/communicateUIEmployeeEventDetails/action/processEmpEventAction

Performs employee event related actions such as cancel event and send message.

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

• actionData: string
  Payload containing the actions to be performed.
• actionTypeCode: string
  Employee event action identifier.
• context: string
  Context parameter that represents the origin of an action, such as employee event details or employee event respondents list.
• eventNumber: string
  Event identifier used to fetch an event.

{
    "type":"object",
    "properties":{
        "eventNumber":{
            "type":"string",
            "description":"Event identifier used to fetch an event.",
            "nullable":true
        },
        "context":{
            "type":"string",
            "description":"Context parameter that represents the origin of an action, such as employee event details or employee event respondents list.",
            "nullable":true
        },
        "actionData":{
            "type":"string",
            "description":"Payload containing the actions to be performed.",
            "nullable":true
        },
        "actionTypeCode":{
            "type":"string",
            "description":"Employee event action identifier.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

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

  Response returned when an event action is performed successfully with action_tracking_id.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Response returned when an event action is performed successfully with action_tracking_id."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Response returned when an event action is performed successfully with action_tracking_id."
}

Response returned when an event action is performed successfully with action_tracking_id.

Back to Top