Get all candidate work preferences
get
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences
Request
Path Parameters
-
CandidateNumber(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds all candidate work preferences using a unique ID.
Finder Variables- WorkPreferenceId; integer; Unique ID and work preferences used to find the candidate work preferences.
- PrimaryKey Finds all candidate work preferences using a unique ID.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2 -
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : recruitingCandidates-workPreferences
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCandidates-workPreferences-item-response
Type:
Show Source
object
-
AllLocationsFlag: boolean
Title:
All Locations
Maximum Length:30
All locations preferred indicator in recruiting candidate work preferences. -
Comments: string
(byte)
Title:
Comments
Comments in recruiting candidate work preferences. -
ContentItemId: integer
(int64)
Content item ID in recruiting candidate work preferences.
-
CurrencyCode: string
Title:
Currency Code
Maximum Length:30
Currency code in recruiting candidate work preferences. -
DateFrom: string
(date)
Date from in recruiting candidate work preferences.
-
DateTo: string
(date)
Date to in recruiting candidate work preferences.
-
ExcludedLocationFourId: integer
(int64)
Title:
Fourth Excluded Location
Excluded location four ID in recruiting candidate work preferences. -
ExcludedLocationOneId: integer
(int64)
Title:
First Excluded Location
Excluded location one ID in recruiting candidate work preferences. -
ExcludedLocationThreeId: integer
(int64)
Title:
Third Excluded Location
Excluded location three ID in recruiting candidate work preferences. -
ExcludedLocationTwoId: integer
(int64)
Title:
Second Excluded Location
Excluded location two ID in recruiting candidate work preferences. -
FlexibleWorkFlag: boolean
Title:
Work a Flexible Schedule
Maximum Length:30
Flexible work required indicator in recruiting candidate work preferences. -
FullTimeEquivalent: number
Title:
Full Time Equivalent
Full time equivalent in recruiting candidate work preferences. -
IntlTravelFlag: boolean
Title:
Travel Internationally
Maximum Length:30
International travel required indicator in recruiting candidate work preferences. -
IntlTravelFrequency: string
Title:
International Travel Frequency
Maximum Length:30
International travel frequency in recruiting candidate work preferences. -
IntlTravelRequiredFlag: boolean
Title:
International Travel Required
Maximum Length:30
International travel required indicator in the recruiting candidate work preferences. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MinimumPay: integer
(int64)
Title:
Minimum Pay
Minimum pay in recruiting candidate work preferences. -
NatTravelFlag: boolean
Title:
Travel Domestically
Maximum Length:30
Domestic travel required indicator in the recruiting candidate work preferences. -
NatTravelFrequency: string
Title:
Domestic Travel Frequency
Maximum Length:30
National travel frequency in recruiting candidate work preferences. -
NatTravelRequiredFlag: boolean
Title:
Travel Required
Maximum Length:30
Domestic travel required indicator in recruiting candidate work preferences. -
PartAssignFlag: boolean
Title:
Consider Part Time Work
Maximum Length:30
Part assign indicator in the recruiting candidate work preferences. -
PayFrequency: string
Title:
Pay Frequency
Maximum Length:30
Pay frequency in recruiting candidate work preferences. -
PayRange: string
Title:
Pay Range
Maximum Length:30
Pay range in recruiting candidate work preferences. -
PreferredLocationFourId: integer
(int64)
Title:
Fourth Preferred Location
Preferred location four ID in recruiting candidate work preferences. -
PreferredLocationOneId: integer
(int64)
Title:
First Preferred Location
Preferred location one ID in recruiting candidate work preferences. -
PreferredLocationThreeId: integer
(int64)
Title:
Third Preferred Location
Preferred location three ID in recruiting candidate work preferences. -
PreferredLocationTwoId: integer
(int64)
Title:
Second Preferred Location
Preferred location two ID in recruiting candidate work preferences. -
RelocateDuration: integer
(int64)
Title:
Length of Willing to Relocate
Relocate duration in recruiting candidate work preferences. -
RelocateFlag: boolean
Title:
Willing to Relocate
Maximum Length:30
Relocate indicator in the recruiting candidate work preferences. -
RelocationReason: string
Title:
Relocation Reason
Maximum Length:240
Relocation reason in recruiting candidate work preferences. -
SectionId: integer
(int64)
Section ID in recruiting candidate work preferences.
-
TempAssignFlag: boolean
Title:
Consider Temporary Assignment
Maximum Length:30
Temp assign indicator in recruiting candidate work preferences. -
WorkDays: string
Title:
Workdays
Maximum Length:30
Workdays in recruiting candidate work preferences. -
WorkHours: string
Title:
Work Hours
Maximum Length:30
Work hours in recruiting candidate work preferences. -
WorkMonths: integer
(int64)
Title:
Work Duration Months
Work months in recruiting candidate work preferences. -
WorkPreferenceId: integer
(int64)
Work preference ID in recruiting candidate work preferences.
-
WorkYears: integer
(int64)
Title:
Work Duration Years
Work years in recruiting candidate work preferences.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to get all the work preferences of a candidate by submitting a collection GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -X GET http://host:port/hcmCoreApi/resources/11.13.18.05/recruitingCandidates/187477/child/workPreferences
Example of Response Header
The following is an example of the response header.
HTTP/1.1 200 OK Content-Type : application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "WorkPreferenceId": 300100176592750, "AllLocationsFlag": false, "ContentItemId": null, "CurrencyCode": "USD", "DateFrom": "2019-03-25", "DateTo": null, "FlexibleWorkFlag": true, "MinimumPay": 140000, "IntlTravelFlag": true, "NatTravelFrequency": "Weekly Once", "NatTravelFlag": false, "FullTimeEquivalent": null, "IntlTravelRequiredFlag": null, "IntlTravelFrequency": "Quarterly Once", "NatTravelRequiredFlag": null, "PartAssignFlag": true, "PayFrequency": "Y", "PayRange": null, "RelocateDuration": 3, "RelocateFlag": false, "RelocationReason": "As per the Customer locations", "SectionId": 1301, "TempAssignFlag": true, "WorkDays": null, "WorkHours": null, "WorkMonths": null, "WorkYears": null, "ExcludedLocationOneId": 555, "ExcludedLocationTwoId": 666, "ExcludedLocationThreeId": 777, "ExcludedLocationFourId": 888, "PreferredLocationOneId": 111, "PreferredLocationTwoId": 222, "PreferredLocationThreeId": 333, "PreferredLocationFourId": 444, "links": [ {...} ] }