educationAssignment 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 a task or unit of work assigned to a student or team member in a class as part of their study.

Only teachers or team owners can create assignments. Assignments contain handouts and tasks that the teacher wants the student to work on. Each student assignment has an associated submission that contains any work their teacher asked to be turned in. A teacher can add scores and feedback to the submission turned in by the student.

When an assignment is created, it is in a Draft state. Students can't see the assignment and submissions won't be created. You can change the status of an assignment by using the publish action. You can't use a PATCH request to change the assignment status.

The assignment APIs are exposed in the class namespace.

Inherits from entity.

Methods

Method Return Type Description
Create assignment resource educationAssignmentResource Create a new educationAssignmentResource by posting to the resources collection.
Get assignment educationAssignment Read properties and relationships of an educationAssignment object.
Update educationAssignment Update an educationAssignment object.
Delete None Delete an educationAssignment object.
Publish educationAssignment Change the state of an educationAssignment object from draft to published.
Set up assignment resources folder string Create a SharePoint folder (under pre-defined location) to upload files as assignment resources.
Set up assignment feedback resources folder educationAssignment Create a SharePoint folder to upload feedback files for a given educationSubmission.
List resources educationAssignmentResource collection Get an educationAssignmentResource object collection.
List submissions educationSubmission collection Get an educationSubmission object collection.
List categories educationCategory collection Get an educationCategory object collection.
Add categories educationCategory Assign an educationCategory belonging to the class to this assignment.
Remove category None Remove an educationCategory belonging to the class from this assignment.
Attach rubric None Attach an existing educationRubric to this assignment.
Remove rubric None Detach the educationRubric from this assignment.
Get delta educationAssignment collection Get a list of newly created or updated assignments without having to perform a full read of the collection.

Properties

Property Type Description
addedStudentAction String Optional field to control the assignment behavior for students who are added after the assignment is published. If not specified, defaults to none. Supported values are: none, assignIfOpen. For example, a teacher can use assignIfOpen to indicate that an assignment should be assigned to any new student who joins the class while the assignment is still open, and none to indicate that an assignment should not be assigned to new students.
addToCalendarAction educationAddToCalendarOptions Optional field to control the assignment behavior for adding assignments to students' and teachers' calendars when the assignment is published. The possible values are: none, studentsAndPublisher, studentsAndTeamOwners, unknownFutureValue, and studentsOnly. Note that you must use the Prefer: include-unknown-enum-members request header to get the following value(s) in this evolvable enum: studentsOnly. The default value is none.
allowLateSubmissions Boolean Identifies whether students can submit after the due date. If this property is not specified during create, it defaults to true.
allowStudentsToAddResourcesToSubmission Boolean Identifies whether students can add their own resources to a submission or if they can only modify resources added by the teacher.
assignDateTime DateTimeOffset The date when the assignment should become active. If in the future, the assignment is not shown to the student until this date. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
assignTo educationAssignmentRecipient Which users, or whole class should receive a submission object once the assignment is published.
assignedDateTime DateTimeOffset The moment that the assignment was published to students and the assignment shows up on the students timeline. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
classId String Class which this assignment belongs.
closeDateTime DateTimeOffset Date when the assignment will be closed for submissions. This is an optional field that can be null if the assignment does not allowLateSubmissions or when the closeDateTime is the same as the dueDateTime. But if specified, then the closeDateTime must be greater than or equal to the dueDateTime. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
createdBy identitySet Who created the assignment.
createdDateTime DateTimeOffset Moment when the assignment was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
displayName String Name of the assignment.
dueDateTime DateTimeOffset Date when the students assignment is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
feedbackResourcesFolderUrl String Folder URL where all the feedback file resources for this assignment are stored.
grading educationAssignmentGradeType How the assignment will be graded.
id String The unique identifier for the assignment. Inherited from entity. Read-only.
instructions itemBody Instructions for the assignment. This along with the display name tell the student what to do.
lastModifiedBy identitySet Who last modified the assignment.
lastModifiedDateTime DateTimeOffset Moment when the assignment was last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
notificationChannelUrl String Optional field to specify the URL of the channel to post the assignment publish notification. If not specified or null, defaults to the General channel. This field only applies to assignments where the assignTo value is educationAssignmentClassRecipient. Updating the notificationChannelUrl is not allowed after the assignment has been published.
status string Status of the Assignment. You can not PATCH this value. Possible values are: draft, scheduled, published, assigned.
webUrl string The deep link URL for the given assignment.
resourcesFolderUrl string Folder URL where all the file resources for this assignment are stored.

Relationships

Relationship Type Description
resources educationAssignmentResource collection Learning objects that are associated with this assignment. Only teachers can modify this list. Nullable.
submissions educationSubmission collection Once published, there is a submission object for each student representing their work and grade. Read-only. Nullable.
categories educationCategory collection When set, enables users to easily find assignments of a given type. Read-only. Nullable.
rubric educationRubric When set, the grading rubric attached to this assignment.

JSON representation

The following is a JSON representation of the resource.

{
  "addedStudentAction": "String",
  "addToCalendarAction": "String",
  "allowLateSubmissions": "Boolean",
  "allowStudentsToAddResourcesToSubmission": "Boolean",
  "assignDateTime": "String (timestamp)",
  "assignTo": {"@odata.type": "microsoft.graph.educationAssignmentRecipient"},
  "assignedDateTime": "String (timestamp)",
  "classId": "String",
  "closeDateTime": "String (timestamp)",
  "createdBy": {"@odata.type": "microsoft.graph.identitySet"},
  "createdDateTime": "String (timestamp)",
  "displayName": "String",
  "dueDateTime": "String (timestamp)",
  "feedbackResourcesFolderUrl": "String",
  "grading": {"@odata.type": "microsoft.graph.educationAssignmentGradeType"},
  "id": "String (identifier)",
  "instructions": {"@odata.type": "microsoft.graph.itemBody"},
  "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
  "lastModifiedDateTime": "String (timestamp)",
  "notificationChannelUrl": "String",
  "status": "String",
  "webUrl": "String",
  "resourcesFolderUrl": "String"
}