How To Topic

Viewing Details for Public Interview Links

The Get public interview link details API method enables you to obtain a list of public interview links active on your tenancy.

Prerequisites

Before making a 'create public interview link' request, you must have an access token to sign the request. You can retrieve an access token using one of the following flows:

• Getting an access token using the Resource Owner flow
• Getting an access token using the Implicit flow

Additionally, you must have the following items in the tenancy in which you are creating the public interview link:

• Client interviews must be activated at Root
• A work group  – the ID of a work group in your tenancy is required when making the request

Overview

The 'get public interview link details' API method is a command method. The API client invoking this method must have either a command or a root scope.

This method is useful when you want to obtain the details of the public interview links active in your tenancy.

Authentication

See Authentication for more information about authenticating requests to the Advance API.

API Documentation

Request

To request details for a public interview link

Request URL

GET https://{tenancymoniker}.{domain}/HdaApi/rest/v1.1/PublicInterviewLinks/{publicInterviewLinkId}

Headers

Key	Required	Description	Example value
Authorization	Yes	The Authorization header for the request. Uses the access token retrieved (see Prerequisites section above for more information).	Bearer [access token]

Parameters

Name	Type	Location	Required	Description
tenancymoniker	String	URL	Yes	The tenancy moniker for the tenancy in which you want to create the new work item.
domain	String	URL	Yes	Your domain. For example, yourorganization.com.
publicInterviewLinkId	Guid	URL	Yes	The ID that identifies the public interview link. The ID cannot be the same as that of an existing public interview link.

Examples

Example Request URL

https://yourtenancy.yourorganization.com/HdaApi/rest/v1.1/PublicInterviewLinks/2d9f3d10-6fdb-494f-9929-955515c6f114

Example Response JSON

{
  "totalItems": 1,
  "items": [
    {
      "publicInterviewLinkId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "url": "string",
      "isActive": bool,
      "workGroup": {
                "workGroupId": guid,
                "name": string
      }
      "templatePackage": {
                "templatePackageId": guid,
                "name": string
      },
      "createdDate": "2021-05-21T10:10:05.287Z",
      "createdBy": {
                      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "fullName": "string"
                    },
      "modifiedDate": "2021-05-21T10:10:05.287Z",
      "modifiedBy": {
                      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "fullName": "string"
                    },
    }
  ]
}

Example Response

Status: 200 OK

The response shows an empty array if no public interview links have been created, or if all have been deleted.

Error responses:

Status: 403 Client interviews are not enabled on the tenancy.