Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 2.18 KB

SubmissionBase.md

File metadata and controls

50 lines (34 loc) · 2.18 KB

SubmissionBase

A Submission is the base object on which other services (such as similarity) are offered. In order to use other services a Submission must first be created and successfully process, then other service objects can be created.

Properties

Name Type Description Notes
id Object Submission id, optional field [optional]
owner String ID of the owning user [optional]
ownerDefaultPermissionSet OwnerDefaultPermissionSetEnum Default viewer permission set, accepts INSTRUCTOR, LEARNER, EDITOR, USER, APPLICANT, ADMINISTRATOR, UNDEFINED [optional]
title String the title of the submission [optional]
submitter String (optional) ID of the submitting user, if different from the owning user [optional]
submitterDefaultPermissionSet SubmitterDefaultPermissionSetEnum Default submitter permission set, accepts INSTRUCTOR, LEARNER, EDITOR, USER, APPLICANT, ADMINISTRATOR, UNDEFINED [optional]
eula Eula [optional]
metadata SubmissionBaseMetadata [optional]
extractTextOnly Boolean (optional) indicates if the submission should be treated as a text only submission. A text only submission cannot generate full reports or be viewed in the viewer, but can use the index only endpoint to be indexed [optional]

Enum: OwnerDefaultPermissionSetEnum

Name Value
INSTRUCTOR "INSTRUCTOR"
LEARNER "LEARNER"
EDITOR "EDITOR"
USER "USER"
APPLICANT "APPLICANT"
ADMINISTRATOR "ADMINISTRATOR"
UNDEFINED "UNDEFINED"

Enum: SubmitterDefaultPermissionSetEnum

Name Value
INSTRUCTOR "INSTRUCTOR"
LEARNER "LEARNER"
EDITOR "EDITOR"
USER "USER"
APPLICANT "APPLICANT"
ADMINISTRATOR "ADMINISTRATOR"
UNDEFINED "UNDEFINED"