This endpoint lets you fetch a test instance under a task of your organization. Additional information about the test instance can be obtained by using keywords in body.
Request Body
A list of keywords can be provided with the expand property in the request body. For each keyword provided, extra information about the test instance will be returned in the response.
{
expand: (
"test" |
"uniqId" |
"creditCost" |
"roomForm" |
"identityPhoto"|
"report" |
"passFail" |
"level" |
"customReport"
)[];
extra?: {
customReportId?: string
}
}Response
By default, a "detailed" test instance object will be returned. Additional properties can will be added on top of the detailed object.
Detailed & {
creditCost?: number;
uniqId?: string;
test?: {
source: "own-test" | "marketplace" | "talent-library-test" | "free-talent-library-test" |
"recruitment-test-library" | "free-recruitment-test-library" | "trial" | "unknown";
testId: string;
organizationId: string
},
roomForm?: Record;
identityPhoto?: { url: string | null };
passFail?: {
result: "pass" | "fail";
label: string;
description: string;
score: number;
threshold: {
score: number;
inclusive: boolean;
};
} | null;
level?: {
label: string;
description: string;
color: string;
score: number;
range: {
from: {
value: number;
inclusive: boolean;
};
to: {
value: number;
inclusive: boolean;
};
};
} | null;
report?: {
templateKind: "standard" | "customReport";
rendered: string; // base64 encoded html output
};
customReport?: {
customResult?: {
rendered: string; // base64 encoded html output
}
}
} - creditCost: The amount of credits used to conduct this test instance.
- uniqId: The unique ID assigned to the candidate to whom this test instance belongs to.
- test: The ID of the test, organization ID of the test's owner, and the source of the test.
- roomForm: The form fields and the candidate's responses to them. If the form is enabled in task settings, candidate will be asked to fill a form when they first enter the assessment
- identityPhoto: The URL to the identity photo taken of the candidate when they start a test. If identity photo is enabled in task settings, candidates will need to have their photo taken with their webcam before they can start a test in their assessment.
- passFail: The content shown in the report based on whether or not the candidate passes the threshold score set in test's report settings.
- level: The content shown in the report based on which range candidate's score falls in. The brackets and their respective contents can be defined in test's report settings.
- report: The HMTL output of the report, encoded in base64. The report template is set in the "Admin Report" settings of the associated step, and is "standard" by default.
- customReport: The HTML output of the custom report, encoded in base64. A specific custom report output can be gathered by providing its Id under extra.customReportId in the request body.