Resources are a metadata "wrapper" that sits in between a piece of content (e.g. an Assignment, a Page, or a File) and a Module.
Resources can be thought of as a "relation table" between content and modules.
They exist for a few reasons:
- Some LMSs provide learning pathways so that certain pieces of content are unlocked when certain milestones are hit.
- Sometimes teachers want to include the same content item in multiple modules.
Resources cannot be created or deleted directly at the current time. They are created automatically as a byproduct of creating an Assignment or Page or File and adding it to a Module by specifying a module_id in the request body.
If you learn better by example: here is an example of using resources to list all the content related to a class.
You can List Resources using either the Graph API or the User API, both underneath our Modules section.
Additional Notes
- Not all LMSs support resources. To address these differences, Edlink may create "simulated" resources for API consistency.
- In the future, resources may be created and deleted directly via the API. This would theoretically allow your application to add an existing content item to an existing module.
Properties
| Property | Type | Description |
|---|---|---|
id | string | The UUID for the resource. |
created_date | Date | When the resource was created in the data source. Might not be present. |
updated_date | Date | When the resource was last updated in the data source. Might not be present. |
properties | object | Non-standard properties that may be of interest to the developer. |
module_id | string | The UUID of the associated Module. |
type | string | The type of the associated content item (assignment, page, module, custom, or file). |
target_id | string | The UUID of the associated content item. No UUID is returned for custom resources. |
Supported Providers
| Provider | Support |
|---|---|
| brightspace | list |
| canvas | list |
| list | |
| schoology | list |