Get all scheduled interview requests for a candidate
get
/hcmRestApi/resources/11.13.18.05/recruitingICECandidateInterviewRequests/{PersonId}/child/ScheduleInterviews
Request
Path Parameters
-
PersonId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds all scheduled interview requests sent to a candidate using a unique identifier.
Finder Variables- IntrvwRequestsId; integer; Interview request identifier used to find all scheduled interview requests sent to a candidate.
- ScheduleInterviewId; integer; Schedule interview identifier used to find all scheduled interview requests sent to a candidate.
- ScheduleLocationId; integer; Schedule location identifier used to find all scheduled interview requests sent to a candidate.
- PrimaryKey Finds all scheduled interview requests sent to a candidate using a unique identifier.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- EndDate; string; End date.
- FormattedPhoneNumber; string; Formatted phone number.
- IntrvwRequestsId; integer; Interview request identifier.
- IntrvwRschldCount; integer; Interview rescheduled count.
- IsRescheduled; string; Indicates if the interview has been rescheduled.
- IsScheduled; string; Indicates if the interview has been scheduled.
- LocationType; string; Location type.
- PersonId; integer; Person identifier.
- PhoneNumberPasscode; string; Phone number passcode.
- RemainingRescheduleCount; integer; Reschedules remaining count.
- RequisitionNumber; string; Requisition number.
- ScheduleId; integer; Schedule identifier.
- ScheduleInterviewId; integer; Schedule interview identifier.
- ScheduleLocationId; integer; Schedule location identifier.
- StartDate; string; Start date.
- SubmissionId; integer; Job application identifier.
- Title; string; Interview title.
- WebConferenceLink; string; Web conference link.
- canCancel; string; Indicates whether the candidate can cancel an interview.
- canReschedule; string; Indicates whether the candidate can reschedule an interview.
- canSchedule; string; Candidate can schedule indicator.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : recruitingICECandidateInterviewRequests-ScheduleInterviews
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingICECandidateInterviewRequests-ScheduleInterviews-item-response
Type:
Show Source
object
-
canCancel: string
Read Only:
true
Indicates whether the candidate can cancel an interview. -
canReschedule: string
Read Only:
true
Indicates whether the candidate can reschedule an interview. -
canSchedule: string
Read Only:
true
Maximum Length:255
Candidate can schedule indicator. -
EndDate: string
(date-time)
Read Only:
true
End date. -
FormattedPhoneNumber: string
Read Only:
true
Maximum Length:255
Formatted phone number. -
IntrvwRequestsId: integer
Interview request identifier.
-
IntrvwRschldCount: integer
Read Only:
true
Interview rescheduled count. -
IsRescheduled: string
Read Only:
true
Maximum Length:255
Indicates if the interview has been rescheduled. -
IsScheduled: string
Maximum Length:
255
Indicates if the interview has been scheduled. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationType: string
Maximum Length:
255
Location type. -
PersonId: integer
Read Only:
true
Person identifier. -
PhoneNumberPasscode: string
Read Only:
true
Maximum Length:255
Phone number passcode. -
RemainingRescheduleCount: integer
Read Only:
true
Reschedules remaining count. -
RequisitionNumber: string
Read Only:
true
Maximum Length:255
Requisition number. -
ScheduleId: integer
Read Only:
true
Schedule identifier. -
ScheduleInterviewId: integer
Schedule interview identifier.
-
ScheduleInterviewParticipants: array
Schedule Interview Participants
Title:
Schedule Interview Participants
The ScheduleInterviewParticipants resource is a child of recruitingCEInterviewDetails. It includes all interview schedules for participants. Note that the service endpoints in this resource category are only for Oracle internal use. -
ScheduleLocationId: integer
Read Only:
true
Schedule location identifier. -
StartDate: string
(date-time)
Start date.
-
SubmissionId: integer
Job application identifier.
-
Title: string
Read Only:
true
Maximum Length:255
Interview title. -
WebConferenceLink: string
Read Only:
true
Maximum Length:255
Web conference link.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Schedule Interview Participants
Type:
array
Title:
Schedule Interview Participants
The ScheduleInterviewParticipants resource is a child of recruitingCEInterviewDetails. It includes all interview schedules for participants. Note that the service endpoints in this resource category are only for Oracle internal use.
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 : recruitingICECandidateInterviewRequests-ScheduleInterviews-ScheduleInterviewParticipants-item-response
Type:
Show Source
object
-
DisplayName: string
Title:
Name
Read Only:true
Maximum Length:240
Display name of the participants scheduled for the interview. -
EffectiveEndDate: string
(date)
Read Only:
true
Effective end date. -
EffectiveStartDate: string
(date)
Read Only:
true
Effective start date. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the participant list scheduled for interview. -
ParticipantId: integer
(int64)
ID assigned to interview participant.
-
ParticipantType: string
Title:
Participant Type
Maximum Length:32
Type of participant for whom the interview is schedules -
PartObjectVersionNumber: integer
(int32)
Participant object version number.
-
PersonId: integer
(int64)
Title:
Person ID
Person identifier. -
PersonNameId: integer
(int64)
Read Only:
true
Person name. -
PersonNameObjectVersionNumber: integer
(int32)
Read Only:
true
Person name object version number. -
ScheduleInterviewId: integer
(int64)
Schedule interview identifier.
-
SubmissionId: integer
(int64)
Job application identifier.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source