Jump to

• Request
• Response

Post all details of the recruiting background check account packages

post

/hcmRestApi/resources/11.13.18.05/recruitingBGCheckAccountPackages

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

• ActiveFlag: boolean
  Active indicator in the recruiting background check account packages.
• ClientReferenceKey: string
  Client reference key in the recruiting background check account packages.
• Description: string
  Description in the recruiting background check account packages.
• packages: array Packages Included in the Recruiting Background Check Account Packages
  Title: Packages Included in the Recruiting Background Check Account Packages

  The packages resource is a child of recruitingBGCheckAccountPackages. It includes the details of the packages in the recruiting background check account packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
• PartnerId: string
  Partner ID in the recruiting background check account packages.
• PartnerUsername: string
  Partner user name in the recruiting background check account packages.

{
    "type":"object",
    "properties":{
        "ClientReferenceKey":{
            "type":"string",
            "description":"Client reference key in the recruiting background check account packages.",
            "nullable":true
        },
        "PartnerUsername":{
            "type":"string",
            "description":"Partner user name in the recruiting background check account packages.",
            "nullable":true
        },
        "PartnerId":{
            "type":"string",
            "description":"Partner ID in the recruiting background check account packages.",
            "nullable":true
        },
        "Description":{
            "type":"string",
            "description":"Description in the recruiting background check account packages.",
            "nullable":true
        },
        "packages":{
            "title":"Packages Included in the Recruiting Background Check Account Packages",
            "type":"array",
            "description":"The packages resource is a child of recruitingBGCheckAccountPackages. It includes the details of the packages in the recruiting background check account packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.",
            "items":{
                "$ref":"#/components/schemas/recruitingBGCheckAccountPackages-packages-item-post-request"
            }
        },
        "ActiveFlag":{
            "type":"boolean",
            "description":"Active indicator in the recruiting background check account packages.",
            "nullable":true
        }
    }
}

Nested Schema : Packages Included in the Recruiting Background Check Account Packages

Type: array

Title: Packages Included in the Recruiting Background Check Account Packages

The packages resource is a child of recruitingBGCheckAccountPackages. It includes the details of the packages in the recruiting background check account 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 recruitingBGCheckAccountPackages-packages-item-post-request

{
    "title":"Packages Included in the Recruiting Background Check Account Packages",
    "type":"array",
    "description":"The packages resource is a child of recruitingBGCheckAccountPackages. It includes the details of the packages in the recruiting background check account packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.",
    "items":{
        "$ref":"#/components/schemas/recruitingBGCheckAccountPackages-packages-item-post-request"
    }
}

Nested Schema : recruitingBGCheckAccountPackages-packages-item-post-request

Type: object

Show Source

• Description: string
  Description of packages in the recruiting background check account packages.
• PackageCode: string
  Code of the recruiting background check account packages.
• PackageName: string
  Name of the recruiting background check account packages.

{
    "type":"object",
    "properties":{
        "Description":{
            "type":"string",
            "description":"Description of packages in the recruiting background check account packages.",
            "nullable":true
        },
        "PackageCode":{
            "type":"string",
            "description":"Code of the recruiting background check account packages.",
            "nullable":true
        },
        "PackageName":{
            "type":"string",
            "description":"Name of the recruiting background check account packages.",
            "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 : recruitingBGCheckAccountPackages-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Active indicator in the recruiting background check account packages.
• ClientReferenceKey: string
  Client reference key in the recruiting background check account packages.
• Description: string
  Description in the recruiting background check account packages.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• packages: array Packages Included in the Recruiting Background Check Account Packages
  Title: Packages Included in the Recruiting Background Check Account Packages

  The packages resource is a child of recruitingBGCheckAccountPackages. It includes the details of the packages in the recruiting background check account packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
• PartnerId: string
  Partner ID in the recruiting background check account packages.
• PartnerUsername: string
  Partner user name in the recruiting background check account packages.

{
    "type":"object",
    "properties":{
        "ClientReferenceKey":{
            "type":"string",
            "description":"Client reference key in the recruiting background check account packages.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerUsername":{
            "type":"string",
            "description":"Partner user name in the recruiting background check account packages.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"Description in the recruiting background check account packages.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerId":{
            "type":"string",
            "description":"Partner ID in the recruiting background check account 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"
            }
        },
        "packages":{
            "title":"Packages Included in the Recruiting Background Check Account Packages",
            "type":"array",
            "description":"The packages resource is a child of recruitingBGCheckAccountPackages. It includes the details of the packages in the recruiting background check account packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.",
            "items":{
                "$ref":"#/components/schemas/recruitingBGCheckAccountPackages-packages-item-response"
            }
        },
        "ActiveFlag":{
            "type":"boolean",
            "description":"Active indicator in the recruiting background check account 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 : Packages Included in the Recruiting Background Check Account Packages

Type: array

Title: Packages Included in the Recruiting Background Check Account Packages

The packages resource is a child of recruitingBGCheckAccountPackages. It includes the details of the packages in the recruiting background check account 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 recruitingBGCheckAccountPackages-packages-item-response

{
    "title":"Packages Included in the Recruiting Background Check Account Packages",
    "type":"array",
    "description":"The packages resource is a child of recruitingBGCheckAccountPackages. It includes the details of the packages in the recruiting background check account packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.",
    "items":{
        "$ref":"#/components/schemas/recruitingBGCheckAccountPackages-packages-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 : recruitingBGCheckAccountPackages-packages-item-response

Type: object

Show Source

• Description: string
  Description of packages in the recruiting background check account packages.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PackageCode: string
  Code of the recruiting background check account packages.
• PackageName: string
  Name of the recruiting background check account packages.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Description":{
            "type":"string",
            "description":"Description of packages in the recruiting background check account packages.",
            "nullable":true,
            "x-queryable":true
        },
        "PackageCode":{
            "type":"string",
            "description":"Code of the recruiting background check account packages.",
            "nullable":true,
            "x-queryable":true
        },
        "PackageName":{
            "type":"string",
            "description":"Name of the recruiting background check account 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"
    }
}

Links

packages

Operation: /hcmRestApi/resources/11.13.18.05/recruitingBGCheckAccountPackages/{recruitingBGCheckAccountPackagesUniqID}/child/packages

Parameters:

• recruitingBGCheckAccountPackagesUniqID: $request.path.recruitingBGCheckAccountPackagesUniqID

The packages resource is a child of recruitingBGCheckAccountPackages. It includes the details of the packages in the recruiting background check account packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Back to Top