Canvas LMSInstall

Overview

This node interacts with the Canvas LMS API to retrieve detailed information about a specific assignment within a course. The "Get Assignment" operation fetches data for one assignment identified by its unique ID and the course it belongs to.

Typical use cases include:

• Fetching assignment details to display or process in workflows.
• Integrating Canvas assignment data into other systems like gradebooks or reporting tools.
• Automating notifications or actions based on assignment properties.

For example, you might use this node to get the due date and description of an assignment to send reminders to students or to sync assignment info with another platform.

Properties

Output

The node outputs a JSON object under the data field containing the full details of the requested assignment as returned by the Canvas LMS API. This includes all standard assignment properties such as name, description, points possible, due date, and any other metadata provided by Canvas.

Example output structure (simplified):

{
  "data": {
    "id": 123,
    "name": "Assignment Title",
    "description": "Detailed description of the assignment",
    "points_possible": 100,
    "due_at": "2024-12-31T23:59:00Z",
    ...
  }
}

No binary data is produced by this operation.

Dependencies

• Requires an API key credential for authenticating with the Canvas LMS API.
• The node must be configured with valid Canvas API credentials including the base URL and access token.
• Network connectivity to the Canvas LMS instance is necessary.

Troubleshooting

• Common issues:

  • Invalid or missing Course ID or Assignment ID parameters will cause errors.
  • Authentication failures if the API key or token is invalid or expired.
  • Network errors if the Canvas API endpoint is unreachable.

• Error messages:

  • "Error in "assignment" operation "get": ..." indicates a problem during the API request; check parameter values and credentials.
  • API rate limits or permission errors may also occur depending on the Canvas account settings.

• Resolutions:

  • Verify that the Course ID and Assignment ID are correct and exist in Canvas.
  • Ensure the API key credential has sufficient permissions to read assignments.
  • Check network connectivity and Canvas API status.

Links and References

• Canvas LMS API Documentation - Assignments
• Canvas LMS Developer Key Setup