Jump to

• Request
• Response

Submit all details of the screening packages

post

/hcmRestApi/resources/11.13.18.05/bcScreeningPackages

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

• PartnerId: string
  Partner ID in screening packages.
• PartnerUsername: string
  Default Value: ''

  Partner user name in screening packages.
• RequisitionNumber: string
  Maximum Length: 255

  Requisition number in screening packages.
• services: array Services About the Screening Packages.
  Title: Services About the Screening Packages.

  The services resource is a child of the bcScreeningPackages resource. It includes the services of the screening packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

{
    "type":"object",
    "properties":{
        "PartnerUsername":{
            "type":"string",
            "description":"Partner user name in screening packages.",
            "nullable":true,
            "default":"''"
        },
        "PartnerId":{
            "type":"string",
            "description":"Partner ID in screening packages.",
            "nullable":true
        },
        "services":{
            "title":"Services About the Screening Packages.",
            "type":"array",
            "description":"The services resource is a child of the bcScreeningPackages resource. It includes the services of the screening packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.",
            "items":{
                "$ref":"#/components/schemas/bcScreeningPackages-services-item-post-request"
            }
        },
        "RequisitionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Requisition number in screening packages.",
            "nullable":true
        }
    }
}

Nested Schema : Services About the Screening Packages.

Type: array

Title: Services About the Screening Packages.

The services resource is a child of the bcScreeningPackages resource. It includes the services of the screening packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Show Source

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

{
    "title":"Services About the Screening Packages.",
    "type":"array",
    "description":"The services resource is a child of the bcScreeningPackages resource. It includes the services of the screening packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.",
    "items":{
        "$ref":"#/components/schemas/bcScreeningPackages-services-item-post-request"
    }
}

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

Type: object

Show Source

• Code: string
  Code assigned to the services of the screening packages.
• Description: string
  Description of the services of the screening packages.
• ScreeningOrder: string
  Order of the screening services.
• ScreeningPackage: string
  Maximum Length: 255

  Screening package used for the background check.

{
    "type":"object",
    "properties":{
        "ScreeningPackage":{
            "maxLength":"255",
            "type":"string",
            "description":"Screening package used for the background check.",
            "nullable":true
        },
        "Description":{
            "type":"string",
            "description":"Description of the services of the screening packages.",
            "nullable":true
        },
        "Code":{
            "type":"string",
            "description":"Code assigned to the services of the screening packages.",
            "nullable":true
        },
        "ScreeningOrder":{
            "type":"string",
            "description":"Order of the screening services.",
            "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 : bcScreeningPackages-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartnerId: string
  Partner ID in screening packages.
• PartnerUsername: string
  Default Value: ''

  Partner user name in screening packages.
• RequisitionNumber: string
  Maximum Length: 255

  Requisition number in screening packages.
• services: array Services About the Screening Packages.
  Title: Services About the Screening Packages.

  The services resource is a child of the bcScreeningPackages resource. It includes the services of the screening packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

{
    "type":"object",
    "properties":{
        "PartnerUsername":{
            "type":"string",
            "description":"Partner user name in screening packages.",
            "nullable":true,
            "default":"''",
            "x-queryable":true
        },
        "PartnerId":{
            "type":"string",
            "description":"Partner ID in screening packages.",
            "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 Screening Packages.",
            "type":"array",
            "description":"The services resource is a child of the bcScreeningPackages resource. It includes the services of the screening packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.",
            "items":{
                "$ref":"#/components/schemas/bcScreeningPackages-services-item-response"
            }
        },
        "RequisitionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Requisition number in screening packages.",
            "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 Screening Packages.

Type: array

Title: Services About the Screening Packages.

The services resource is a child of the bcScreeningPackages resource. It includes the services of the screening packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Show Source

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

{
    "title":"Services About the Screening Packages.",
    "type":"array",
    "description":"The services resource is a child of the bcScreeningPackages resource. It includes the services of the screening packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.",
    "items":{
        "$ref":"#/components/schemas/bcScreeningPackages-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 : bcScreeningPackages-services-item-response

Type: object

Show Source

• Code: string
  Code assigned to the services of the screening packages.
• Description: string
  Description of the services of the screening packages.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ScreeningOrder: string
  Order of the screening services.
• ScreeningPackage: string
  Maximum Length: 255

  Screening package used for the background check.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ScreeningPackage":{
            "maxLength":"255",
            "type":"string",
            "description":"Screening package used for the background check.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"Description of the services of the screening packages.",
            "nullable":true,
            "x-queryable":true
        },
        "Code":{
            "type":"string",
            "description":"Code assigned to the services of the screening packages.",
            "nullable":true,
            "x-queryable":true
        },
        "ScreeningOrder":{
            "type":"string",
            "description":"Order of the screening services.",
            "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/bcScreeningPackages/{bcScreeningPackagesUniqID}/child/services

Parameters:

• bcScreeningPackagesUniqID: $request.path.bcScreeningPackagesUniqID

The services resource is a child of the bcScreeningPackages resource. It includes the services of the screening packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Back to Top