Jump to

• Request
• Response

View the uploaded audience

post

/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/uploadAudiences/action/findByAdvancedSearchQuery

Views the uploaded audience using specific criteria.

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

• autocompleteQuery: string
  Search parameter for auto complete suggestions.
• displayFields: array displayFields
  List of available fields in the search results.
• filters: array filters
  List of available filters for the employee records.
• limit: number
  Maximum number of search results that can be returned in a single response.
• offset: number
  Offset for the employee records.
• query: string
  Search parameter for the employee records.
• searchFields: array searchFields
  List of available fields against which a search can be performed.
• sort: array sort
  Sort order for the employee records.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Offset for the employee records.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Search parameter for the employee records.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Maximum number of search results that can be returned in a single response.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"List of available fields against which a search can be performed.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"List of available filters for the employee records.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort order for the employee records.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"List of available fields in the search results.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Search parameter for auto complete suggestions.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

List of available fields in the search results.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of available fields in the search results.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

List of available filters for the employee records.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"List of available filters for the employee records.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

List of available fields against which a search can be performed.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of available fields against which a search can be performed.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort order for the employee records.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort order for the employee records.",
    "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 available fields in the search results.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"List of available fields in the search results."
        }
    },
    "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 available fields in the search results."
}

List of available fields in the search results.

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