Create assessment requests for a job application
post
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessments
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
-
AssessmentURL: string
Assessment URL in the recruiting candidate assessment.
-
DraftId: integer
Unique identifier for each draft job application.
-
FlowVersionId: integer
Unique identifier for each version of the application flow used for the job application.
-
ProvisioningId: integer
Provisioning identifier in the recruiting candidate assessment.
-
RequisitionNumber: string
Maximum Length:
255
Requisition Number in the recruiting candidate assessment.
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 : recruitingCandidateAssessments-item-response
Type:
Show Source
object
-
AssessmentCompletedFlag: boolean
Read Only:
true
Indicates whether the candidate completed the assessment. -
AssessmentConfiguredFlag: boolean
Read Only:
true
Indicates whether the application flow is configured for assessment. -
AssessmentURL: string
Assessment URL in the recruiting candidate assessment.
-
DraftId: integer
Unique identifier for each draft job application.
-
FlowVersionId: integer
Unique identifier for each version of the application flow used for the job application.
-
InlineAssessmentFlag: boolean
Read Only:
true
Indicates whether the application flow is configured for an inline assessment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProvisioningId: integer
Provisioning identifier in the recruiting candidate assessment.
-
RequisitionNumber: string
Maximum Length:
255
Requisition Number in the recruiting candidate assessment. -
SubmissionBlockedFlag: boolean
Read Only:
true
Indicates whether the submission of the job application is blocked.
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.