Questions

This endpoint manages quiz questions within the assessment system.

Overview

The Questions API allows you to create, update, and manage individual questions that make up quizzes. Questions are the building blocks of assessments and can be configured with various formats, difficulty levels, and scoring mechanisms.

Question Types

The system supports multiple question formats to accommodate different assessment needs:

Key Features

File Attachments

Questions can include instruction files in markdown format to provide additional context, examples, or detailed instructions for talents.

Endpoints

get /api/v3/quiz/questions post /api/v3/quiz/questions delete /api/v3/quiz/questions/:resource_id get /api/v3/quiz/questions/:resource_id patch /api/v3/quiz/questions/:resource_id

get/api/v3/quiz/questions

Return a paginated list of quiz/questions

Input Schema

object
page?:
object
The page number, default to 1
number?: integer
The number of items per page, default to 1000
size?: integer
The sort order, comma separated list of fields. See sorting section for more details
sort?: string
Set to true to return the total number of items in the collection
count?: boolean
filter?:
object
id?: unknown
instruction_md?: unknown
question_type?: unknown
question_args?: unknown
quiz_id?: unknown
question_safe_args?: unknown
question_score?: unknown
order?: unknown
The fields to include in the response.
The key is the resource type and the value is an array of fields.
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  page?: {
    // The page number, default to 1
    number?: number;
    // The number of items per page, default to 1000
    size?: number;
  };
  // The sort order, comma separated list of fields. See sorting section for more details
  sort?: string;
  // Set to true to return the total number of items in the collection
  count?: boolean;
  filter?: {
    id?: any;
    instruction_md?: any;
    question_type?: any;
    question_args?: any;
    quiz_id?: any;
    question_safe_args?: any;
    question_score?: any;
    order?: any;
  };
  // The fields to include in the response.
  // The key is the resource type and the value is an array of fields.
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
array
Elements:
object
type: string
id?: string
attributes?:
object
id?: integer
instruction_md?: string
question_type?: string
question_args?: open struct
question_safe_args?: open struct
question_score?: open struct
order?: integer
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      instruction_md?: string;
      question_type?: string;
      question_args?: Record<string, any>;
      question_safe_args?: Record<string, any>;
      question_score?: Record<string, any>;
      order?: number;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/quiz/questions

Create a new quiz/questions

Input Schema

object
data:
object
type: string
attributes:
object
id?: integer
instruction_md?: string
question_type?: string
question_args?: open struct
question_safe_args?: open struct
question_score?: open struct
order?: integer
relationships?:
object
quiz:
object
data:
object
type: string
id?: string

Typescript

type InputSchema = {
  data: {
    type: string;
    attributes: {
      id?: number;
      instruction_md?: string;
      question_type?: string;
      question_args?: Record<string, any>;
      question_safe_args?: Record<string, any>;
      question_score?: Record<string, any>;
      order?: number;
    };
    relationships?: { quiz: { data: { type: string; id?: string } } };
  };
};

delete/api/v3/quiz/questions/:resource_id

Delete the quiz/questions

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

get/api/v3/quiz/questions/:resource_id

Show a specific quiz/questions

Input Schema

object
resource_id: integer
included?:
array
Elements: string
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  resource_id: number;
  included?: Array<string>;
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
object
type: string
id?: string
attributes?:
object
id?: integer
instruction_md?: string
question_type?: string
question_args?: open struct
question_safe_args?: open struct
question_score?: open struct
order?: integer
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      instruction_md?: string;
      question_type?: string;
      question_args?: Record<string, any>;
      question_safe_args?: Record<string, any>;
      question_score?: Record<string, any>;
      order?: number;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/quiz/questions/:resource_id

Update a quiz/questions

Input Schema

object
resource_id: integer
data:
object
type: string
attributes:
object
id?: integer
instruction_md?: string
question_type?: string
question_args?: open struct
question_safe_args?: open struct
question_score?: open struct
order?: integer

Typescript

type InputSchema = {
  resource_id: number;
  data: {
    type: string;
    attributes: {
      id?: number;
      instruction_md?: string;
      question_type?: string;
      question_args?: Record<string, any>;
      question_safe_args?: Record<string, any>;
      question_score?: Record<string, any>;
      order?: number;
    };
  };
};