Get the details of a candidate work preference
get
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences/{WorkPreferenceId}
Request
Path Parameters
-
WorkPreferenceId(required): integer(int64)
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : recruitingCECandidateWorkPreferences-item-response
Type:
Show Source
object
-
AllLocationsFlag: boolean
Title:
All Locations
Maximum Length:30
Indicates that the candidate has selected all locations. -
Comments: string
(byte)
Title:
Comments
Comments in the candidate work preferences. -
ContentItemId: integer
(int64)
ContentItemId in the candidate work preferences.
-
CurrencyCode: string
Title:
Currency Code
Maximum Length:30
Currency 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 Location
Excluded Location Id 1 in the candidate work preferences. -
ExcludedLocationId2: integer
(int64)
Title:
Second Excluded Location
Excluded Location Id 2 in the candidate work preferences. -
ExcludedLocationId3: integer
(int64)
Title:
Third Excluded Location
Excluded Location Id 3 in the candidate work preferences. -
ExcludedLocationId4: integer
(int64)
Title:
Fourth Excluded Location
Excluded Location Id 4 in the candidate work preferences. -
FlexibleWorkFlag: boolean
Title:
Work a Flexible Schedule
Maximum Length:30
Indicates that the candidate has opted for flexible work hours. -
FlowVersionId: integer
Flow version ID in the candidate work preferences.
-
FullTimeEquivalent: number
Title:
Full Time Equivalent
Full time equivalent in the candidate work preferences. -
IntlTravelFlag: boolean
Title:
Travel Internationally
Maximum Length:30
Indicates that the candidate has opted for international travel. -
IntlTravelFrequency: string
Title:
International Travel Frequency
Maximum Length:30
International Travel Frequency in candidate work preferences. -
IntlTravelRequiredFlag: boolean
Title:
International Travel Required
Maximum Length:30
Indicates that the candidate is ready for international travel. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MinimumPay: integer
(int64)
Title:
Minimum Pay
Minimum pay in candidate work preferences. -
NatTravelFlag: boolean
Title:
Travel Domestically
Maximum Length:30
Indicates that the candidate has opted for domestic travel. -
NatTravelFrequency: string
Title:
Domestic Travel Frequency
Maximum Length:30
National travel frequency in the candidate work preferences. -
NatTravelRequiredFlag: boolean
Title:
Travel Required
Maximum Length:30
Indicates that the candidate is ready for domestic travel. -
PartAssignFlag: boolean
Title:
Consider Part Time Work
Maximum Length:30
Indicates that the candidate has opted for part payment. -
PayFrequency: string
Title:
Pay Frequency
Maximum Length:30
Pay frequency in the candidate work preferences. -
PayRange: string
Title:
Pay Range
Maximum Length:30
Pay range in the candidate work preferences. -
PreferredLocationId1: integer
(int64)
Title:
First Preferred Location
Preferred location Id 1 in the candidate work preferences. -
PreferredLocationId2: integer
(int64)
Title:
Second Preferred Location
Preferred location Id 2 in the candidate work preferences. -
PreferredLocationId3: integer
(int64)
Title:
Third Preferred Location
Preferred location Id 3 in the candidate work preferences. -
PreferredLocationId4: integer
(int64)
Title:
Fourth Preferred Location
Preferred location Id 4 in the candidate work preferences. -
RelocateDuration: integer
(int64)
Title:
Length of Willing to Relocate
Duration required by the candidate to relocate. -
RelocateFlag: boolean
Title:
Willing to Relocate
Maximum Length:30
Indicates that the candidate is ready to relocate. -
RelocationReason: string
Title:
Relocation Reason
Maximum Length:240
Relocation 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 Assignment
Maximum Length:30
Indicates temporary assignment in the candidate work preferences. -
WorkDays: string
Title:
Workdays
Maximum Length:30
Workdays in the candidate work preferences. -
WorkHours: string
Title:
Work Hours
Maximum Length:30
Work hours in the candidate work preferences. -
WorkMonths: integer
(int64)
Title:
Work Duration Months
Work months in the candidate work preferences. -
WorkPreferenceId: integer
(int64)
Work preference ID in the candidate work preferences.
-
WorkYears: integer
(int64)
Title:
Work Duration Years
Work years in the 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.