educationSubmission resource type
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents the resources that an individual (or group) turn in for an assignment and the outcomes (such as grades or feedback) that are associated with the submission.
Submissions are owned by an assignment. Submissions are automatically created when an assignment is published. The submission owns two lists of resources. Resources represent the user/groups working area while the submitted resources represent the resources that have actively been turned in by students.
The status property is read-only and the object is moved through the workflow via actions.
If setUpResourcesFolder hasn't been called on an educationSubmission resource, the resourcesFolderUrl property is null.
Methods
| Method | Return Type | Description |
|---|---|---|
| Get submission | educationSubmission | Read properties and relationships of an educationSubmission object. |
| List submission resources | educationSubmissionResource collection | Get an educationSubmissionResource object collection. |
| List submitted resources | educationSubmissionResource collection | Get an educationSubmissionResource object collection. |
| List outcomes | educationOutcome collection | Get an educationOutcome object collection. |
| Excuse submission | educationSubmission | Indicates that the submission has no further action for the student and isn't included in average grade calculations. |
| Return submission | educationSubmission | A teacher uses return to indicate that the grades/feedback can be shown to the student. |
| Reassign submission | educationSubmission | Reassign the submission to the student with feedback for review. |
| Set up submission resources folder | educationSubmission | Create a SharePoint folder (under a predefined location) to upload files as submission resources. |
| Submit submission | educationSubmission | A student uses submit to turn in the assignment. This operation copies the resources into the submittedResources folder for grading and updates the status. |
| Unsubmit submission | educationSubmission | A student uses the unsubmit to move the state of the submission from submitted back to working. This operation copies the resources into the workingResources folder for grading and updates the status. |
Properties
| Property | Type | Description |
|---|---|---|
| assignmentId | String | The unique identifier for the assignment with which this submission is associated. A submission is always associated with one and only one assignment. |
| excusedBy | identitySet | The user that marked the submission as excused. |
| excusedDateTime | DateTimeOffset | Moment in time when the submission was moved to the excused state. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| id | String | Unique identifier for the submission. |
| lastModifiedBy | identitySet | The identities of those who modified the submission. |
| lastModifiedDateTime | DateTimeOffset | The date and time the submission was modified. |
| reassignedBy | identitySet | User who moved the status of this submission to reassigned. |
| reassignedDateTime | DateTimeOffset | Moment in time when the submission was reassigned. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| recipient | educationSubmissionRecipient | Who this submission is assigned to. |
| resourcesFolderUrl | String | Folder where all file resources for this submission need to be stored. |
| returnedBy | identitySet | User who moved the status of this submission to returned. |
| returnedDateTime | DateTimeOffset | Moment in time when the submission was returned. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| status | educationSubmissionStatus | Read-only. Possible values are: working, submitted, returned, unknownFutureValue, reassigned, and excused. You must use the Prefer: include-unknown-enum-members request header to get the following values in this evolvable enum: reassigned, and excused. |
| submittedBy | identitySet | User who moved the resource into the submitted state. |
| submittedDateTime | DateTimeOffset | Moment in time when the submission was moved into the submitted state. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| unsubmittedBy | identitySet | User who moved the resource from submitted into the working state. |
| unsubmittedDateTime | DateTimeOffset | Moment in time when the submission was moved from submitted into the working state. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| webUrl | String | The deep link URL for the given submission. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| outcomes | educationOutcome collection. Holds grades, feedback and/or rubrics information the teacher assigns to this submission | Read-Write. Nullable. |
| resources | educationSubmissionResource collection | Nullable. |
| submittedResources | educationSubmissionResource collection | Read-only. Nullable. |
JSON representation
The following JSON representation shows the resource type.
{
"excusedBy": {"@odata.type":"microsoft.graph.identitySet"},
"excusedDateTime": "String (timestamp)",
"id": "String (identifier)",
"reassignedBy": {"@odata.type":"microsoft.graph.identitySet"},
"reassignedDateTime": "String (timestamp)",
"recipient": {"@odata.type":"microsoft.graph.educationSubmissionRecipient"},
"resourcesFolderUrl": "String",
"returnedBy": {"@odata.type":"microsoft.graph.identitySet"},
"returnedDateTime": "String (timestamp)",
"status": "String",
"submittedBy": {"@odata.type":"microsoft.graph.identitySet"},
"submittedDateTime": "String (timestamp)",
"unsubmittedBy": {"@odata.type":"microsoft.graph.identitySet"},
"unsubmittedDateTime": "String (timestamp)",
"webUrl": "String"
}