Instructure Developer Documentation Portal
Community
  • Introduction
  • Services
    • Elevate Standards Alignment - AB Connect API
      • Introduction
        • Authentication
        • Addressing Object Properties
        • Requesting Additional Properties in the Response
        • Filtering Using ODATA Like Statements
        • Sorting
        • Facets
        • Paging Data
        • Call Throttling
        • Working with Related Object
        • Error Responses
        • Character Set Support
        • How To Articles, Recommendations and Suggestions
        • Examples
        • Using AB Connect's Embeddable Widgets
      • Reference
        • Standards
        • Standard Collections
        • Events
        • Topics
        • Concepts
        • Assets
        • Asset Definitions
        • Asset Collections
        • Managing and Predicting Relationships
        • Providers
    • Canvas LMS
      • Basics
        • GraphQL
        • API Change Log
        • SIS IDs
        • Pagination
        • Throttling
        • Compound Documents
        • File Uploads
        • API Endpoint Attributes
        • Masquerading
      • OAuth2
        • OAuth2 Overview
        • OAuth2 Endpoints
        • Developer Keys
      • Resources
        • Access Tokens
        • Account Calendars
        • Account Domain Lookups
        • Account Notifications
        • Account Reports
        • Accounts
        • Accounts (LTI)
        • Admins
        • Analytics
        • Announcement External Feeds
        • Announcements
        • API Token Scopes
        • Appointment Groups
        • Assignment Extensions
        • Assignment Groups
        • Assignments
        • Authentication Providers
        • Authentications Log
        • Blackout Dates
        • BlockEditorTemplate
        • Blueprint Courses
        • Bookmarks
        • Brand Configs
        • Calendar Events
        • Collaborations
        • CommMessages
        • Communication Channels
        • Conferences
        • Content Exports
        • Content Migrations
        • Content Security Policy Settings
        • Content Shares
        • Conversations
        • Course Audit log
        • Course Pace
        • Course Quiz Extensions
        • Course Reports
        • Courses
        • Custom Gradebook Columns
        • Developer Key Account Bindings
        • Developer Keys
        • Discussion Topics
        • Enrollment Terms
        • Enrollments
        • ePortfolios
        • ePub Exports
        • Error Reports
        • External Tools
        • Favorites
        • Feature Flags
        • Files
        • Grade Change Log
        • Gradebook History
        • Grading Period Sets
        • Grading Periods
        • Grading Standards
        • Group Categories
        • Groups
        • History
        • InstAccess tokens
        • JWTs
        • Late Policy
        • Learning Object Dates
        • Line Items
        • LiveAssessments
        • Logins
        • LTI Launch Definitions
        • LTI Registrations
        • LTI Resource Links
        • Media Objects
        • Moderated Grading
        • Modules
        • Names and Role
        • New Quiz Items
        • New Quizzes
        • New Quizzes Accommodations
        • New Quizzes Reports
        • Notification Preferences
        • Originality Reports
        • Outcome Groups
        • Outcome Imports
        • Outcome Results
        • Outcomes
        • Pages
        • Peer Reviews
        • Planner
        • Poll Sessions
        • PollChoices
        • Polls
        • PollSubmissions
        • Proficiency Ratings
        • Progress
        • Public JWK
        • Quiz Assignment Overrides
        • Quiz Extensions
        • Quiz IP Filters
        • Quiz Question Groups
        • Quiz Questions
        • Quiz Reports
        • Quiz Statistics
        • Quiz Submission Events
        • Quiz Submission Files
        • Quiz Submission Questions
        • Quiz Submission User List
        • Quiz Submissions
        • Quizzes
        • Result
        • Roles
        • Rubrics
        • Sandboxes
        • Score
        • Search
        • Sections
        • Services
        • Shared Brand Configs
        • SIS Import Errors
        • SIS Imports
        • SIS Integration
        • Smart Search
        • Submission Comments
        • Submissions
        • Tabs
        • Temporary Enrollment Pairings
        • User Observees
        • Users
        • What If Grades
      • Outcomes
        • Outcomes CSV Format
      • Group Categories
        • Group Categories CSV Format
      • SIS
        • SIS CSV Format
      • External Tools
        • LTI
          • Introduction
          • Registration
          • Launch Overview
          • Configuring
          • Variable Substitutions
          • Deep Linking
          • Grading
          • Provisioning
          • PostMessage
          • Platform Notification Service
          • Placements
            • Placements Overview
            • Navigation
            • Homework Submission
            • Editor Button
            • Migration Selection
            • Link Selection (Modules)
            • Assignment Selection
            • Collaborations
        • xAPI
        • Canvas Roles
        • Plagiarism Detection Platform
          • Overview
          • Plagiarism Detection Platform Assignments
          • Plagiarism Detection Platform Users
          • Plagiarism Detection Submissions
          • Webhooks Subscriptions for Plagiarism Platform
          • JWT Access Tokens
      • Data Services
        • Live Events
          • Overview
            • Introduction
            • Setup
            • Caliper
            • Metadata
          • Event Format
            • Canvas
              • Account
              • Asset
              • Assignment
              • Attachment
              • Content
              • Conversation
              • Course
              • Discussion
              • Enrollment
              • Grade
              • Group
              • Learning
              • Logged
              • Module
              • Outcome
              • Outcomes
              • Plagiarism
              • Quiz
              • Rubric
              • Sis
              • Submission
              • Syllabus
              • User
              • Wiki
            • Caliper IMS 1.1
              • Assessment
              • Basic
              • Forum
              • Grading
              • Navigation Events
              • Session
    • Catalog
      • APIs
        • Analytics
        • Bulk Enrollments
        • Catalogs
        • Certificates
        • Completed Certificates
        • Courses
        • Email Domain Set
        • Enrollments
        • Orders
        • Programs
        • Progresses
        • Tags
        • User Registrations
        • Users
        • Waitlist Applicants
    • Credentials
      • Getting Started
      • Authentication
        • Password-Based Authentication
        • Authorization Code-Based Authentication
      • Pagination
      • APIs
        • Assertions
        • Backpack
        • Badgeclasses
        • Issuers
        • Organizations
        • Users
      • Release Notes
    • Data Access Platform
      • Key Concepts
      • Data Formats
      • Rate Limits & Policies
      • Datasets
        • Namespaces
          • canvas
            • canvas types
          • canvas_logs
          • catalog
        • Additional Notes
        • Entity Relationship Diagram
      • Query API
        • Authentication
        • Reference
      • Command Line (DAP CLI)
        • Getting Started
        • Secure Connection
        • Reference
          • dap snapshot
          • dap incremental
          • dap list
          • dap schema
          • dap initdb
          • dap syncdb
          • dap dropdb
      • Client Library
        • Examples
        • Reference
      • Release Notes
      • Status
    • DataSync
      • Interop API
      • Interop Data API
      • Grades Exchange API
      • OneRoster API
      • Platform API
    • Instructure Media
      • Studio API
    • Quizzes
      • Quiz API
Powered by GitBook

Copyright © 2008-2024 Instructure, Inc. All rights reserved. Various trademarks held by their respective owners.

On this page
  • Create an Originality Report
  • Edit an Originality Report
  • Show an Originality Report
  • Appendixes
  • Appendix: Originality Report UI Locations

Was this helpful?

  1. Services
  2. Canvas LMS
  3. Resources

Originality Reports

PreviousNotification PreferencesNextOutcome Groups

Last updated 1 month ago

Was this helpful?

LTI API for OriginalityReports (Must use with this API).

Originality reports may be used by external tools providing plagiarism detection services to give an originality score to an assignment submission's file. An originality report has an associated file ID (the file submitted by the student) and an originality score between 0 and 100.

Note that when creating or updating an originality report atool_setting[resource_type_code] may be specified as part of the originality report. This parameter should be used if the tool provider wishes to display originality reports as LTI launches.

The value of tool_setting[resource_type_code] should be a resource_handler's "resource_type" code. Canvas will lookup the resource handler specified and do a launch to the message with the type "basic-lti-launch-request" using its "path". If the optionaltool_setting[resource_url] parameter is provided, Canvas will use this URL instead of the message's path but will still send all the parameters specified by the message. When using thetool_setting[resource_url] the tool_setting[resource_type_code] must also be specified.

A ToolSetting object looks like:

{
  // the resource type code of the resource handler to use to display originality
  // reports
  "resource_type_code": "originality_reports",
  // a URL that may be used to override the launch URL inferred by the specified
  // resource_type_code. If used a 'resource_type_code' must also be specified.
  "resource_url": "http://www.test.com/originality_report"
}

An OriginalityReport object looks like:

{
  // The id of the OriginalityReport
  "id": 4,
  // The id of the file receiving the originality score
  "file_id": 8,
  // A number between 0 and 100 representing the originality score
  "originality_score": 0.16,
  // The ID of the file within Canvas containing the originality report document
  // (if provided)
  "originality_report_file_id": 23,
  // A non-LTI launch URL where the originality score of the file may be found.
  "originality_report_url": "http://www.example.com/report",
  // A ToolSetting object containing optional 'resource_type_code' and
  // 'resource_url'
  "tool_setting": null,
  // A message describing the error. If set, the workflow_state will become
  // 'error.'
  "error_report": null,
  // The submitted_at date time of the submission.
  "submission_time": null,
  // The id of the root Account associated with the OriginalityReport
  "root_account_id": 1
}

POST /api/lti/assignments/:assignment_id/submissions/:submission_id/originality_report

Scope: url:POST|/api/lti/assignments/:assignment_id/submissions/:submission_id/originality_report

Create a new OriginalityReport for the specified file

Request Parameters:

Parameter
Type
Description

originality_report[file_id]

integer

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

originality_report[originality_score]

Required number

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

originality_report[originality_report_url]

string

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

originality_report[originality_report_file_id]

integer

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

originality_report[tool_setting][resource_type_code]

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.

originality_report[tool_setting][resource_url]

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.

originality_report[workflow_state]

string

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

originality_report[error_message]

string

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

originality_report[attempt]

integer

If no ‘file_idis 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 nofile_id` is given, the report will be created (or updated, if it exists) for the first submission attempt with no associated file.

PUT /api/lti/assignments/:assignment_id/submissions/:submission_id/originality_report/:id

Scope: url:PUT|/api/lti/assignments/:assignment_id/submissions/:submission_id/originality_report/:id

PUT /api/lti/assignments/:assignment_id/files/:file_id/originality_report

Scope: url:PUT|/api/lti/assignments/:assignment_id/files/:file_id/originality_report

Modify an existing originality report. An alternative to this endpoint is to POST the same parameters listed below to the CREATE endpoint.

Request Parameters:

Parameter
Type
Description

originality_report[originality_score]

number

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

originality_report[originality_report_url]

string

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

originality_report[originality_report_file_id]

integer

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

originality_report[tool_setting][resource_type_code]

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.

originality_report[tool_setting][resource_url]

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.

originality_report[workflow_state]

string

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

originality_report[error_message]

string

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

GET /api/lti/assignments/:assignment_id/submissions/:submission_id/originality_report/:id

Scope: url:GET|/api/lti/assignments/:assignment_id/submissions/:submission_id/originality_report/:id

GET /api/lti/assignments/:assignment_id/files/:file_id/originality_report

Scope: url:GET|/api/lti/assignments/:assignment_id/files/:file_id/originality_report

Get a single originality report

Appendixes

Appendix: Originality Report UI Locations


Returns an object.

Returns an object.

Returns an object.

This documentation is generated directly from the Canvas LMS source code, available .

JWT access tokens
Lti::OriginalityReportsApiController#create
Lti::OriginalityReportsApiController#update
Lti::OriginalityReportsApiController#show
on Github
Create an Originality Report
OriginalityReport
Edit an Originality Report
OriginalityReport
Show an Originality Report
OriginalityReport