1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Recruiting Candidates
  4. Work Preferences of the Recruiting Candidates

Update a candidate work preference

patch

/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}

Request

Path Parameters
  • 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=
  • 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
  • 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".
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : recruitingCandidates-workPreferences-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to update the work preference of a candidate by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -X PATCH -d payload http://host:port/hcmRestApi/resources/11.13.18.05/recruitingCandidates/187477/child/workPreferences/300100176592750

Example of Payload

The following is an example of the payload.

{
	"SectionId":2301,
	"NatTravelFlag":true
}

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": true,
    "FullTimeEquivalent": null,
    "IntlTravelRequiredFlag": true,
    "IntlTravelFrequency": "Quarterly Once",
    "NatTravelRequiredFlag": false,
    "PartAssignFlag": true,
    "PayFrequency": "Y",
    "PayRange": null,
    "RelocateDuration": 3,
    "RelocateFlag": false,
    "RelocationReason": "As per the Customer locations",
    "SectionId": 2301,
    "TempAssignFlag": true,
    "WorkDays": null,
    "WorkHours": null,
    "WorkMonths": 111,
    "WorkYears": 222,
    "ExcludedLocationOneId": 555,
    "ExcludedLocationTwoId": 666,
    "ExcludedLocationThreeId": 777,
    "ExcludedLocationFourId": 888,
    "PreferredLocationOneId": 111,
    "PreferredLocationTwoId": 222,
    "PreferredLocationThreeId": 333,
    "PreferredLocationFourId": 444,
    "links": [
        {...}
    ]
}
Back to Top