Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/gesso/types/params.ts>CreateAnOriginalityReportParams

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

Properties

optional
originalityreportfileid: number

The id of the file being given an originality score. Required if creating a report associated with a file.

optional
originalityreportoriginalityscore: number

A number between 0 and 100 representing the measure of the specified file's originality.

optional
originalityreportoriginalityreporturl: string

The URL where the originality report for the specified file may be found.

optional
originalityreportoriginalityreportfileid: number

The ID of the file within Canvas that contains the originality report for the submitted file provided in the request URL.

optional
originalityreporttoolsettingresourcetypecode: string

The resource type code of the resource handler Canvas should use for the LTI launch for viewing originality reports. If set Canvas will launch to the message with type 'basic-lti-launch-request' in the specified resource handler rather than using the originality_report_url.

optional
originalityreporttoolsettingresourceurl: string

The URL Canvas should launch to when showing an LTI originality report. Note that this value is inferred from the specified resource handler's message “path” value (See resource_type_code) unless it is specified. If this parameter is used a resource_type_code must also be specified.

optional
originalityreportworkflowstate: string

May be set to “pending”, “error”, or “scored”. If an originality score is provided a workflow state of “scored” will be inferred.

optional
originalityreporterrormessage: string

A message describing the error. If set, the “workflow_state” will be set to “error.”

optional
originalityreportattempt: number

If no file_id is given, and no file is required for the assignment (that is, the assignment allows an online text entry), this parameter may be given to clarify which attempt number the report is for (in the case of resubmissions). If this field is omitted and no file_id is given, the report will be created (or updated, if it exists) for the first submission attempt with no associated file.