An Attachment can be associated with an Assignment, Announcement, Page, or Submission. Attachments typically includes supporting info, like files including instructions, or a link to relevant content that might be useful to the assignee.
Attachments are not a model in their own right. When you see the word Attachment referenced throughout the documentation, it is referring to one of the following models:
| Model | Description | Read-only |
|---|---|---|
File | A file uploaded to the source system. | ✅ |
Text | A text body. Can be HTML or plaintext. | |
ExternalLink | A URL to an external resource. | |
ExternalTool | A URL to an external tool (LTI). | |
Discussion | A discussion topic. | ✅ |
Assessment | A quiz or assessment. | ✅ |
Properties
The one property that all attachments have in common is type.
| Property | Type | Description |
|---|---|---|
type | AttachmentType | The type of the attachment (e.g. file). |
Each type of attachment has additional properties that are specific to that type. Click on the type name in the table above to see the additional properties for that type.
Supported Submission Attachment Types Per LMS
The following table lists which attachments are supported by the Edlink API for each supported LMS.
| LMS | Supported Attachment Types (Read) | Supported Attachment Types (Write) |
|---|---|---|
| Blackboard | text | text |
| Brightspace | file (1) | text (1) |
| Canvas | file, link, lti, text | link, lti, text |
link | link | |
| Moodle | text | link (2), text |
| Schoology | link | link (3), text |
- Brightspace will convert the text attachment to a file attachment.
- Link attachments will be converted to Text attachment where the link URL will be interpreted as text.
- Link attachments will be converted to Text attachments if the User API V2 - autofix submission type (Schoology) feature flag is turned on. If the feature flag is turned off the request will throw an error.
Downloadable Attachments
File attachments can be downloaded from the LMS. This includes files that are attached to assignments or submission attempts. Currently, Edlink only supports the downloading of files from Canvas & Schoology.