Connect to your Canvas instance.

CanvasReader Properties

  • accessToken (Env First): The access token for Canvas can be created under User Profile > Web services in your canvas account.
  • path (Inline Only): The route to the REST API resource.
  • rootUrl (Env First): The root url of the REST API.
  • pageSize (Inline Only): The page size to return data from Canvas. All pages will be unioned automatically. 100 is the max value.
Example with Environment Credentials
-
    name: myConnectorName
    type: CanvasReader
    properties:
      path:  /api/courses 
      pageSize:  100  # optional 
    #schemaRef: schemaName # optional from "schemas:"
Example with Inline Credentials
-
    name: myConnectorName
    type: CanvasReader
    properties:
      accessToken: xxxx 
      path: /api/courses 
      rootUrl: https://... 
      pageSize: 100  # optional 
    #schemaRef: schemaName # optional from "schemas:"

CanvasWriter Properties

  • accessToken (Env First): The access token for Canvas can be created under User Profile > Web services in your canvas account.
  • path (Inline Only): The route to the REST API resource.
  • rootUrl (Env First): The root url of the REST API.
  • pageSize (Inline Only): The page size to return data from Canvas. All pages will be unioned automatically. 100 is the max value.
Example with Environment Credentials
-
    name: myConnectorName
    type: CanvasWriter
    properties:
      path:  /api/courses 
      pageSize:  100  # optional 

Example with Inline Credentials
-
    name: myConnectorName
    type: CanvasWriter
    properties:
      accessToken:  xxxx 
      path:  /api/courses 
      rootUrl:  https://... 
      pageSize:  100  # optional