Get the details of all the candidate work preferences
get
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences
Request
Query Parameters
-
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 the candidate work preferences by a unique ID
Finder Variables- WorkPreferenceId; integer; Finds the candidate work preferences by a unique ID and the WorkPreferenceId; integer; variable
- findBySectionId Finds the candidate work preferences by the findBySectionId variable
Finder Variables- FlowVersionId; integer; Finds the candidate work preferences by the findBySectionId and FlowVersionId; integer; variables
- SectionId; integer; Finds the candidate work preferences by the findBySectionId and SectionId; integer; variables
- PrimaryKey Finds the candidate work preferences by 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
You can use these queryable attributes to filter this collection resource using the q query parameter:- AllLocationsFlag; boolean; Indicates that the candidate has selected all locations.
- ContentItemId; integer; ContentItemId in the candidate work preferences.
- CurrencyCode; string; Currency code in the candidate work preferences.
- DateFrom; string; Date from in the candidate work preferences.
- DateTo; string; Date to in the candidate work preferences.
- ExcludedLocationId1; integer; Excluded Location Id 1 in the candidate work preferences.
- ExcludedLocationId2; integer; Excluded Location Id 2 in the candidate work preferences.
- ExcludedLocationId3; integer; Excluded Location Id 3 in the candidate work preferences.
- ExcludedLocationId4; integer; Excluded Location Id 4 in the candidate work preferences.
- FlexibleWorkFlag; boolean; Indicates that the candidate has opted for flexible work hours.
- FlowVersionId; integer; Flow version ID in the candidate work preferences.
- FullTimeEquivalent; number; Full time equivalent in the candidate work preferences.
- IntlTravelFlag; boolean; Indicates that the candidate has opted for international travel.
- IntlTravelFrequency; string; International Travel Frequency in candidate work preferences.
- IntlTravelRequiredFlag; boolean; Indicates that the candidate is ready for international travel.
- MinimumPay; integer; Minimum pay in candidate work preferences.
- NatTravelFlag; boolean; Indicates that the candidate has opted for domestic travel.
- NatTravelFrequency; string; National travel frequency in the candidate work preferences.
- NatTravelRequiredFlag; boolean; Indicates that the candidate is ready for domestic travel.
- PartAssignFlag; boolean; Indicates that the candidate has opted for part payment.
- PayFrequency; string; Pay frequency in the candidate work preferences.
- PayRange; string; Pay range in the candidate work preferences.
- PreferredLocationId1; integer; Preferred location Id 1 in the candidate work preferences.
- PreferredLocationId2; integer; Preferred location Id 2 in the candidate work preferences.
- PreferredLocationId3; integer; Preferred location Id 3 in the candidate work preferences.
- PreferredLocationId4; integer; Preferred location Id 4 in the candidate work preferences.
- RelocateDuration; integer; Duration required by the candidate to relocate.
- RelocateFlag; boolean; Indicates that the candidate is ready to relocate.
- RelocationReason; string; Relocation reason in the candidate work preferences.
- SectionId; integer; Section ID in the candidate work preferences.
- SubmissionId; string; Submission ID in the candidate work preferences.
- TempAssignFlag; boolean; Indicates temporary assignment in the candidate work preferences.
- WorkDays; string; Workdays in the candidate work preferences.
- WorkHours; string; Work hours in the candidate work preferences.
- WorkMonths; integer; Work months in the candidate work preferences.
- WorkPreferenceId; integer; Work preference ID in the candidate work preferences.
- WorkYears; integer; Work years in the candidate work preferences.
-
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: string
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: string
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 : recruitingCECandidateWorkPreferences
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:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidateWorkPreferences-item-response
Type:
Show Source
object-
AllLocationsFlag: boolean
Title:
All LocationsMaximum Length:30Indicates that the candidate has selected all locations. -
Comments: string
(byte)
Title:
CommentsComments in the candidate work preferences. -
ContentItemId: integer
(int64)
ContentItemId in the candidate work preferences.
-
CurrencyCode: string
Title:
Currency CodeMaximum Length:30Currency code in the candidate work preferences. -
DateFrom: string
(date)
Date from in the candidate work preferences.
-
DateTo: string
(date)
Date to in the candidate work preferences.
-
ExcludedLocationId1: integer
(int64)
Title:
First Excluded LocationExcluded Location Id 1 in the candidate work preferences. -
ExcludedLocationId2: integer
(int64)
Title:
Second Excluded LocationExcluded Location Id 2 in the candidate work preferences. -
ExcludedLocationId3: integer
(int64)
Title:
Third Excluded LocationExcluded Location Id 3 in the candidate work preferences. -
ExcludedLocationId4: integer
(int64)
Title:
Fourth Excluded LocationExcluded Location Id 4 in the candidate work preferences. -
FlexibleWorkFlag: boolean
Title:
Work a Flexible ScheduleMaximum Length:30Indicates that the candidate has opted for flexible work hours. -
FlowVersionId: integer
Flow version ID in the candidate work preferences.
-
FullTimeEquivalent: number
Title:
Full Time EquivalentFull time equivalent in the candidate work preferences. -
IntlTravelFlag: boolean
Title:
Travel InternationallyMaximum Length:30Indicates that the candidate has opted for international travel. -
IntlTravelFrequency: string
Title:
International Travel FrequencyMaximum Length:30International Travel Frequency in candidate work preferences. -
IntlTravelRequiredFlag: boolean
Title:
International Travel RequiredMaximum Length:30Indicates that the candidate is ready for international travel. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MinimumPay: integer
(int64)
Title:
Minimum PayMinimum pay in candidate work preferences. -
NatTravelFlag: boolean
Title:
Travel DomesticallyMaximum Length:30Indicates that the candidate has opted for domestic travel. -
NatTravelFrequency: string
Title:
Domestic Travel FrequencyMaximum Length:30National travel frequency in the candidate work preferences. -
NatTravelRequiredFlag: boolean
Title:
Travel RequiredMaximum Length:30Indicates that the candidate is ready for domestic travel. -
PartAssignFlag: boolean
Title:
Consider Part Time WorkMaximum Length:30Indicates that the candidate has opted for part payment. -
PayFrequency: string
Title:
Pay FrequencyMaximum Length:30Pay frequency in the candidate work preferences. -
PayRange: string
Title:
Pay RangeMaximum Length:30Pay range in the candidate work preferences. -
PreferredLocationId1: integer
(int64)
Title:
First Preferred LocationPreferred location Id 1 in the candidate work preferences. -
PreferredLocationId2: integer
(int64)
Title:
Second Preferred LocationPreferred location Id 2 in the candidate work preferences. -
PreferredLocationId3: integer
(int64)
Title:
Third Preferred LocationPreferred location Id 3 in the candidate work preferences. -
PreferredLocationId4: integer
(int64)
Title:
Fourth Preferred LocationPreferred location Id 4 in the candidate work preferences. -
RelocateDuration: integer
(int64)
Title:
Length of Willing to RelocateDuration required by the candidate to relocate. -
RelocateFlag: boolean
Title:
Willing to RelocateMaximum Length:30Indicates that the candidate is ready to relocate. -
RelocationReason: string
Title:
Relocation ReasonMaximum Length:240Relocation reason in the candidate work preferences. -
SectionId: integer
(int64)
Section ID in the candidate work preferences.
-
SubmissionId: string
Submission ID in the candidate work preferences.
-
TempAssignFlag: boolean
Title:
Consider Temporary AssignmentMaximum Length:30Indicates temporary assignment in the candidate work preferences. -
WorkDays: string
Title:
WorkdaysMaximum Length:30Workdays in the candidate work preferences. -
WorkHours: string
Title:
Work HoursMaximum Length:30Work hours in the candidate work preferences. -
WorkMonths: integer
(int64)
Title:
Work Duration MonthsWork months in the candidate work preferences. -
WorkPreferenceId: integer
(int64)
Work preference ID in the candidate work preferences.
-
WorkYears: integer
(int64)
Title:
Work Duration YearsWork years in the candidate work preferences.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.