Jump to

• Request
• Response

Find a nudge plan execution

post

/hcmRestApi/resources/11.13.18.05/nudgePlanExecutions/action/findByAdvancedSearchQuery

Finds nudge plans execution based on the search criteria.

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

• autocompleteQuery: string
  Indicates whether the query for a nudge plan execution is auto completed. Valid values are Yes and No. The default value is Yes.
• displayFields: array displayFields
  Display fields for the nudge plan execution search response.
• filters: array filters
  Facet filters for the nudge plan execution search.
• limit: number
  Fetch size limit for nudge plan execution query result.
• offset: number
  Start range for the nudge plan execution query result.
• query: string
  Keyword query search for the nudge plan execution.
• searchFields: array searchFields
  Search fields for the nudge plan execution keyword query.
• sort: array sort
  Sort order of the nudge plan execution search results.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Start range for the nudge plan execution query result.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Keyword query search for the nudge plan execution.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Fetch size limit for nudge plan execution query result.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields for the nudge plan execution keyword query.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Facet filters for the nudge plan execution search.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort order of the nudge plan execution search results.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Display fields for the nudge plan execution search response.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Indicates whether the query for a nudge plan execution is auto completed. Valid values are Yes and No. The default value is Yes.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Display fields for the nudge plan execution search response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Display fields for the nudge plan execution search response.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Facet filters for the nudge plan execution search.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Facet filters for the nudge plan execution search.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Search fields for the nudge plan execution keyword query.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Search fields for the nudge plan execution keyword query.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort order of the nudge plan execution search results.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort order of the nudge plan execution search results.",
    "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

  Response returned for a nudge plan execution search query.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Response returned for a nudge plan execution search query."
        }
    },
    "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":"Response returned for a nudge plan execution search query."
}

Response returned for a nudge plan execution search query.

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