Create an assessment configuration for a requisition
post
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs
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
-
AccountId: integer
Assessment user account identifier.
-
AssessmentConfigId: integer
Assessment configuration identifier.
-
InternalInlineFlag: boolean
Indicates whether the assessment is inline or not.
-
ProvisioningId: integer
Assessment provisioning identifier.
-
RequisitionId: integer
Assessment requisition identifier.
-
RequisitionMultiPhaseEnabledFlag: boolean
Indicates whether the assessment configuration accepts multiple requests for the requisition.
-
triggers: array
Assessment Triggers in Job Requisition
Title:
Assessment Triggers in Job Requisition
The triggers resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides partner triggers for a requisition.
Nested Schema : Assessment Triggers in Job Requisition
Type:
array
Title:
Assessment Triggers in Job Requisition
The triggers resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides partner triggers for a requisition.
Show Source
Nested Schema : recruitingUIRequisitionAssessmentsConfigs-triggers-item-post-request
Type:
Show Source
object
-
packages: array
Assessment Trigger Packages in Job Requisition
Title:
Assessment Trigger Packages in Job Requisition
The packages resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides trigger packages for a requisition. -
PhaseId: integer
Assessment trigger phase identifier.
-
StateId: integer
Assessment trigger state identifier.
-
TriggerType: string
Maximum Length:
255
Assessment trigger type.
Nested Schema : Assessment Trigger Packages in Job Requisition
Type:
array
Title:
Assessment Trigger Packages in Job Requisition
The packages resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides trigger packages for a requisition.
Show Source
Nested Schema : recruitingUIRequisitionAssessmentsConfigs-triggers-packages-item-post-request
Type:
Show Source
object
-
PackageId: integer
Assessment package identifier associated to triggers.
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 : recruitingUIRequisitionAssessmentsConfigs-item-response
Type:
Show Source
object
-
AccountActiveFlag: boolean
Read Only:
true
Indicates whether the assessment user account is active or not. -
AccountDescription: string
Read Only:
true
Maximum Length:255
Assessment user account description. -
AccountId: integer
Assessment user account identifier.
-
AccountName: string
Read Only:
true
Maximum Length:255
Assessment user account name. -
AssessmentConfigId: integer
Assessment configuration identifier.
-
InternalInlineFlag: boolean
Indicates whether the assessment is inline or not.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartnerActiveFlag: boolean
Read Only:
true
Indicates whether the assessment partner is active or not. -
PartnerInlineSupportFlag: boolean
Read Only:
true
Indicates whether the assessment configuration accepts multiple requests for the requisition. -
PartnerMultiPhaseSupportFlag: boolean
Read Only:
true
Indicates whether the assessment partner supports multiple requests or not. -
PartnerName: string
Read Only:
true
Maximum Length:255
Assessment partner name. -
ProvisioningId: integer
Assessment provisioning identifier.
-
RequisitionId: integer
Assessment requisition identifier.
-
RequisitionMultiPhaseEnabledFlag: boolean
Indicates whether the assessment configuration accepts multiple requests for the requisition.
-
SupportedPhaseCount: integer
Read Only:
true
Indicates the number of triggers supported by the assessment partner. -
triggers: array
Assessment Triggers in Job Requisition
Title:
Assessment Triggers in Job Requisition
The triggers resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides partner triggers for a requisition.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Assessment Triggers in Job Requisition
Type:
array
Title:
Assessment Triggers in Job Requisition
The triggers resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides partner triggers for a requisition.
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 : recruitingUIRequisitionAssessmentsConfigs-triggers-item-response
Type:
Show Source
object
-
AllowedPackageCount: integer
Read Only:
true
Indicates whether the assessment trigger accepts multiple packages or not. -
AssessmentConfigId: integer
Read Only:
true
Assessment trigger configuration identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
packages: array
Assessment Trigger Packages in Job Requisition
Title:
Assessment Trigger Packages in Job Requisition
The packages resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides trigger packages for a requisition. -
PhaseId: integer
Assessment trigger phase identifier.
-
StateId: integer
Assessment trigger state identifier.
-
TriggerActiveFlag: boolean
Read Only:
true
Indicates whether the assessment trigger is active or not. -
TriggerName: string
Read Only:
true
Maximum Length:255
Assessment trigger name. -
TriggerSequence: integer
Read Only:
true
Assessment trigger sequence. -
TriggerType: string
Maximum Length:
255
Assessment trigger type.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Assessment Trigger Packages in Job Requisition
Type:
array
Title:
Assessment Trigger Packages in Job Requisition
The packages resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides trigger packages for a requisition.
Show Source
Nested Schema : recruitingUIRequisitionAssessmentsConfigs-triggers-packages-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PackageCode: string
Read Only:
true
Maximum Length:255
Assessment package code associated to triggers. -
PackageDescription: string
Read Only:
true
Maximum Length:255
Assessment package description associated to triggers. -
PackageId: integer
Assessment package identifier associated to triggers.
-
PackageName: string
Read Only:
true
Maximum Length:255
Assessment package name associated to triggers. -
PackageSequence: integer
Read Only:
true
Assessment package sequence within a trigger. -
PackageValidFlag: boolean
Read Only:
true
Indicates whether the assessment package is active or not.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- triggers
-
Parameters:
- AssessmentConfigId:
$request.path.AssessmentConfigId
The triggers resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides partner triggers for a requisition. - AssessmentConfigId: