Jump to

• Request
• Response

Promote a quick campaign entity

post

/hcmRestApi/resources/11.13.18.05/communicateUIQuickCampaigns/action/promoteEntity

Promotes a quick campaign entity to enhance visibility or priority within the communication UI. The campaign must be in a valid state for promotion.

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

• AudienceCriteria: string
  Audience criteria used to define the target group for the quick campaign.
• EntityCode: string
  Unique identifier for the entity to be promoted.
• EntityId: string
  Unique identifier to promote the entity.
• EntityName: string
  Name of the entity to be promoted in the quick campaign.
• EntityType: string
  Entity type for the quick campaign to be promoted.
• MessageContent: string
  Message content for the quick campaign to be promoted.

{
    "type":"object",
    "properties":{
        "EntityId":{
            "type":"string",
            "description":"Unique identifier to promote the entity.",
            "nullable":true
        },
        "EntityType":{
            "type":"string",
            "description":"Entity type for the quick campaign to be promoted.",
            "nullable":true
        },
        "MessageContent":{
            "type":"string",
            "description":"Message content for the quick campaign to be promoted.",
            "nullable":true
        },
        "EntityName":{
            "type":"string",
            "description":"Name of the entity to be promoted in the quick campaign.",
            "nullable":true
        },
        "AudienceCriteria":{
            "type":"string",
            "description":"Audience criteria used to define the target group for the quick campaign.",
            "nullable":true
        },
        "EntityCode":{
            "type":"string",
            "description":"Unique identifier for the entity to be promoted.",
            "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

  Return value after promoting the entity.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Return value after promoting the entity."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Return value after promoting the entity."
}

Return value after promoting the entity.

Back to Top