Perform advanced search
post
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/action/findByAdvancedSearchQuery
Finds all data sets using the specified advanced search query criteria.
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 for data sets is auto completed. Valid values are Y and N. The default value is Y.
-
displayFields: array
displayFields
Display fields for the data set search response. The display fields can include fields such as data set name, import success count, load success count, and so on.
-
filters: array
filters
Facet filters for the data set search. These filters can include attributes such as the data set name, archival status and created by.
-
limit: number
Maximum number of data set records returned based on the search criteria. If the value exceeds the maximum, then the maximum value will be used.
-
offset: number
Starting position of the resource collection. If the offset exceeds the resource count then no resources are returned. Default value is 0.
-
query: string
Filter criteria in the advanced search query consisting of one or more expressions applied to the resource collection.
-
searchFields: array
searchFields
Search field for the data set keyword query such as the Oracle WebCenter content identifier.
-
sort: array
sort
Sort criteria for the data set search results.
Nested Schema : displayFields
Type:
array
Display fields for the data set search response. The display fields can include fields such as data set name, import success count, load success count, and so on.
Show Source
Nested Schema : filters
Type:
array
Facet filters for the data set search. These filters can include attributes such as the data set name, archival status and created by.
Show Source
-
Array of:
object items
Additional Properties Allowed: additionalProperties
Nested Schema : searchFields
Type:
array
Search field for the data set keyword query such as the Oracle WebCenter content identifier.
Show Source
Nested Schema : sort
Type:
array
Sort criteria for the data set 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: additionalPropertiesResults of the advanced search query.
Nested Schema : result
Type:
object
Additional Properties Allowed
Show Source
Results of the advanced search query.
Nested Schema : additionalProperties
Type:
Show Source
array
-
Array of:
object items
Additional Properties Allowed: additionalProperties