Get a candidate site preference
get
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}
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 -
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 : recruitingCECandidateSitePreferences-item-response
Type:
Show Source
object
-
Action: string
Action in candidate site preferences.
-
CampaignCode: string
Campaign code in the candidate site preferences.
-
CandidateCountry: string
Country of the candidate in the candidate site preferences.
-
CandidateNumber: string
Maximum Length:
255
Candidate number in candidate site preferences. -
Context: string
Context in the candidate site preferences.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OptInMarketingEmailFlag: boolean
Maximum Length:
30
Indicates whether a candidate opted to receive recruitment marketing emails. The default value is 0. -
SiteNumber: string
Site number in the candidate site preferences.
-
siteTCPreferences: array
Preferred Site TC in the Site Preferences of the Recruiting Candidate
Title:
Preferred Site TC in the Site Preferences of the Recruiting Candidate
The siteTCPreferences resource is a child of recruitingCECandidateSitePreferences. It includes the details of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Preferred Site TC in the Site Preferences of the Recruiting Candidate
Type:
array
Title:
Preferred Site TC in the Site Preferences of the Recruiting Candidate
The siteTCPreferences resource is a child of recruitingCECandidateSitePreferences. It includes the details of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
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.
Nested Schema : recruitingCECandidateSitePreferences-siteTCPreferences-item-response
Type:
Show Source
object
-
FlowVersionId: integer
Flow version ID in candidate site TCP preferences.
-
LegalDescriptionVersionId: integer
Legal description Version Id in candidate site TCP preferences.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OptInJobAlertFlag: boolean
Opt in job alert indicator in candidate site TC preferences.
-
preferredJobFamilies: array
Preferred Job Families
Title:
Preferred Job Families
The preferredJobFamilies resource is a child of siteTCPreferences. It includes the details of preferred job families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use. -
preferredJobFunctions: array
Preferred Job Functions
Title:
Preferred Job Functions
The preferredJobFunctions resource is the child of the siteTCPreferences resource. It provides the details of preferred job functions of a candidate from the Talent Community Pool preferences. Note that the service endpoints in this resource category are only for Oracle internal use. -
preferredLocations: array
Preferred Locations
Title:
Preferred Locations
The preferredLocations resource is a child of preferredjobFamilies. It includes the details of preferred locations families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use. -
SiteNumber: string
Maximum Length:
255
Site number in candidate site TCP preferences.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Preferred Job Families
Type:
array
Title:
Preferred Job Families
The preferredJobFamilies resource is a child of siteTCPreferences. It includes the details of preferred job families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Preferred Job Functions
Type:
array
Title:
Preferred Job Functions
The preferredJobFunctions resource is the child of the siteTCPreferences resource. It provides the details of preferred job functions of a candidate from the Talent Community Pool preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Preferred Locations
Type:
array
Title:
Preferred Locations
The preferredLocations resource is a child of preferredjobFamilies. It includes the details of preferred locations families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingCECandidateSitePreferences-siteTCPreferences-preferredJobFamilies-item-response
Type:
Show Source
object
-
JobFamilyId: integer
Job family ID in preferred job families in candidate site TCP preferences.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidateSitePreferences-siteTCPreferences-preferredJobFunctions-item-response
Type:
Show Source
object
-
JobFunctionCode: string
Job function ID of a preferred job function of a candidate from the Talent Community Pool preferences.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCECandidateSitePreferences-siteTCPreferences-preferredLocations-item-response
Type:
Show Source
object
-
GeographyId: integer
Geography ID in preferred locations in candidate site TCP preferences.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- siteTCPreferences
-
Parameters:
- CandidateNumber:
$request.path.CandidateNumber
The siteTCPreferences resource is a child of recruitingCECandidateSitePreferences. It includes the details of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use. - CandidateNumber: