Find library goals by advance search
post
/hcmRestApi/resources/11.13.18.05/libraryGoals/action/findByAdvancedSearchQuery
Finds library goals by using advance 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 is auto completed. Valid values are Y and N. The default value is Y.
-
displayFields: array
displayFields
Attributes of the library goal that are displayed in the results of the library goal search. The display attributes for library goals are the goal name, category, status, goal visibility, and last update date.
-
filters: array
filters
Attributes by which the results of the library goal search can be filtered. The filter attributes for library goals are the goal name, status, goal visibility, legal employer, business unit, department, and job family.
-
limit: number
Restriction for the number of goals returned. If the limit exceeds the resource count, then the framework returns only the available goals.
-
offset: number
Starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
query: string
Query parameter defines the where clause. The resource collection is queried using the provided expressions. The value of this query parameter is one or more expressions.
-
searchFields: array
searchFields
Attribute for searching the library goals, which is the goal name.
-
sort: array
sort
Attributes by which the results of the library goal search can be sorted. The sort attributes for library goals are the goal name and the last update date.
Nested Schema : displayFields
Type:
array
Attributes of the library goal that are displayed in the results of the library goal search. The display attributes for library goals are the goal name, category, status, goal visibility, and last update date.
Show Source
Nested Schema : filters
Type:
array
Attributes by which the results of the library goal search can be filtered. The filter attributes for library goals are the goal name, status, goal visibility, legal employer, business unit, department, and job family.
Show Source
-
Array of:
object items
Additional Properties Allowed: additionalProperties
Nested Schema : searchFields
Type:
array
Attribute for searching the library goals, which is the goal name.
Show Source
Nested Schema : sort
Type:
array
Attributes by which the results of the library goal search can be sorted. The sort attributes for library goals are the goal name and the last update date.
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: additionalPropertiesLibrary goals that match the criteria specified.
Nested Schema : result
Type:
object
Additional Properties Allowed
Show Source
Library goals that match the criteria specified.
Nested Schema : additionalProperties
Type:
Show Source
array
-
Array of:
object items
Additional Properties Allowed: additionalProperties