Find the workload plans matching the specified criteria
post
/hcmRestApi/resources/11.13.18.05/workloadPlans/action/findByAdvancedSearchQuery
Finds the workload plans matching the specified criteria such as department or location.
Request
Header Parameters
-
Metadata-Context:
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:
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
Root Schema : schema
Type:
Show Source
object
-
autocompleteQuery: string
Indicates whether the query is completed automatically. Valid values are Y and N. The default value is Y.
-
displayFields: array
displayFields
Fields displayed for the workload plans search response, such as WorkloadType and DepartmentName.
-
filters: array
filters
Filters for the workload plans search.
-
limit: number
Size limit for fetching workload plans results. The default value is 25.
-
offset: number
Start range for the workload plans result limit.
-
query: string
Keywords used to search for the workload plans.
-
searchFields: array
searchFields
Search fields for the workload plans query, such as WorkloadType, DepartmentName, and JobProfileType.
-
sort: array
sort
Sort order for the workload plans search results.
Nested Schema : displayFields
Type:
array
Fields displayed for the workload plans search response, such as WorkloadType and DepartmentName.
Show Source
Nested Schema : filters
Type:
array
Filters for the workload plans search.
Show Source
-
Array of:
object items
Additional Properties Allowed: additionalProperties
Nested Schema : searchFields
Type:
array
Search fields for the workload plans query, such as WorkloadType, DepartmentName, and JobProfileType.
Show Source
Nested Schema : sort
Type:
array
Sort order for the workload plans search results.
Show Source
-
Array of:
object items
Additional Properties Allowed: additionalProperties
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Root Schema : schema
Type:
Show Source
object
-
result(required): object
result
Additional Properties Allowed: additionalPropertiesResponse for a workload plans query.
Nested Schema : result
Type:
object
Additional Properties Allowed
Show Source
Response for a workload plans query.
Nested Schema : additionalProperties
Type:
Show Source
array
-
Array of:
object items
Additional Properties Allowed: additionalProperties