Get a recruiting partner candidate details

get

/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}

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=
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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.

There's no request body for this operation.

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 : recruitingPartnerCandidateDetails-item-response
Type: object
Show Source
Nested Schema : Address Details in the Recruiting Assessment Partner Candidate Details
Type: array
Title: Address Details in the Recruiting Assessment Partner Candidate Details
The addressDetails resource is the child of the recruitingPartnerCandidateDetails resource and provides the individual address fields used for the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Address Format in the Recruiting Assessment Partner Candidate Details
Type: array
Title: Address Format in the Recruiting Assessment Partner Candidate Details
The addressFormat resource is the child of the recruitingPartnerCandidateDetails resource and provides the address format used for the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Certification Related Information in the Recruiting Partner Candidate Details
Type: array
Title: Certification Related Information in the Recruiting Partner Candidate Details
The certifications resource is the child of the recruitingPartnerCandidateDetails resource and provides the certifications of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Educational Qualifications Mentioned in the Recruiting Partner Candidate Details
Type: array
Title: Educational Qualifications Mentioned in the Recruiting Partner Candidate Details
The educations resource is the child of the recruitingPartnerCandidateDetails resource and provides details about the education of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : National Identifiers of the Candidate in the Recruiting Partner Candidate Details
Type: array
Title: National Identifiers of the Candidate in the Recruiting Partner Candidate Details
The NationalIdentifiers resource is a child of the recruitingPartnerCandidateDetails resource and provides the national identifiers of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Previous Employments Recorded in the Recruiting Partner Candidate Details
Type: array
Title: Previous Employments Recorded in the Recruiting Partner Candidate Details
The previousEmployments resource is the child of the recruitingPartnerCandidateDetails resource and provides the previous employment details of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Requisition Additional Attributes Recorded in the Recruiting Partner Candidate Details
Type: array
Title: Requisition Additional Attributes Recorded in the Recruiting Partner Candidate Details
The requisitionAdditionalAttributes resource is the child of the recruitingPartnerCandidateDetails resource and provides the previous employment details of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : recruitingPartnerCandidateDetails-addressDetails-item-response
Type: object
Show Source
  • Read Only: true
    Additional address attribute 1 in the address in the recruiting partner candidate details.
  • Read Only: true
    Additional address attribute 2 in the address in the recruiting partner candidate details.
  • Read Only: true
    Additional address attribute 3 in the address in the recruiting partner candidate details.
  • Read Only: true
    Additional address attribute 4 in the address in the recruiting partner candidate details.
  • Read Only: true
    Additional address attribute 5 in the address in the recruiting partner candidate details.
  • Read Only: true
    Maximum Length: 255
    Address line 1 in the address in the recruiting partner candidate details.
  • Read Only: true
    Address line 2 in the address in the recruiting partner candidate details.
  • Read Only: true
    Address line 3 in the address in the recruiting partner candidate details.
  • Read Only: true
    Maximum Length: 255
    Address line 4 in the address in the recruiting partner candidate details.
  • Read Only: true
    Building in the address in the recruiting partner candidate details.
  • Read Only: true
    City in the address in the recruiting partner candidate details.
  • Read Only: true
    Country in the address in the recruiting partner candidate details.
  • Read Only: true
    Floor number in the address in the recruiting partner candidate details.
  • Links
  • Read Only: true
    Long postal code in the address in the recruiting partner candidate details.
  • Read Only: true
    Postal code in the address in the recruiting partner candidate details.
  • Read Only: true
    Region 1 in the address in the recruiting partner candidate details.
  • Read Only: true
    Region 2 in the address in the recruiting partner candidate details.
  • Read Only: true
    Region 3 in the address in the recruiting partner candidate address details.
Nested Schema : recruitingPartnerCandidateDetails-addressFormat-item-response
Type: object
Show Source
  • Read Only: true
    Address format attribute in the address in the recruiting partner candidate details.
  • Read Only: true
    Address format label in the address in the recruiting partner candidate details.
  • Links
  • Read Only: true
    Sequence in the address in the recruiting partner candidate details.
Nested Schema : recruitingPartnerCandidateDetails-certifications-item-response
Type: object
Show Source
Nested Schema : recruitingPartnerCandidateDetails-educations-item-response
Type: object
Show Source
Nested Schema : recruitingPartnerCandidateDetails-nationalIdentifiers-item-response
Type: object
Show Source
Nested Schema : recruitingPartnerCandidateDetails-previousEmployments-item-response
Type: object
Show Source
Nested Schema : recruitingPartnerCandidateDetails-requisitionAdditionalAttributes-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 255
    Name of the attribute in the requisition additional attributes of recruiting partner candidate.
  • Read Only: true
    Maximum Length: 255
    Type of the attribute in the requisition additional attributes of recruiting partner candidate.
  • Read Only: true
    Maximum Length: 255
    Attribute FlexContextCode in the requisitionAdditional additional attributes of recruiting partner candidate.
  • Links
  • Read Only: true
    Maximum Length: 255
    Attribute list of value in the requisition additional attributes of the recruiting partner candidate.
  • Read Only: true
    Maximum Length: 255
    Attribute Type in the requisition additional attributes of recruiting partner candidate.
  • Read Only: true
    Maximum Length: 255
    Attribute Value in the requisition additional attributes of recruiting partner candidate.
Back to Top