Jump to

• Request
• Response

Find nudge plan execution summary

post

/hcmRestApi/resources/11.13.18.05/nudgePlanExecutions/{PlanExecutionId}/action/findByAdvancedSearchForNudgeExecutionSummary

Finds nudge plan execution summary based on the search criteria.

Request

Path Parameters

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

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Start range for the nudge plan execution summary query result.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Keyword query search for the nudge plan execution summary.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Fetch size limit for nudge plan execution summary query result.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields for the nudge plan execution summary keyword query.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Facet filters for the nudge plan execution summary search.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort order of the nudge plan execution summary search results.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Display fields for the nudge plan execution summary search response.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Indicates whether the query for a nudge plan execution summary 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 summary search response.

Show Source

• Array of: string

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

Nested Schema : filters

Type: array

Facet filters for the nudge plan execution summary search.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

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

Nested Schema : searchFields

Type: array

Search fields for the nudge plan execution summary keyword query.

Show Source

• Array of: string

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

Nested Schema : sort

Type: array

Sort order of the nudge plan execution summary search results.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

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

Response returned for a nudge plan execution summary 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