Get details for a job application
get
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}
Request
Path Parameters
-
recruitingTaxCreditsCandidateDetailsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- RequisitionNumber and CandidateNumber ---for the Recruiting Tax Credits Candidate Details resource and used to uniquely identify an instance of Recruiting Tax Credits Candidate Details. The client should not generate the hash key value. Instead, the client should query on the Recruiting Tax Credits Candidate Details collection resource with a filter on the primary key values in order to navigate to a specific instance of Recruiting Tax Credits Candidate Details.
For example: recruitingTaxCreditsCandidateDetails?q=RequisitionNumber=<value1>;CandidateNumber=<value2>
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 : recruitingTaxCreditsCandidateDetails-item-response
Type:
Show Source
object
-
AcceptedDate: string
Read Only:
true
Job offer accepted date. -
Address: string
Read Only:
true
Candidate's address. -
addressDetails: array
Recruiting Tax Credits Address Details
Title:
Recruiting Tax Credits Address Details
The addressDetails resource is a child of the recruitingTaxCreditsCandidateDetails and provides the individual address fields of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
addressFormat: array
Recruiting Tax Credits Address Format
Title:
Recruiting Tax Credits Address Format
The addressFormat resource is a child of the recruitingTaxCreditsCandidateDetails and provides the address format used in the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
CandidateEmail: string
Read Only:
true
Candidate's email address. -
CandidateNumber: string
Candidate's candidate number.
-
CandidatePIIInformationIncludedFlag: boolean
Read Only:
true
Indicates if personally identifiable information data from candidate is included in payload. -
CandidatePreferredLocations: array
Recruiting Tax Credits Other Work Locations
Title:
Recruiting Tax Credits Other Work Locations
The OtherWorkLocations resource is the child of the recruitingTaxCreditsCandidateDetails resource and it provides additional work locations of the job requisition. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
CandidateToken: string
Read Only:
true
Candidate token in the recruiting tax credits candidate details. -
ConfirmedSubmissionFlag: boolean
Read Only:
true
Indicates whether the candidate has been confirmed. -
DateOfBirth: string
Read Only:
true
Candidate's date of birth. -
ExtendedDate: string
Read Only:
true
Job offer extended date. -
FirstName: string
Read Only:
true
Candidate's first name. -
JobApplicationDate: string
Read Only:
true
Job application date. -
Language: string
Read Only:
true
Job application language. -
LastName: string
Read Only:
true
Candidate's last name. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleNames: string
Read Only:
true
Candidate's middle name. -
NamePrefix: string
Read Only:
true
Candidate's name prefix. -
NameSuffix: string
Read Only:
true
Candidate's name suffix. -
NationalIdentifiers: array
Recruiting Tax Credits Candidate National Identifiers
Title:
Recruiting Tax Credits Candidate National Identifiers
The NationalIdentifiers resource is the child of the recruitingTaxCreditsCandidateDetails 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. -
OfferWorkLocation: string
Read Only:
true
Work location specified in the candidate job offer. -
OfferWorkLocationCode: string
Read Only:
true
Work location code in the candidate job offer. -
OtherRequisitionLocations: array
Recruiting Tax Credits Other Work Locations
Title:
Recruiting Tax Credits Other Work Locations
The OtherWorkLocations resource is the child of the recruitingTaxCreditsCandidateDetails resource and it provides additional work locations of the job requisition. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
OtherWorkLocations: array
Recruiting Tax Credits Other Work Locations
Title:
Recruiting Tax Credits Other Work Locations
The OtherWorkLocations resource is the child of the recruitingTaxCreditsCandidateDetails resource and it provides additional work locations of the job requisition. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
PayBasis: string
Read Only:
true
Salary pay basis. -
PhoneAreaCode: string
Read Only:
true
Candidate's phone area code in the recruiting tax credits. -
PhoneCountryCode: string
Read Only:
true
Candidate's phone country code in the recruiting tax credits. -
PhoneNumber: string
Read Only:
true
Candidate's phone number in the recruiting tax credits. -
PipelineRequisitionNumber: string
Read Only:
true
Number assigned to each pipeline job requisition. -
PlannedStartDate: string
Read Only:
true
Candidate's planned start date. -
requisitionAdditionalAttributes: array
Recruiting Tax Credits Requisition Additional Attributes
Title:
Recruiting Tax Credits Requisition Additional Attributes
The requisitionAdditionalAttributes resource is the child of the recruitingTaxCreditsCandidateDetails resource and provides the additional requisition attributes. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
RequisitionLocation: string
Read Only:
true
Job requisition primary location. -
RequisitionNumber: string
Job requisition's requisition number.
-
RequisitionOrganization: string
Read Only:
true
Organization name for the job requisition. -
RequisitionTitle: string
Read Only:
true
Title for the job requisition. -
Salary: number
Read Only:
true
Candidate's salary. -
SalaryCurrency: string
Read Only:
true
Currency for the salary. -
WorkLocation: string
Read Only:
true
Job requisition primary work location. -
WorkLocationCode: string
Read Only:
true
Work location code in the job requisition.
Nested Schema : Recruiting Tax Credits Address Details
Type:
array
Title:
Recruiting Tax Credits Address Details
The addressDetails resource is a child of the recruitingTaxCreditsCandidateDetails and provides the individual address fields 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 : Recruiting Tax Credits Address Format
Type:
array
Title:
Recruiting Tax Credits Address Format
The addressFormat resource is a child of the recruitingTaxCreditsCandidateDetails and provides the address format used in 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 : Recruiting Tax Credits Other Work Locations
Type:
array
Title:
Recruiting Tax Credits Other Work Locations
The OtherWorkLocations resource is the child of the recruitingTaxCreditsCandidateDetails resource and it provides additional work locations of the job requisition. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Recruiting Tax Credits Candidate National Identifiers
Type:
array
Title:
Recruiting Tax Credits Candidate National Identifiers
The NationalIdentifiers resource is the child of the recruitingTaxCreditsCandidateDetails 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 : Recruiting Tax Credits Other Work Locations
Type:
array
Title:
Recruiting Tax Credits Other Work Locations
The OtherWorkLocations resource is the child of the recruitingTaxCreditsCandidateDetails resource and it provides additional work locations of the job requisition. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Recruiting Tax Credits Other Work Locations
Type:
array
Title:
Recruiting Tax Credits Other Work Locations
The OtherWorkLocations resource is the child of the recruitingTaxCreditsCandidateDetails resource and it provides additional work locations of the job requisition. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Recruiting Tax Credits Requisition Additional Attributes
Type:
array
Title:
Recruiting Tax Credits Requisition Additional Attributes
The requisitionAdditionalAttributes resource is the child of the recruitingTaxCreditsCandidateDetails resource and provides the additional requisition attributes. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : recruitingTaxCreditsCandidateDetails-addressDetails-item-response
Type:
Show Source
object
-
AddlAddressAttribute1: string
Additional address attribute 1 in the recruiting tax credits candidate details.
-
AddlAddressAttribute2: string
Additional address attribute 2 in the recruiting tax credits candidate details.
-
AddlAddressAttribute3: string
Additional address attribute 3 in the recruiting tax credits candidate details.
-
AddlAddressAttribute4: string
Additional address attribute 4 in the recruiting tax credits candidate details.
-
AddlAddressAttribute5: string
Additional address attribute 5 in the recruiting tax credits candidate details.
-
AddressLine1: string
Maximum Length:
255
Address line 1 in the recruiting tax credits candidate details. -
AddressLine2: string
Address line 2 in the recruiting tax credits candidate details.
-
AddressLine3: string
Address line 3 in the recruiting tax credits candidate details.
-
AddressLine4: string
Read Only:
true
Maximum Length:255
Address line 4 in the recruiting tax credits candidate details. -
Building: string
Building in the recruiting tax credits candidate details.
-
City: string
City in the recruiting tax credits candidate details.
-
Country: string
Country in the recruiting tax credits candidate details.
-
FloorNumber: string
Floor number in the recruiting tax credits candidate details.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LongPostalCode: string
Long postal code in the recruiting tax credits candidate details.
-
PostalCode: string
Postal code in the recruiting tax credits candidate details.
-
Region1: string
Region 1 in the recruiting tax credits candidate details.
-
Region2: string
Region 2 in the recruiting tax credits candidate details.
-
Region3: string
Region 3 in the address in the recruiting tax credits candidate details.
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.
Nested Schema : recruitingTaxCreditsCandidateDetails-addressFormat-item-response
Type:
Show Source
object
-
Attribute: string
Read Only:
true
Address format attribute in the recruiting tax credits candidate details. -
Label: string
Read Only:
true
Address format label in the recruiting tax credits candidate details. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Sequence: number
Read Only:
true
Sequence in the recruiting tax credits candidate details.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingTaxCreditsCandidateDetails-CandidatePreferredLocations-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Read Only:
true
Maximum Length:255
Location name for job requisition work locations. -
LocationCode: string
Read Only:
true
Location code of candidate preferred location.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingTaxCreditsCandidateDetails-NationalIdentifiers-item-response
Type:
Show Source
object
-
ExpirationDate: string
(date)
Read Only:
true
Expiration date of national identifiers of candidate. -
IssueDate: string
(date)
Read Only:
true
Issue date of national identifiers of candidate. -
LegislationCode: string
Read Only:
true
Legislation code of national identifiers of candidate. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NationalIdentifierNumber: string
Read Only:
true
Maximum Length:255
National identifier number of national identifiers of candidate. -
NationalIdentifierType: string
Read Only:
true
National identifier type of national identifiers of candidate. -
PlaceOfIssue: string
Read Only:
true
Place of issue of national identifiers of candidate.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingTaxCreditsCandidateDetails-OtherRequisitionLocations-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Read Only:
true
Maximum Length:255
Location name for job requisition work locations. -
LocationCode: string
Read Only:
true
Location code of candidate preferred location.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingTaxCreditsCandidateDetails-OtherWorkLocations-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Read Only:
true
Maximum Length:255
Location name for job requisition work locations. -
LocationCode: string
Read Only:
true
Location code of candidate preferred location.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingTaxCreditsCandidateDetails-requisitionAdditionalAttributes-item-response
Type:
Show Source
object
-
AttributeName: string
Read Only:
true
Name of the attribute in the requisition additional attributes of recruiting tax credits candidate details. -
AttributeType: string
Read Only:
true
Maximum Length:255
Type of the attribute in the requisition additional attributes of recruiting tax credits candidate details. -
FlexContextCode: string
Read Only:
true
Maximum Length:255
Attribute ContextCode in the requisitionAdditional additional attributes of recruiting tax credits candidate details. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LOVFlag: boolean
Read Only:
true
Maximum Length:255
Attribute list of value in the requisition additional attributes of the recruiting tax credits candidate details. -
Type: string
Read Only:
true
Maximum Length:255
Attribute Type in the requisition additional attributes of recruiting tax credits candidate details. -
Value: string
Read Only:
true
Maximum Length:255
Attribute Value in the requisition additional attributes of recruiting tax credits candidate details.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- CandidatePreferredLocations
-
Parameters:
- recruitingTaxCreditsCandidateDetailsUniqID:
$request.path.recruitingTaxCreditsCandidateDetailsUniqID
The OtherWorkLocations resource is the child of the recruitingTaxCreditsCandidateDetails resource and it provides additional work locations of the job requisition. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - recruitingTaxCreditsCandidateDetailsUniqID:
- NationalIdentifiers
-
Parameters:
- recruitingTaxCreditsCandidateDetailsUniqID:
$request.path.recruitingTaxCreditsCandidateDetailsUniqID
The NationalIdentifiers resource is the child of the recruitingTaxCreditsCandidateDetails 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. - recruitingTaxCreditsCandidateDetailsUniqID:
- OtherRequisitionLocations
-
Parameters:
- recruitingTaxCreditsCandidateDetailsUniqID:
$request.path.recruitingTaxCreditsCandidateDetailsUniqID
The OtherWorkLocations resource is the child of the recruitingTaxCreditsCandidateDetails resource and it provides additional work locations of the job requisition. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - recruitingTaxCreditsCandidateDetailsUniqID:
- OtherWorkLocations
-
Parameters:
- recruitingTaxCreditsCandidateDetailsUniqID:
$request.path.recruitingTaxCreditsCandidateDetailsUniqID
The OtherWorkLocations resource is the child of the recruitingTaxCreditsCandidateDetails resource and it provides additional work locations of the job requisition. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - recruitingTaxCreditsCandidateDetailsUniqID:
- addressDetails
-
Parameters:
- recruitingTaxCreditsCandidateDetailsUniqID:
$request.path.recruitingTaxCreditsCandidateDetailsUniqID
The addressDetails resource is a child of the recruitingTaxCreditsCandidateDetails and provides the individual address fields of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - recruitingTaxCreditsCandidateDetailsUniqID:
- addressFormat
-
Parameters:
- recruitingTaxCreditsCandidateDetailsUniqID:
$request.path.recruitingTaxCreditsCandidateDetailsUniqID
The addressFormat resource is a child of the recruitingTaxCreditsCandidateDetails and provides the address format used in the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - recruitingTaxCreditsCandidateDetailsUniqID:
- requisitionAdditionalAttributes
-
Parameters:
- recruitingTaxCreditsCandidateDetailsUniqID:
$request.path.recruitingTaxCreditsCandidateDetailsUniqID
The requisitionAdditionalAttributes resource is the child of the recruitingTaxCreditsCandidateDetails resource and provides the additional requisition attributes. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - recruitingTaxCreditsCandidateDetailsUniqID: