Create a candidate work preference
post
/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=
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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. -
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.
Response
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-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 create work preference for the candidate by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -X POST -d <payload> http://host:port/hcmCoreApi/resources/11.13.18.05/recruitingCandidates/187477/child/workPreferences
Example of Payload
The following is an example of the payload.
{ "SectionId":1301, "NatTravelFlag":false, "NatTravelFrequency":"Weekly Once", "IntlTravelFlag":true, "IntlTravelFrequency":"Quarterly Once", "RelocateFlag":false, "AllLocationsFlag":false, "PreferredLocationOneId":111, "PreferredLocationTwoId":222, "PreferredLocationThreeId":333, "PreferredLocationFourId":444, "ExcludedLocationOneId":555, "ExcludedLocationTwoId":666, "ExcludedLocationThreeId":777, "ExcludedLocationFourId":888, "RelocateDuration":3, "RelocationReason":"As per the Customer locations" , "Comments":null, "TempAssignFlag":true, "PartAssignFlag":true, "FlexibleWorkFlag":true, "MinimumPay":"140000", "CurrencyCode":"USD", "PayFrequency":"Y" }
Example of Response Header
The following is an example of the response header.
HTTP/1.1 200 OK Content-Type : application/octet-stream
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": [ {...} ] }