Submit all candidate results
post
/hcmRestApi/resources/11.13.18.05/bcCandidateResults
Request
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CandidateNumber: string
Candidate number in the candidate results.
-
Comments: string
Comments in candidate results.
-
ErrorDetail: string
Error detail in candidate results.
-
PartnerId: string
Maximum Length:
255
Partner ID in candidate results. -
PartnerUsername: string
Partner user name in candidate results.
-
RequisitionNumber: string
Requisition number in the candidate results.
-
services: array
Services About the Candidate Results
Title:
Services About the Candidate Results
The services resource is a child of the bcCandidateResults resource. It includes the services of the candidate results. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
Status: string
Status in the candidate results.
Nested Schema : Services About the Candidate Results
Type:
array
Title:
Services About the Candidate Results
The services resource is a child of the bcCandidateResults resource. It includes the services of the candidate results. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : bcCandidateResults-services-item-post-request
Type:
Show Source
object
-
AdditionalResultsAttributes: array
Additional Candidate Background Check Results
Title:
Additional Candidate Background Check Results
The additionalResultsAttributes resource is a child of the bcCandidateResults resource. It includes the additional attributes of the candidate results. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
Code: string
Code in the services of the candidate results.
-
ErrorDetail: string
Description of the errors in the services of the candidate results.
-
ScreeningPackage: string
Screening package in the services of the candidate results.
-
Status: string
Status in the services of the candidate results.
Nested Schema : Additional Candidate Background Check Results
Type:
array
Title:
Additional Candidate Background Check Results
The additionalResultsAttributes resource is a child of the bcCandidateResults resource. It includes the additional attributes of the candidate results. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : bcCandidateResults-services-AdditionalResultsAttributes-item-post-request
Type:
Show Source
object
-
AttributeName: string
Attribute name of the background check service additional results.
-
AttributeValue: string
Attribute value of the background check service additional results.
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 : bcCandidateResults-item-response
Type:
Show Source
object
-
CandidateNumber: string
Candidate number in the candidate results.
-
Comments: string
Comments in candidate results.
-
ErrorDetail: string
Error detail in candidate results.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartnerId: string
Maximum Length:
255
Partner ID in candidate results. -
PartnerUsername: string
Partner user name in candidate results.
-
RequisitionNumber: string
Requisition number in the candidate results.
-
services: array
Services About the Candidate Results
Title:
Services About the Candidate Results
The services resource is a child of the bcCandidateResults resource. It includes the services of the candidate results. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
Status: string
Status in the candidate results.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Services About the Candidate Results
Type:
array
Title:
Services About the Candidate Results
The services resource is a child of the bcCandidateResults resource. It includes the services of the candidate results. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
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 : bcCandidateResults-services-item-response
Type:
Show Source
object
-
AdditionalResultsAttributes: array
Additional Candidate Background Check Results
Title:
Additional Candidate Background Check Results
The additionalResultsAttributes resource is a child of the bcCandidateResults resource. It includes the additional attributes of the candidate results. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
Code: string
Code in the services of the candidate results.
-
ErrorDetail: string
Description of the errors in the services of the candidate results.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ScreeningPackage: string
Screening package in the services of the candidate results.
-
Status: string
Status in the services of the candidate results.
Nested Schema : Additional Candidate Background Check Results
Type:
array
Title:
Additional Candidate Background Check Results
The additionalResultsAttributes resource is a child of the bcCandidateResults resource. It includes the additional attributes of the candidate results. 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 : bcCandidateResults-services-AdditionalResultsAttributes-item-response
Type:
Show Source
object
-
AttributeName: string
Attribute name of the background check service additional results.
-
AttributeValue: string
Attribute value of the background check service additional results.
-
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
- services
-
Parameters:
- PartnerId:
$request.path.PartnerId
The services resource is a child of the bcCandidateResults resource. It includes the services of the candidate results. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - PartnerId: