Find document records
post
/hcmRestApi/resources/11.13.18.05/documentRecords/action/findByAdvancedSearchQuery
Finds document records for a worker.
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
Auto complete indicator of the document record query. Valid values are Yes and No. The default value is Yes.
-
displayFields: array
displayFields
Display fields for the document record search response.
-
filters: array
filters
Facet filters for the document record search.
-
limit: number
Limit for document record result fetch size.
-
offset: number
Start range for the document record result limit.
-
query: string
Keyword query search for the document record.
-
searchFields: array
searchFields
Search fields for the document record keyword query.
-
sort: array
sort
Sort order of the document record search results.
Nested Schema : displayFields
Type:
array
Display fields for the document record search response.
Show Source
Nested Schema : filters
Type:
array
Facet filters for the document record search.
Show Source
-
Array of:
object items
Additional Properties Allowed: additionalProperties
Nested Schema : searchFields
Type:
array
Search fields for the document record keyword query.
Show Source
Nested Schema : sort
Type:
array
Sort order of the document record 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: additionalPropertiesSearch response returned for a document record query.
Nested Schema : result
Type:
object
Additional Properties Allowed
Show Source
Search response returned for a document record query.
Nested Schema : additionalProperties
Type:
Show Source
array
-
Array of:
object items
Additional Properties Allowed: additionalProperties