Jump to

• Request
• Response

Create or edit a survey

post

/hcmRestApi/resources/11.13.18.05/communicateUIQuickCampaigns/{CampaignId}/child/assetDetails/action/createOrEditSurvey

Creates or edits a survey for a campaign asset in the quick campaign setup. This action allows users to define or modify survey details associated with a specific campaign asset.

Request

Path Parameters

• CampaignId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

• assetId: number
  Unique identifier for the asset.
• assetName: string
  Name of the asset associated with the campaign.
• assetSegments: array assetSegments
  Asset segments associated with the campaign for targeted communication.
• campaignId: number
  Unique identifier for the campaign associated with the asset details.
• finalBody: string
  Final content of the survey body after edits.
• finalSubject: string
  Final subject line for the campaign asset.
• followupDelay: number
  Follow-up delay for the survey in the campaign asset details.
• initialBody: string
  Initial body content for the survey in the campaign asset details.
• initialSubject: string
  Initial subject line for the survey in the quick campaign.
• lastDeliveryDate: string (date-time)
  Last delivery date for the survey in the campaign asset details.
• reminderBody: string
  Reminder body content for the survey in the campaign asset details.
• reminderSubject: string
  Reminder subject for the survey in the quick campaign.
• selectedTemplateId: number
  Selected template identifier for the survey in the campaign asset details.
• sendImmediatelyFlag: boolean
  Flag to determine if the survey should be sent immediately.
• startDeliveryDate: string (date-time)
  Start delivery date for the campaign asset.

{
    "type":"object",
    "properties":{
        "reminderSubject":{
            "type":"string",
            "description":"Reminder subject for the survey in the quick campaign.",
            "nullable":true
        },
        "assetSegments":{
            "type":"array",
            "description":"Asset segments associated with the campaign for targeted communication.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "sendImmediatelyFlag":{
            "type":"boolean",
            "description":"Flag to determine if the survey should be sent immediately.",
            "nullable":true
        },
        "finalSubject":{
            "type":"string",
            "description":"Final subject line for the campaign asset.",
            "nullable":true
        },
        "campaignId":{
            "type":"number",
            "description":"Unique identifier for the campaign associated with the asset details.",
            "nullable":true
        },
        "followupDelay":{
            "type":"number",
            "description":"Follow-up delay for the survey in the campaign asset details.",
            "nullable":true
        },
        "reminderBody":{
            "type":"string",
            "description":"Reminder body content for the survey in the campaign asset details.",
            "nullable":true
        },
        "lastDeliveryDate":{
            "type":"string",
            "description":"Last delivery date for the survey in the campaign asset details.",
            "format":"date-time",
            "nullable":true
        },
        "startDeliveryDate":{
            "type":"string",
            "description":"Start delivery date for the campaign asset.",
            "format":"date-time",
            "nullable":true
        },
        "selectedTemplateId":{
            "type":"number",
            "description":"Selected template identifier for the survey in the campaign asset details.",
            "nullable":true
        },
        "assetId":{
            "type":"number",
            "description":"Unique identifier for the asset.",
            "nullable":true
        },
        "assetName":{
            "type":"string",
            "description":"Name of the asset associated with the campaign.",
            "nullable":true
        },
        "initialSubject":{
            "type":"string",
            "description":"Initial subject line for the survey in the quick campaign.",
            "nullable":true
        },
        "finalBody":{
            "type":"string",
            "description":"Final content of the survey body after edits.",
            "nullable":true
        },
        "initialBody":{
            "type":"string",
            "description":"Initial body content for the survey in the campaign asset details.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : assetSegments

Type: array

Asset segments associated with the campaign for targeted communication.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Asset segments associated with the campaign for targeted communication.",
    "nullable":true,
    "items":{
        "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

  Return value for the create or edit survey action.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Return value for the create or edit survey action."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Return value for the create or edit survey action."
}

Return value for the create or edit survey action.

Back to Top