Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "PartnerUsername":{
            "type":"string",
            "description":"Partner user name in candidate results.",
            "nullable":true
        },
        "Status":{
            "type":"string",
            "description":"Status in the candidate results.",
            "nullable":true
        },
        "ErrorDetail":{
            "type":"string",
            "description":"Error detail in candidate results.",
            "nullable":true
        },
        "CandidateNumber":{
            "type":"string",
            "description":"Candidate number in the candidate results.",
            "nullable":true
        },
        "Comments":{
            "type":"string",
            "description":"Comments in candidate results.",
            "nullable":true
        },
        "PartnerId":{
            "maxLength":255,
            "type":"string",
            "description":"Partner ID in candidate results.",
            "nullable":true
        },
        "services":{
            "title":"Services About the Candidate Results",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/bcCandidateResults-services-item-post-request"
            }
        },
        "RequisitionNumber":{
            "type":"string",
            "description":"Requisition number in the candidate results.",
            "nullable":true
        }
    }
}

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

• Array of: object bcCandidateResults-services-item-post-request

{
    "title":"Services About the Candidate Results",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/bcCandidateResults-services-item-post-request"
    }
}

Nested Schema : bcCandidateResults-services-item-post-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"string",
            "description":"Status in the services of the candidate results.",
            "nullable":true
        },
        "ErrorDetail":{
            "type":"string",
            "description":"Description of the errors in the services of the candidate results.",
            "nullable":true
        },
        "ScreeningPackage":{
            "type":"string",
            "description":"Screening package in the services of the candidate results.",
            "nullable":true
        },
        "AdditionalResultsAttributes":{
            "title":"Additional Candidate Background Check Results",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/bcCandidateResults-services-AdditionalResultsAttributes-item-post-request"
            }
        },
        "Code":{
            "type":"string",
            "description":"Code in the services of the candidate results.",
            "nullable":true
        }
    }
}

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

• Array of: object bcCandidateResults-services-AdditionalResultsAttributes-item-post-request

{
    "title":"Additional Candidate Background Check Results",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/bcCandidateResults-services-AdditionalResultsAttributes-item-post-request"
    }
}

Nested Schema : bcCandidateResults-services-AdditionalResultsAttributes-item-post-request

Type: object

Show Source

• AttributeName: string
  Attribute name of the background check service additional results.
• AttributeValue: string
  Attribute value of the background check service additional results.

{
    "type":"object",
    "properties":{
        "AttributeValue":{
            "type":"string",
            "description":"Attribute value of the background check service additional results.",
            "nullable":true
        },
        "AttributeName":{
            "type":"string",
            "description":"Attribute name of the background check service additional results.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : bcCandidateResults-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "PartnerUsername":{
            "type":"string",
            "description":"Partner user name in candidate results.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Status in the candidate results.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorDetail":{
            "type":"string",
            "description":"Error detail in candidate results.",
            "nullable":true,
            "x-queryable":true
        },
        "CandidateNumber":{
            "type":"string",
            "description":"Candidate number in the candidate results.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "type":"string",
            "description":"Comments in candidate results.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerId":{
            "maxLength":255,
            "type":"string",
            "description":"Partner ID in candidate results.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "services":{
            "title":"Services About the Candidate Results",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/bcCandidateResults-services-item-response"
            }
        },
        "RequisitionNumber":{
            "type":"string",
            "description":"Requisition number in the candidate results.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object bcCandidateResults-services-item-response

{
    "title":"Services About the Candidate Results",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/bcCandidateResults-services-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : bcCandidateResults-services-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"string",
            "description":"Status in the services of the candidate results.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorDetail":{
            "type":"string",
            "description":"Description of the errors in the services of the candidate results.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ScreeningPackage":{
            "type":"string",
            "description":"Screening package in the services of the candidate results.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalResultsAttributes":{
            "title":"Additional Candidate Background Check Results",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/bcCandidateResults-services-AdditionalResultsAttributes-item-response"
            }
        },
        "Code":{
            "type":"string",
            "description":"Code in the services of the candidate results.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object bcCandidateResults-services-AdditionalResultsAttributes-item-response

{
    "title":"Additional Candidate Background Check Results",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/bcCandidateResults-services-AdditionalResultsAttributes-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : bcCandidateResults-services-AdditionalResultsAttributes-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeValue":{
            "type":"string",
            "description":"Attribute value of the background check service additional results.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeName":{
            "type":"string",
            "description":"Attribute name of the background check service additional results.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

services

Operation: /hcmRestApi/resources/11.13.18.05/bcCandidateResults/{PartnerId}/child/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.

Back to Top