educationModule 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.
A module is associated with a class. Represents a group of individual learning resources that are organized in a systematic way.
Only teachers or team owners can create modules. Modules contain read-only learning resources and assignments the teacher wants the student to complete.
When a module is created, it's in a draft state. Students can't see the module until it's published. You can change the status of a module by using the publish action. You can't use a PATCH request to change the module status.
Inherits from entity.
Methods
| Method | Return Type | Description |
|---|---|---|
| List modules | educationModule collection | Get an educationModule object collection. |
| Create module | educationModule | Create an educationModule object. |
| Get module | educationModule | Read properties and relationships of an educationModule object. |
| Update module | educationModule | Update an educationModule object. |
| Delete module | None | Delete an educationModule object. |
| Pin module | educationModule | Pin an educationModule object. |
| Unpin module | educationModule | Unpin an educationModule object. |
| Publish module | educationModule | Change the state of an educationModule object from draft to published. |
| Set up module resources folder | educationModule | Create a SharePoint folder (under a predefined location) to upload files as module resources. |
Properties
| Property | Type | Description |
|---|---|---|
| createdBy | identitySet | The display name of the user that created the module. |
| createdDateTime | DateTimeOffset | Date time the module was created. 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 |
| description | String | Description of the module. |
| displayName | String | Name of the module. |
| id | String | The unique identifier for the module. Inherited from entity. Read-only. |
| isPinned | Boolean | Indicates whether the module is pinned or not. |
| lastModifiedBy | identitySet | The last user that modified the module. |
| lastModifiedDateTime | DateTimeOffset | Date time the module was last modified. 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 |
| resourcesFolderUrl | string | Folder URL where all the file resources for this module are stored. |
| status | string | Status of the module. You can't use a PATCH operation to update this value. Possible values are: draft and published. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| resources | educationModuleResource collection | Learning objects that are associated with this module. Only teachers can modify this list. Nullable. |
JSON representation
The following JSON representation shows the resource type.
{
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"description": "String",
"displayName": "String",
"id": "String (identifier)",
"isPinned": "Boolean",
"lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
"lastModifiedDateTime": "String (timestamp)",
"resourcesFolderUrl": "String",
"status": "String"
}