Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/gesso/types/params.ts>GetOutcomeResultsParams

A TypeScript API client for Canvas LMS
Latest
interface GetOutcomeResultsParams
import { type GetOutcomeResultsParams } from "https://deno.land/x/gesso@v0.1.2/types/params.ts";

Properties

optional
user_ids: number[]

If specified, only the users whose ids are given will be included in the results. SIS ids can be used, prefixed by “sis_user_id:”. It is an error to specify an id for a user who is not a student in the context.

optional
outcome_ids: number[]

If specified, only the outcomes whose ids are given will be included in the results. it is an error to specify an id for an outcome which is not linked to the context.

optional
include: string[]

String, “alignments”|“outcomes”|“outcomes.alignments”|“outcome_groups”|“outcome_ links”|“outcome_paths”|“users” Specify additional collections to be side loaded with the result. “alignments” includes only the alignments referenced by the returned results. “outcomes.alignments” includes all alignments referenced by outcomes in the context.

optional
includehidden: boolean

If true, results that are hidden from the learning mastery gradebook and student rollup scores will be included