Finds the workforce schedule shifts that match the specified criteria.
post
/hcmRestApi/resources/11.13.18.05/scheduleShifts/action/findByAdvancedSearchQuery
Finds the workforce schedule shifts that match the specified criteria, such as name or code.
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
The display fields for the workforce schedule shifts search response, such as Name and Code.
-
filters: array
filters
The facet filters for the workforce schedule shifts search.
-
limit: number
Fetch size limit for workforce schedule shifts results. The default value is 25.
-
offset: number
Start range for the workforce schedule shifts result limit.
-
query: string
Keyword query search for the workforce schedule shifts.
-
searchFields: array
searchFields
The search fields for the workforce schedule shifts keyword query, such as Name and Code.
-
sort: array
sort
The sort order for the schedules search results.
Nested Schema : displayFields
Type:
array
The display fields for the workforce schedule shifts search response, such as Name and Code.
Show Source
Nested Schema : filters
Type:
array
The facet filters for the workforce schedule shifts search.
Show Source
-
Array of:
object items
Additional Properties Allowed: additionalProperties
Nested Schema : searchFields
Type:
array
The search fields for the workforce schedule shifts keyword query, such as Name and Code.
Show Source
Nested Schema : sort
Type:
array
The sort order for the schedules 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: additionalPropertiesThe search response that was returned for a workforce schedule shifts query.
Nested Schema : result
Type:
object
Additional Properties Allowed
Show Source
The search response that was returned for a workforce schedule shifts query.
Nested Schema : additionalProperties
Type:
Show Source
array
-
Array of:
object items
Additional Properties Allowed: additionalProperties