Get a registration for a recruiting event. Currently not supported.
get
/hcmRestApi/resources/11.13.18.05/recruitingCEEventRegistrations/{recruitingCEEventRegistrationsUniqID}
Request
Path Parameters
-
recruitingCEEventRegistrationsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- CandidateNumber and EventNumber ---for the Recruiting Event Registrations resource and used to uniquely identify an instance of Recruiting Event Registrations. The client should not generate the hash key value. Instead, the client should query on the Recruiting Event Registrations collection resource with a filter on the primary key values in order to navigate to a specific instance of Recruiting Event Registrations.
For example: recruitingCEEventRegistrations?q=CandidateNumber=<value1>;EventNumber=<value2>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : recruitingCEEventRegistrations-item-response
Type:
Show Source
object
-
Action: string
Action performed on a recruiting event registration.
-
CandidateNumber: string
Maximum Length:
255
Candidate number in the recruiting event registration. -
ConfirmedFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the recruiting event registration is confirmed or not by the candidate. -
Disqualification: string
Read Only:
true
Maximum Length:255
Indicates that the candidate is disqualified. -
EndDate: string
Read Only:
true
Maximum Length:255
End date of the recruiting event registration. -
EventFormat: string
Read Only:
true
Maximum Length:255
Event format of the recruiting event registration. -
EventLocation: string
Read Only:
true
Maximum Length:255
Event location of the recruiting event registration. -
EventNumber: string
Event number of the recruiting event registration.
-
EventStatus: string
Read Only:
true
Maximum Length:255
Event status of the recruiting event registration. -
FlowVersionId: integer
Flow version identifier of the recruiting event registration.
-
LegalDescriptionVersionId: integer
Legal description identifier of the recruiting event registration.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualConfirmationRequiredFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether manual confirmation is enabled for an event registration. Valid values are Y and N. -
MeetingURL: string
Read Only:
true
Maximum Length:255
Meeting URL in the recruiting event registration. -
RecruitingEventQuestionnaireResponses: array
Candidate Responses to Questions
Title:
Candidate Responses to Questions
The RecruitingEventQuestionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire. -
RegisteredOnDate: string
Read Only:
true
Maximum Length:255
Registration date of the recruiting event registration. -
RegistrationPhase: string
Read Only:
true
Maximum Length:255
Registration phase of the recruiting event registration. -
SiteNumber: string
Site number in the recruiting event registration.
-
StartDate: string
Read Only:
true
Maximum Length:255
Event start date of the recruiting event registration. -
Status: string
Read Only:
true
Maximum Length:255
Status used to categorize the event in the candidate self service. Possible values are active or inactive. -
Title: string
Read Only:
true
Maximum Length:255
Event title in the recruiting event registration.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Candidate Responses to Questions
Type:
array
Title:
Candidate Responses to Questions
The RecruitingEventQuestionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire.
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 : recruitingCEEventRegistrations-RecruitingEventQuestionnaireResponses-item-response
Type:
Show Source
object
-
Disqualification: string
Maximum Length:
255
Indicates that the candidate is disqualified. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QstnrVersionNumber: integer
Version number of the questionnaire for which the responses are provided.
-
QuestionnaireId: integer
ID of the questionnaire for which the responses are provided
-
QuestionResponses: string
Responses provided by the candidate for the questionnaire.
-
Type: string
Type of the questionnaire for which the responses are provided.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- RecruitingEventQuestionnaireResponses
-
Parameters:
- recruitingCEEventRegistrationsUniqID:
$request.path.recruitingCEEventRegistrationsUniqID
The RecruitingEventQuestionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire. - recruitingCEEventRegistrationsUniqID: