Submit all services of the screening packages
post
/hcmRestApi/resources/11.13.18.05/bcScreeningPackages/{bcScreeningPackagesUniqID}/child/services
Request
Path Parameters
-
bcScreeningPackagesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- RequisitionNumber, PartnerId and PartnerUsername ---for the Recruiting Background Check Screening Packages resource and used to uniquely identify an instance of Recruiting Background Check Screening Packages. The client should not generate the hash key value. Instead, the client should query on the Recruiting Background Check Screening Packages collection resource with a filter on the primary key values in order to navigate to a specific instance of Recruiting Background Check Screening Packages.
For example: bcScreeningPackages?q=RequisitionNumber=<value1>;PartnerId=<value2>;PartnerUsername=<value3>
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
-
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.
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 : bcScreeningPackages-services-item-response
Type:
Show Source
object
-
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.
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.