Get a candidate interview in the recruiting agency

get

/hcmRestApi/resources/11.13.18.05/recruitingUIAgencyCandidateInterviews/{ScheduleInterviewId}

Request

Path Parameters
  • 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
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : recruitingUIAgencyCandidateInterviews-item-response
Type: object
Show Source
  • Read Only: true
    Address identifier of the candidate interview location in the recruiting agency.
  • Read Only: true
    Maximum Length: 240
    Address line 1 of the candidate interview location in the recruiting agency.
  • Read Only: true
    Maximum Length: 240
    Address line 2 of the candidate interview location in the recruiting agency.
  • Read Only: true
    Maximum Length: 240
    Address line 3 of the candidate interview location in the recruiting agency.
  • Read Only: true
    Maximum Length: 240
    Address line 4 of the candidate interview location in the recruiting agency.
  • Read Only: true
    Maximum Length: 240
    Building of the candidate interview location in the recruiting agency. This attribute specifies the physical location or venue for the interview.
  • Read Only: true
    Maximum Length: 60
    Country of the candidate interview location in the recruiting agency. This field identifies the location context for the interview.
  • Read Only: true
    Maximum Length: 240
    Indicates who created the candidate interview in the recruiting agency. This field is read-only and automatically populated by the system.
  • Read Only: true
    End date of the candidate interview in the recruiting agency. This date marks the conclusion of the interview session.
  • Read Only: true
    Maximum Length: 40
    Floor number of the candidate interview location in the recruiting agency.
  • Maximum Length: 255
    Formatted end date of the candidate interview in the recruiting agency. This date indicates when the interview is scheduled to conclude.
  • Read Only: true
    Maximum Length: 255
    Formatted multiline address of the candidate interview location in the recruiting agency. This field displays the complete address in a readable format.
  • Read Only: true
    Maximum Length: 4000
    Formatted phone number of the candidate interview in the recruiting agency.
  • Maximum Length: 255
    Formatted start date of the candidate interview in the recruiting agency. This date indicates when the interview is scheduled to begin.
  • Read Only: true
    Interview notes of the candidate interview in the recruiting agency.
  • Interview Participants in Recruiting Agency
    Title: Interview Participants in Recruiting Agency
    The InterviewParticipantsUI resource provides access to interview participants in the recruiting agency.
  • Read Only: true
    Maximum Length: 32
    Interview type of the candidate interview in the recruiting agency. This value determines the format or purpose of the interview, such as phone or in person.
  • Read Only: true
    Maximum Length: 80
    Interview type meaning of the candidate interview in the recruiting agency.
  • Read Only: true
    Interview request identifier of a candidate interview in the recruiting agency.
  • Read Only: true
    Maximum Length: 1
    Indicates whether the candidate interview is scheduled in the recruiting agency. Valid values are Y and N. Default is N.
  • Links
  • Read Only: true
    Location type of the candidate interview in the recruiting agency. Valid values are defined in the system.
  • Read Only: true
    Maximum Length: 32
    Location type of the candidate interview in the recruiting agency. Valid values are defined in the system.
  • Read Only: true
    Maximum Length: 80
    Location type meaning of the candidate interview in the recruiting agency.
  • Read Only: true
    Maximum Length: 30
    Long postal code of the candidate interview in the recruiting agency.
  • Read Only: true
    Maximum Length: 4000
    List of interview participants in the recruiting agency.
  • Read Only: true
    Person identifier of the candidate interview in the recruiting agency.
  • Read Only: true
    Maximum Length: 30
    Phone area code of the candidate interview in the recruiting agency.
  • Read Only: true
    Maximum Length: 30
    Phone country code of the candidate interview in the recruiting agency.
  • Read Only: true
    Maximum Length: 60
    Phone number of the candidate interview in the recruiting agency.
  • Read Only: true
    Maximum Length: 30
    Phone number passcode of the candidate interview in the recruiting agency. Used to authenticate or access interview details.
  • Read Only: true
    Maximum Length: 30
    Postal code of the candidate interview in the recruiting agency.
  • Read Only: true
    Requisition identifier of the candidate interview in the recruiting agency.
  • Read Only: true
    Schedule identifier of the candidate interview in the recruiting agency.
  • Read Only: true
    Schedule interview identifier of the candidate interview in the recruiting agency.
  • Read Only: true
    Maximum Length: 64
    Schedule title of the candidate interview in the recruiting agency.
  • Read Only: true
    Start date of the candidate interview in the recruiting agency.
  • Read Only: true
    Maximum Length: 32
    Status of the candidate interview in the recruiting agency. This field reflects whether the interview is pending, confirmed, or completed.
  • Read Only: true
    Maximum Length: 80
    Status meaning of the candidate interview in the recruiting agency.
  • Read Only: true
    Job application identifier of the candidate interview in the recruiting agency.
  • Read Only: true
    Total seats count of the candidate interview in the recruiting agency.
  • Read Only: true
    Maximum Length: 60
    Town or city of the candidate interview in the recruiting agency.
Nested Schema : Interview Participants in Recruiting Agency
Type: array
Title: Interview Participants in Recruiting Agency
The InterviewParticipantsUI resource provides access to interview participants in the recruiting agency.
Show Source
Nested Schema : recruitingUIAgencyCandidateInterviews-InterviewParticipantsUI-item-response
Type: object
Show Source
Back to Top