For Developers

Resources Overview

Resources are a metadata "wrapper" that sits in between a piece of content (e.g. an Assignment or a Page) 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 and adding it to a Module by specifying a module_id in the request body.

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

PropertyTypeDescription
idstringThe UUID for the resource.
created_dateDateWhen the resource was created in the data source.
updated_dateDateWhen the resource was last updated in the data source.
propertiesobjectNon-standard properties that may be of interest to the developer.
module_idstringThe UUID of the associated Module.
typestringThe type of the associated content item (e.g. assignment, page, module, custom, file).
target_idstringThe UUID of the associated content item. No UUID is returned for custom resources.

Supported Providers

ProviderSupport