Allow user to perform actions
post
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/action/campaignAction
Allows user to perform various actions on the campaign based on the campaign status.
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
Root Schema : schema
Type:
Show Source
object
-
actionType: string
Indicates the type of action available to the user.
-
campaignId: number
Unique identifier for a campaign.
-
campaignName: string
Name of the campaign on which the user can take an action.
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Root Schema : schema
Type:
Show Source
object
-
result(required): object
result
Additional Properties Allowed: additionalPropertiesIndicates whether the action taken by the user was successful.
Nested Schema : result
Type:
object
Additional Properties Allowed
Show Source
Indicates whether the action taken by the user was successful.