Get all candidate work preferences
get
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{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; Work preference ID used to find the work preference of a candidate.
- 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 : recruitingJobSiteCandidates-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 : recruitingJobSiteCandidates-workPreferences-item-response
Type:
Show Source
object
-
AllLocationsFlag: boolean
Title:
All Locations
Maximum Length:30
Indicates whether all locations are included in the candidate work preferences. -
Comments: string
(byte)
Title:
Comments
Comments of the candidate work preferences. -
ContentItemId: integer
(int64)
Content item identifier of the candidate work preferences.
-
CurrencyCode: string
Title:
Currency Code
Maximum Length:30
Currency code of the candidate work preferences. -
DateFrom: string
(date)
Date from of the candidate work preferences.
-
DateTo: string
(date)
Date to of the candidate work preferences.
-
ExcludedLocationFourId: integer
(int64)
Title:
Fourth Excluded Location
Excluded location four identifier of the candidate work preferences. -
ExcludedLocationOneId: integer
(int64)
Title:
First Excluded Location
Excluded location one identifier of the candidate work preferences. -
ExcludedLocationThreeId: integer
(int64)
Title:
Third Excluded Location
Excluded location three identifier of the candidate work preferences. -
ExcludedLocationTwoId: integer
(int64)
Title:
Second Excluded Location
Excluded location two identifier of the candidate work preferences. -
FlexibleWorkFlag: boolean
Title:
Work a Flexible Schedule
Maximum Length:30
Indicates whether flexible work is required in the candidate work preferences. -
FullTimeEquivalent: number
Title:
Full Time Equivalent
Full time equivalent of the candidate work preferences. -
IntlTravelFlag: boolean
Title:
Travel Internationally
Maximum Length:30
Indicates whether international travel is in the candidate work preferences. -
IntlTravelFrequency: string
Title:
International Travel Frequency
Maximum Length:30
International travel frequency of the candidate work preferences. -
IntlTravelRequiredFlag: boolean
Title:
International Travel Required
Maximum Length:30
Indicates whether international travel is required in the candidate work preferences. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MinimumPay: integer
(int64)
Title:
Minimum Pay
Minimum pay of the candidate work preferences. -
NatTravelFlag: boolean
Title:
Travel Domestically
Maximum Length:30
Indicates whether domestic travel is in the candidate work preferences. -
NatTravelFrequency: string
Title:
Domestic Travel Frequency
Maximum Length:30
National travel frequency of the candidate work preferences. -
NatTravelRequiredFlag: boolean
Title:
Travel Required
Maximum Length:30
Indicates whether domestic travel is required in the candidate work preferences. -
PartAssignFlag: boolean
Title:
Consider Part Time Work
Maximum Length:30
Part assign indicator of the candidate work preferences. -
PayFrequency: string
Title:
Pay Frequency
Maximum Length:30
Pay frequency of the candidate work preferences. -
PayRange: string
Title:
Pay Range
Maximum Length:30
Pay range of the candidate work preferences. -
PreferredLocationFourId: integer
(int64)
Title:
Fourth Preferred Location
Preferred location four identifier of the candidate work preferences. -
PreferredLocationOneId: integer
(int64)
Title:
First Preferred Location
Preferred location one identifier of the candidate work preferences. -
PreferredLocationThreeId: integer
(int64)
Title:
Third Preferred Location
Preferred location three identifier of the candidate work preferences. -
PreferredLocationTwoId: integer
(int64)
Title:
Second Preferred Location
Preferred location two identifier of the candidate work preferences. -
RelocateDuration: integer
(int64)
Title:
Length of Willing to Relocate
Relocate duration of the candidate work preferences. -
RelocateFlag: boolean
Title:
Willing to Relocate
Maximum Length:30
Indicates whether relocation is possible in the candidate work preferences. -
RelocationReason: string
Title:
Relocation Reason
Maximum Length:240
Relocation reason of the candidate work preferences. -
SectionId: integer
(int64)
Section identifier of the candidate work preferences.
-
TempAssignFlag: boolean
Title:
Consider Temporary Assignment
Maximum Length:30
Indicates whether temporary assignment is in the candidate work preferences. -
WorkDays: string
Title:
Workdays
Maximum Length:30
Workdays of the candidate work preferences. -
WorkHours: string
Title:
Work Hours
Maximum Length:30
Work hours of the candidate work preferences. -
WorkMonths: integer
(int64)
Title:
Work Duration Months
Work months of the candidate work preferences. -
WorkPreferenceId: integer
(int64)
Work preference identifier of the candidate work preferences.
-
WorkYears: integer
(int64)
Title:
Work Duration Years
Work years of 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.