Jump to

• Request
• Response

Get campaign audience responses

post

/hcmRestApi/resources/11.13.18.05/communicateUICampaignRespondents/action/getCampaignAudienceResponses

Gets campaign audience responses.

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

• campaignCode: string
  Campaign code of a campaign.
• displayFields: array displayFields
  Display fields for a campaign audience response.
• filters: array filters
  Filter campaign audience responses.
• limit: number
  Limit value on number of campaign audience responses.
• offset: number
  Page offset for searching campaign audience responses.
• query: string
  Search keyword passed from campaign audience responses list UI.
• sort: array sort
  Sorting method for ordering the list of campaign audience responses returned.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Page offset for searching campaign audience responses.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Search keyword passed from campaign audience responses list UI.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Limit value on number of campaign audience responses.",
            "nullable":true
        },
        "filters":{
            "type":"array",
            "description":"Filter campaign audience responses.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sorting method for ordering the list of campaign audience responses returned.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Display fields for a campaign audience response.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "campaignCode":{
            "type":"string",
            "description":"Campaign code of a campaign.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Display fields for a campaign audience response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Display fields for a campaign audience response.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Filter campaign audience responses.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Filter campaign audience responses.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : sort

Type: array

Sorting method for ordering the list of campaign audience responses returned.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sorting method for ordering the list of campaign audience responses returned.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

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

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

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

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "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

  List of campaign audience responses returned.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"List of campaign audience responses returned."
        }
    },
    "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":"List of campaign audience responses returned."
}

List of campaign audience responses returned.

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