Overview
Configuration is provided for establishing connections with the Canvas LMS service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to Canvas LMS REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select Canvas LMS and set instance to the desired instance in the server host parameter.
Step 3. There are two types of Authentications defined Token and OAuth from which you can choose the Authentication type of your choice.
Step 4. For Token Authentication provide Token value for the parameter Token in the grid below. For more information regarding how to generate the Access Token visit https://community.canvaslms.com/t5/Admin-Guide/How-do-I-manage-API-access-tokens-as-an-admin/ta-p/89
Step 5. For OAuth Authentication in the grid below click to the right of Token File field so the new button appears. Then click on the new button to initiate the token generation process. Proceeds with the steps mention here at https://desk.cozyroc.com/portal/en/kb/articles/how-to-get-a-new-rest-token
Step 6. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Canvas LMS instance.
In this guide, we will show how to read data from the Canvas LMS service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select Canvas LMS connection from the combo. Select from available Canvas LMS resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select Canvas LMS resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Canvas LMS service.
In this guide, we will show how to write data to the Canvas LMS service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Canvas LMS connection from the combo. Also, select resource action and Canvas LMS resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Canvas LMS resource.
Configuration
Base URL address: https://[instance].instructure.com/api/v1.
- OAuth
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- client_id: Required. Specify application client id.
- client_secret: Required. Specify application client secret.
- redirect_uri: Required. Specify redirect uri which was provided during APP Registeration.
- scope: Optional. Specify scopes to access specific information.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://canvas.instructure.com/doc/api/file.oauth_endpoints.html#get-login-oauth2-auth.
- Token
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Token:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=connection.user.Token}}
Documentation: https://community.canvaslms.com/t5/Admin-Guide/How-do-I-make-API-calls-in-an-account-with-an-access-token/ta-p/175.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/accounts/search.Documentation: https://canvas.instructure.com/doc/api/all_resources.html#method.account_domain_lookups.search.
- name
Template: ShortText.
- domain
Template: ShortText.
- distance
Template: ShortText.
- authentication_provider
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/accounts.Documentation: https://canvas.instructure.com/doc/api/accounts.html.
- [Read single] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/accounts.html#method.accounts.show.
- [Read course admin] action
-
Endpoint URL address:
/course_accounts.
The result is paginated.Documentation: https://canvas.instructure.com/doc/api/accounts.html#method.accounts.course_accounts.
- [Read manageable] action
-
Endpoint URL address:
/manageable_accounts.Documentation: https://canvas.instructure.com/doc/api/accounts.html#method.accounts.manageable_accounts.
- [Read sub-account] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/sub_accounts.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/accounts.html#method.accounts.sub_accounts.
- [Read LTI] action
-
Endpoint URL address:
{{=Canvas.getLTIBase()}}/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/accounts_(lti).html#method.lti/account_lookup.show.
- [Read mcc] action
-
Endpoint URL address:
/manually_created_courses_account.
The result is extracted from:{{=[response]}}.
The result is paginated.Documentation: https://canvas.instructure.com/doc/api/accounts.html#method.accounts.manually_created_courses_account.
- [Update] action
-
Endpoint URL address:
/accounts/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/accounts.html#method.accounts.update.
The resource includes the fields from the accountT template.
- registeration_settings
Field components:
-
Uses template:
ShortText. - Contains the following components: usage_rights_required, lock_all_announcements, restrict_student_past_view, id, terms_type, passive, account_id, self_registration_type, content.
-
Uses template:
- active_courses
The gathered value is processed with
{{=connection.resourceManager['Course'].getData({ endpoint: 'account', parameters: ['account_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
courseT.
- help_links
The value is gathered from
/accounts/{{=item.id}}/help_linksaddress. Field components:- An array.
- Contains the following components: help_link_name, help_link_icon, custom_help_links, default_help_links.
- sub_accounts
The value is gathered from
/accounts/{{=item.id}}/sub_accountsaddress. Field components:- An array.
-
Uses template:
accountT.
- users
The value is gathered from
/accounts/{{=item.id}}/usersaddress. Field components:- An array.
-
Uses template:
userT.
- permissions
The value is gathered from
/accounts/{{=item.id}}/permissionsaddress. The gathered value is processed with{{=_.map( response, function(v, k) { return { name: k, value: v }; } )}}expression. Field components:- An array.
- Contains the following components: name, value.
- terms
The value is gathered from
/accounts/{{=item.id}}/termsaddress. Field components:- An array.
- analytics
A read-only field. Field components:
-
Uses template:
AccountActivityT. - Contains the following components: current_activity, completed_activity, current_statistics, completed_statistics, current_statistics_by_subaccount, completed_statistics_by_subaccount.
-
Uses template:
- sso_settings
The value is gathered from
/accounts/{{=item.id}}/sso_settingsaddress. The gathered value is processed with{{=response[field.name}}expression. The value is sent to/accounts/{{=item.id}}/sso_settingsaddress. Field components:-
Uses template:
ShortText. - Contains the following components: login_handle_name, change_password_url, auth_discovery_url, unknown_user_url.
-
Uses template:
- outcome_groups
The value is gathered from
/accounts/{{=item.id}}/outcome_groupsaddress. Field components:- An array.
-
Uses template:
OutcomeGroupT.
- outcome_links
The value is gathered from
/accounts/{{=item.id}}/outcome_group_linksaddress. Field components:- An array.
-
Uses template:
OutcomeLinkT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/account_notifications.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/account_notifications.html#method.account_notifications.user_index.
- [Read single] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/account_notifications{{=parameters.id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
- id: Required. Specify account notification identifier.
Documentation: https://canvas.instructure.com/doc/api/account_notifications.html#method.account_notifications.show.
- [Create] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/account_notifications.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/account_notifications.html#method.account_notifications.create.
- [Update] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/account_notifications/{{=item.id}}.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/account_notifications.html#method.account_notifications.update.
- [Delete] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/account_notifications/{{=item.id}}.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/account_notifications.html#method.account_notifications.user_close_notification.
- id
A key field. Data type: DT_I4
- subject
Template: ShortText.
- message
Template: ShortText.
- start_at
Template: DateTime.
- end_at
Template: DateTime.
- icon
Template: ShortText.
- roles
Template: LongText. A composite field.
- role_ids
Template: LongText. A composite field.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/reports.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/account_reports.html#method.account_reports.available_reports.
- [Read type] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/reports/{{=parameters.report_type}}.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
- report_type: Required. Specify report type.
Documentation: https://canvas.instructure.com/doc/api/account_reports.html#method.account_reports.index.
- [Read status] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/reports{{=parameters.report_id}}.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
- report_id: Required. Specify account notification identifier.
Documentation: https://canvas.instructure.com/doc/api/account_reports.html#method.account_reports.show.
- [Create] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/account_notifications.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://canvas.instructure.com/doc/api/account_notifications.html#method.account_notifications.create.
- [Update] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/account_notifications/{{=item.id}}.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/account_notifications.html#method.account_notifications.update.
- [Delete] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/account_notifications/{{=item.id}}.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/account_notifications.html#method.account_notifications.user_close_notification.
- id
A key field. Data type: DT_I4
- report
Template: ShortText.
- file_url
Template: ShortText.
- attachment
Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- started_at
Template: DateTime. A read-only field.
- ended_at
Template: DateTime.
- parameters
Field components:
-
Uses template:
ShortText. - Contains the following components: enrollment_term_id, include_deleted, course_id, order, users, accounts, terms, courses, sections, enrollments, groups, xlist, sis_terms_csv, sis_accounts_csv, include_enrollment_state, enrollment_state, start_at, end_at.
-
Uses template:
- progress
Data type: DT_I4
- current_line
Data type: DT_I4
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/{{=parameters.context_type}}/{{=parameters.context_id}}/blackout_dates.The action has the following user-defined parameters:
- context_type: Required. Specify the desired context you want to read e.g(accounts or courses).
- context_id: Required. Specify selected course or account identifier.
Documentation: https://canvas.instructure.com/doc/api/account_reports.html#method.account_reports.available_reports.
- [Read single] action
-
Endpoint URL address:
/{{=parameters.context_type}}/{{=parameters.context_id}}/blackout_dates/{{=parameters.blackout_date_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- context_type: Required. Specify the desired context you want to read e.g(accounts or courses).
- context_id: Required. Specify selected course or account identifier.
- blackout_date_id: Required. Specify black-out-date identifier.
Documentation: https://canvas.instructure.com/doc/api/account_reports.html#method.account_reports.index.
- [Read new] action
-
Endpoint URL address:
/{{=parameters.context_type}}/{{=parameters.context_id}}/blackout_dates/new.The action has the following user-defined parameters:
- context_type: Required. Specify the desired context you want to read e.g(accounts or courses).
- context_id: Required. Specify selected course or account identifier.
Documentation: https://canvas.instructure.com/doc/api/blackout_dates.html#method.blackout_dates.new.
- [Create] action
-
Endpoint URL address:
/{{=item.context_type}}/{{=item.context_id}}/blackout_dates.Documentation: https://canvas.instructure.com/doc/api/blackout_dates.html#method.blackout_dates.create.
- [Update] action
-
Endpoint URL address:
/{{=item.context_type}}/{{=item.context_id}}/blackout_dates/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/blackout_dates.html#method.blackout_dates.update.
- [Delete] action
-
Endpoint URL address:
/{{=item.context_type}}/{{=item.context_id}}/blackout_dates/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/blackout_dates.html#method.blackout_dates.destroy.
- id
A key field. Data type: DT_I4
- context_id
Data type: DT_I4
- context_type
Template: ShortText.
- start_date
Template: DateTime.
- end_date
Template: DateTime.
- event_title
Template: ShortText.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/blueprint_templates/default.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/blueprint_courses.html#method.master_courses/master_templates.show.
- [Read single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/blueprint_templates/{{=parameters.template_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- template_id: Required. Specify template identifier.
Documentation: https://canvas.instructure.com/doc/api/account_reports.html#method.account_reports.index.
- id
Data type: DT_I4 A read-only field.
- course_id
Data type: DT_I4
- last_export_completed_at
Template: DateTime.
- associated_course_count
Data type: DT_I4
- latest_migration
Template: ShortText.
- associated_courses
The value is gathered from
/courses/{{=item.course_id}}/blueprint_templates/{{=item.id}}/associated_coursesaddress. Field components:- An array.
-
Uses template:
courseT.
- migrations
The value is gathered from
/courses/{{=item.course_id}}/blueprint_templates/{{=item.id}}/migrationsaddress. Field components:- An array.
-
Uses template:
bluePrintGeneralT.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/blueprint_subscriptions.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/blueprint_courses.html#method.master_courses/master_templates.subscriptions_index.
- id
A key field. Data type: DT_I4
- template_id
Data type: DT_I4
- blueprint_course
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, course_code, term_name.
-
Uses template:
- migrations
The value is gathered from
/courses/{{=item.blueprint_course.id}}/blueprint_subscriptions/{{=item.id}}/migrationsaddress. Field components:- An array.
-
Uses template:
bluePrintGeneralT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/admins.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/admins.html#method.admins.index.
- [Create] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/admins.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://canvas.instructure.com/doc/api/admins.html#method.admins.create.
- [Delete] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/admins/{{=item.id}}.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/admins.html#method.admins.destroy.
The resource includes the fields from the accountT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/announcements.Documentation: https://canvas.instructure.com/doc/api/announcements.html#method.announcements_api.index.
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- last_reply_at
Template: DateTime.
- created_at
Template: DateTime. A read-only field.
- delayed_post_at
Template: DateTime.
- posted_at
Template: DateTime.
- assignment_id
Data type: DT_I4
- root_topic_id
Data type: DT_I4
- position
Data type: DT_I4
- podcast_has_student_posts
Data type: DT_BOOL
- discussion_type
Template: ShortText.
- lock_at
Template: DateTime.
- allow_rating
Data type: DT_BOOL
- only_graders_can_rate
Data type: DT_BOOL
- sort_by_rating
Data type: DT_BOOL
- is_section_specific
Data type: DT_BOOL
- anonymous_state
Template: ShortText.
- user_name
Template: ShortText.
- discussion_subentry_count
Data type: DT_I4
- permissions
Template: permissionT.
- require_initial_post
Data type: DT_BOOL
- user_can_see_posts
Data type: DT_BOOL
- podcast_url
Template: ShortText.
- podcast_content
Data type: DT_IMAGE The value is gathered from
{{=item.podcast_url}}address.- read_state
Template: ShortText.
- unread_count
Data type: DT_I4
- subscribed
Data type: DT_BOOL
- attachments
Field components:
- An array.
-
Uses template:
attachmentT.
- published
Data type: DT_BOOL
- can_unpublish
Data type: DT_BOOL
- locked
Data type: DT_BOOL
- can_lock
Data type: DT_BOOL
- comments_disabled
Data type: DT_BOOL
- author
Template: AuthorT.
- html_url
Template: ShortText.
- url
Template: ShortText.
- pinned
Data type: DT_BOOL
- group_category_id
Data type: DT_I4
- can_group
Data type: DT_BOOL
- topic_children
Template: LongText. A composite field.
- group_topic_children
Field components:
- An array.
- Contains the following components: id, group_id.
- context_code
Template: ShortText.
- locked_for_user
Data type: DT_BOOL
- message
Template: ShortText.
- subscription_hold
Template: ShortText.
- todo_date
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/external_feeds.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/admins.html#method.admins.index.
- [Create] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/external_feeds.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://canvas.instructure.com/doc/api/announcement_external_feeds.html#method.external_feeds.create.
- [Delete] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/external_feeds/{{=item.id}}.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/announcement_external_feeds.html#method.external_feeds.destroy.
The resource includes the fields from the ExternalFeedT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groups/{{=parameters.group_id}}/external_feeds.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
Documentation: https://canvas.instructure.com/doc/api/admins.html#method.admins.index.
- [Create] action
-
Endpoint URL address:
/groups/{{=parameters.group_id}}/external_feeds.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://canvas.instructure.com/doc/api/announcement_external_feeds.html#method.external_feeds.create.
- [Delete] action
-
Endpoint URL address:
/groups/{{=parameters.group_id}}/external_feeds/{{=item.id}}.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
Documentation: https://canvas.instructure.com/doc/api/announcement_external_feeds.html#method.external_feeds.destroy.
The resource includes the fields from the ExternalFeedT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/appointment_groups.Documentation: https://canvas.instructure.com/doc/api/appointment_groups.html#method.appointment_groups.index.
- [Read single] action
-
Endpoint URL address:
/appointment_groups/{{=Canvas.UI.AppointmentGroupEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Specify appointment group identifier.
Documentation: https://canvas.instructure.com/doc/api/appointment_groups.html#method.appointment_groups.show.
- [Create] action
-
Endpoint URL address:
/appointment_groups.Documentation: https://canvas.instructure.com/doc/api/appointment_groups.html#method.appointment_groups.create.
- [Update] action
-
Endpoint URL address:
/appointment_groups/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/appointment_groups.html#method.appointment_groups.update.
- [Delete] action
-
Endpoint URL address:
/appointment_groups/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/appointment_groups.html#method.appointment_groups.destroy.
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- start_at
Template: DateTime.
- end_at
Template: DateTime.
- description
Template: ShortText.
- location_name
Template: ShortText.
- location_address
Template: ShortText.
- participant_count
Data type: DT_I4
- reserved_times
Field components:
- An array.
-
Uses template:
reservedAppointmentT.
- appointments
Field components:
- An array.
-
Uses template:
reservedAppointmentT.
- new_appointments
Field components:
- An array.
-
Uses template:
reservedAppointmentT.
- context_codes
Template: LongText. A composite field.
- sub_context_codes
Template: LongText. A composite field.
- workflow_state
Template: ShortText.
- requiring_action
Data type: DT_BOOL
- appointments_count
Data type: DT_I4
- appointments
Template: LongText. A composite field.
- new_appointments
Template: LongText. A composite field.
- max_appointments_per_participant
Data type: DT_I4
- min_appointments_per_participant
Data type: DT_I4
- participants_per_appointment
Data type: DT_I4
- participant_visibility
Template: ShortText.
- participant_type
Template: ShortText.
- url
Template: ShortText.
- html_url
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- users
The value is gathered from
/appointment_groups/{{=item.id}}/usersaddress. Field components:- An array.
-
Uses template:
userT.
- groups
The value is gathered from
/appointment_groups/{{=item.id}}/groupsaddress. Field components:- An array.
-
Uses template:
groupT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/assignments.html#method.assignments_api.index.
- [Read single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments/{{=Canvas.UI.AssignmentEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- assignment_id: Required. Specify assignment identifier.
Documentation: https://canvas.instructure.com/doc/api/assignments.html#method.assignments_api.show.
- [Read user] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- user_id: Required. Specify user identifier.
Documentation: https://canvas.instructure.com/doc/api/assignments.html#method.assignments_api.user_index.
- [Read assignment group] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignment_groups/{{=parameters.assignment_group_id}}/assignments.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- assignment_group_id: Required. Specify assignment group identifier.
Documentation: https://canvas.instructure.com/doc/api/assignments.html#method.assignments_api.index.
- [Create] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/assignments.html#method.assignments_api.create.
- [Update] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments/{{=item.id}}.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/assignments.html#method.assignments_api.update.
- [Delete] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments/{{=item.id}}.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/assignments.html#method.assignments.destroy.
The resource includes the fields from the assignmentT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments/{{=Canvas.UI.AssignmentEditor.getValue(parameters)}}/overrides.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- assignment_id: Required. Specify assignment identifier.
Documentation: https://canvas.instructure.com/doc/api/assignments.html#method.assignment_overrides.index.
- [Read single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments/{{=Canvas.UI.AssignmentEditor.getValue(parameters)}}/overrides/{{=parameters.override_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- assignment_id: Required. Specify assignment identifier.
- override_id: Required. Specify override identifier.
Documentation: https://canvas.instructure.com/doc/api/assignments.html#method.assignment_overrides.show.
- [Read batch] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments/overrides.josn.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- assignment_ids: Required. Specify Ids of assignments for each override.
- override_ids: Required. Specify Ids of overrides to retrieve.
The following request parameters will be automatically processed:
-
assignment_overrides[][id]:
{{=Canvas.getMultiParameter(parameters.get('override_ids'))}} -
assignment_overrides[][assignment_id]:
{{=Canvas.getMultiParameter(parameters.get('assignment_ids'))}}
Documentation: https://canvas.instructure.com/doc/api/assignments.html#method.assignment_overrides.batch_retrieve.
- [Create] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments/{{=item.assignment_id}}/overrides.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ assignment_override : item } }}
Documentation: https://canvas.instructure.com/doc/api/assignments.html#method.assignment_overrides.create.
- [Update] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments/{{=item.assignment_id}}/overrides/{{=item.id}}.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/assignments.html#method.assignments_api.update.
- [Delete] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments/{{=item.assignment_id}}/overrides/{{=item.id}}.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/assignments.html#method.assignment_overrides.destroy.
The resource includes the fields from the overrideT template.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/courses/{=item.course_id}}/assignments/{{=item.assignment_id}}/extensions.Documentation: https://canvas.instructure.com/doc/api/assignment_extensions.html.
- course_id
A key field. Data type: DT_I4
- assignment_id
A key field. Data type: DT_I4
- assignment_extensions
Field components:
- An array.
- Contains the following components: user_id, extra_attempts.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignment_groups.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/assignment_groups.html#method.assignment_groups.index.
- [Read single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignment_groups/{{=Canvas.UI.AssignmentGroupEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- assignment_group_id: Required. Specify assignment group identifier.
Documentation: https://canvas.instructure.com/doc/api/assignment_groups.html#method.assignment_groups_api.show.
- [Create] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignment_groups.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/assignment_groups.html#method.assignment_groups.index.
- [Update] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignment_groups/{{=item.id}}.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/assignment_groups.html#method.assignment_groups_api.update.
- [Delete] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignment_groups/{{=item.id}}.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
The following request parameters will be automatically processed:
-
move_assignments_to:
{{=item.move_assignments_to}}
Documentation: https://canvas.instructure.com/doc/api/assignment_groups.html#method.assignment_groups_api.destroy.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- position
Data type: DT_I4
- group_weight
Data type: DT_I4
- move_assignments_to
Data type: DT_I4
- sis_source_id
Template: ShortText.
- integration_data
Template: NameValueT.
- assignments
Field components:
- An array.
-
Uses template:
assignmentT.
- all_dates
Field components:
- An array.
-
Uses template:
alldateT.
- assignment_visibility
Template: LongText. A composite field.
- overrides
Field components:
- An array.
-
Uses template:
overrideT.
- rules
Field components:
- An array.
- Contains the following components: drop_lowest, drop_highest, never_drop.
- score_statistics
Field components:
- Contains the following components: min, max, mean.
- observed_users
Field components:
- An array.
-
Uses template:
observeUserT.
- discussion_topic
Field components:
- An array.
-
Uses template:
discussionTopicT.
- submission
Field components:
- An array.
-
Uses template:
submissionT.
- can_edit
Data type: DT_BOOL
- assignments
The gathered value is processed with
{{=connection.resourceManager['Assignment'].getData({ endpoint: 'assignment group', parameters: ['course_id=' + parameters.course_id, 'assignment_group_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
assignmentT.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/authentication_providers.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/authentication_providers.html#method.authentication_providers.index.
- [Read single] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/authentication_provider/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
- id: Required. Specify authentication providers identifier.
Documentation: https://canvas.instructure.com/doc/api/authentication_providers.html#method.authentication_providers.show.
- [Create] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/authentication_providers.The action has the following user-defined parameters:
- accounts: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/authentication_providers.html#method.authentication_providers.create.
- [Update] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/authentication_providers/{{=item.id}}.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/authentication_providers.html#method.authentication_providers.update.
- [Delete] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/authentication_providers/{{=item.id}}.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/authentication_providers.html#method.authentication_providers.destroy.
- id
A key field. Data type: DT_I4
- identifier_format
Template: ShortText.
- auth_type
Template: ShortText.
- log_out_url
Template: ShortText.
- log_in_url
Template: ShortText.
- certificate_fingerprint
Template: ShortText.
- requested_authn_context
Template: ShortText.
- auth_host
Template: ShortText.
- auth_filter
Template: ShortText.
- auth_over_tls
Template: ShortText.
- auth_base
Template: ShortText.
- auth_username
Template: ShortText.
- auth_port
Template: ShortText.
- position
Data type: DT_I4
- idp_entity_id
Template: ShortText.
- login_attribute
Template: ShortText.
- sig_alg
Template: ShortText.
- jit_provisioning
Template: ShortText.
- federated_attributes
Template: ShortText.
- mfa_required
Template: ShortText.
Based on resource template General.
- [Read login] action
-
Endpoint URL address:
/audit/authentication/logins/{{=parameters.login_id}}.The action has the following user-defined parameters:
- login_id: Required. Specify login identifier.
Documentation: https://canvas.instructure.com/doc/api/pages.html#method.wiki_pages_api.revisions.
- [Read account] action
-
Endpoint URL address:
/audit/authentication/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/pages.html#method.wiki_pages_api.revisions.
- [Read user] action
-
Endpoint URL address:
/audit/authentication/users/{{=parameters.user_id}}.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
Documentation: https://canvas.instructure.com/doc/api/pages.html#method.wiki_pages_api.revisions.
- created_at
Template: DateTime.
- event_type
Template: ShortText.
- pseudonym_id
Data type: DT_I4
- account_id
Data type: DT_I4
- user_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/courses.Documentation: https://canvas.instructure.com/doc/api/courses.html#method.courses.index.
- [Read single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/courses.html#method.courses.show.
- [Read user] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/courses.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
Documentation: https://canvas.instructure.com/doc/api/courses.html#method.courses.user_index.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/courses.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/accounts.html#method.accounts.courses_api.
- [Read search] action
-
Endpoint URL address:
/search/all_courses.
The result is extracted from:{{=_.pluck(response, 'course')}}.Documentation: https://canvas.instructure.com/doc/api/search.html#method.search.all_courses.
- [Read favorite] action
-
Endpoint URL address:
/users/self/favorites/courses.Documentation: https://canvas.instructure.com/doc/api/favorites.html#method.favorites.list_favorite_courses.
- [Create] action
-
Endpoint URL address:
/accounts/{{=item.account_id}}/courses.Documentation: https://canvas.instructure.com/doc/api/courses.html#method.courses.create.
- [Update] action
-
Endpoint URL address:
/courses/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/courses.html#method.courses.update.
- [Delete] action
-
Endpoint URL address:
/courses/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ event : item.event } }}
Documentation: https://canvas.instructure.com/doc/api/courses.html#method.courses.destroy.
-
application/json:
The resource includes the fields from the courseT template.
- image-content
Data type: DT_IMAGE The value is gathered from
{{=item.image_download_url}}address.- settings
The value is gathered from
/courses/{{=item.id}}/settingsaddress. The gathered value is processed with{{=response[field.name]}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: allow_final_grade_override, allow_student_discussion_topics, allow_student_forum_attachments, allow_student_discussion_editing, allow_student_discussion_reporting, allow_student_anonymous_discussion_topics, filter_speed_grader_by_student_group, grading_standard_enabled, grading_standard_id, grade_passback_setting, allow_student_organized_groups, hide_final_grades, hide_distribution_graphs, hide_sections_on_course_users_page, lock_all_announcements, usage_rights_required, restrict_student_past_view, restrict_student_future_view, show_announcements_on_home_page, home_page_announcement_limit, syllabus_course_summary, homeroom_course, image_url, image_id, image, banner_image_url, banner_image_id, banner_image, course_color, friendly_name, default_due_time.
-
Uses template:
- activity_stream
The value is gathered from
/courses/{{=item.id}}/activity_streamaddress. Field components:- An array.
-
Uses template:
ActivityStreamT.
- activity_stream_summary
The value is gathered from
/courses/{{=item.id}}/activity_stream/summaryaddress. Field components:- An array.
- Contains the following components: count, type, unread_count.
- bulk_user_progress
The value is gathered from
/courses/{{=item.id}}/bulk_user_progressaddress. Field components:- An array.
-
Uses template:
AuthorT.
- users
The gathered value is processed with
{{=connection.resourceManager['User'].getData({ endpoint: 'course', parameters: ['course_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
userT. - Contains the following components: analytics, assignments.
- students
The value is gathered from
/courses/{{=item.id}}/studentsaddress. Field components:- An array.
-
Uses template:
userT.
- test_student
Template: userT. The value is gathered from
/courses/{{=item.id}}/student_view_studentaddress.- effective_due_dates
The value is gathered from
/courses/{{=item.id}}/effective_due_datesaddress. The gathered value is processed with{{=Canvas.getCourseDueDate(response)}}expression. Field components:- An array.
- Contains the following components: assignment_id, student_id, grading_period_id, in_closed_grading_period, due_at.
- analytics
A read-only field. Field components:
- Contains the following components: activity, assignments, student_summaries.
- external_feeds
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Course | Announcement External Feed'].getData({ parameters: ['course_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
ExternalFeedT.
- assignments
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Assignment'].getData({ parameters: ['course_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
assignmentT.
- todos
The value is gathered from
/courses/{{=item.id}}/todoaddress. Field components:- An array.
- Contains the following components: type, assignment, ignore, ignore_permanently, html_url, needs_grading_count, context_type, course_id, group_id.
- gradebook_history
The value is gathered from
/courses/{{=item.id}}/gradebook_history/daysaddress. The gathered value is processed with{{=function() { var result = []; _.each(response, function(item) { _.each(record.graders, function(grader) { _.each(grader.assignments, function(assignment_id) { result.push({ id: assignment_id, date: item.date, grader_id: grader.id, grader_name: grader.name }); }); }); }); return result; }()}}expression. Field components:- An array.
- Contains the following components: id, date, grader_id, grader_name, submissions.
- outcome_results
The value is gathered from
/courses/{{=item.id}}/outcome_resultsaddress. The gathered value is processed with{{=response.outcome_results}}expression. Field components:- An array.
- Contains the following components: id, score, submitted_or_assessed_at, links, percent.
- outcome_groups
The value is gathered from
/courses/{{=item.id}}/outcome_groupsaddress. Field components:- An array.
-
Uses template:
OutcomeGroupT.
- outcome_links
The value is gathered from
/courses/{{=item.id}}/outcome_group_linksaddress. Field components:- An array.
-
Uses template:
OutcomeLinkT.
- quiz_assignment_overrides
The value is gathered from
/courses/{{=item.id}}/quizzes/assignment_overridesaddress. The gathered value is processed with{{=response.quiz_assignment_overrides}}expression. Field components:- An array.
- Contains the following components: quiz_id, due_dates, all_dates.
- new_quiz_assignment_overrides
The value is gathered from
/courses/{{=item.id}}/new_quizzes/assignment_overridesaddress. The gathered value is processed with{{=response.quiz_assignment_overrides}}expression. Field components:- An array.
- Contains the following components: quiz_id, due_dates, all_dates.
- modules
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Module'].getData({ parameters: ['course_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
moduleT.
- action
Field components:
- Contains the following components: add_favorite, remove_favorite.
Based on resource template Base.
- [Read course] action
-
Endpoint URL address:
/audit/course/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/course_audit_log.html#method.course_audit_api.for_course.
- [Read account] action
-
Endpoint URL address:
/audit/course/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- account_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/course_audit_log.html#method.course_audit_api.for_account.
- id
A key field. Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- event_type
Template: ShortText.
- event_data
Field components:
-
Uses template:
LongText. - Contains the following components: name, start_at, conclude_at, is_public, created_source.
-
Uses template:
- event_source
Template: ShortText.
- page_view
Template: ShortText.
- course
Data type: DT_I4
- user
Data type: DT_I4
- copied_from
Data type: DT_I4
- copied_to
Data type: DT_I4
- sis_batch
Data type: DT_I4
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: course, user, page_view.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/custom_gradebook_columns.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/custom_gradebook_columns.html#method.custom_gradebook_columns_api.index.
- [Create] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/custom_gradebook_columns.Documentation: https://canvas.instructure.com/doc/api/custom_gradebook_columns.html#method.custom_gradebook_columns_api.index.
- [Update] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/custom_gradebook_columns/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/custom_gradebook_columns.html#method.custom_gradebook_columns_api.update.
- [Delete] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/custom_gradebook_columns/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/custom_gradebook_columns.html#method.custom_gradebook_columns_api.update.
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- position
Data type: DT_I4
- teacher_notes
Data type: DT_BOOL
- read_only
Data type: DT_BOOL
- hidden
Data type: DT_BOOL
- course_id
Data type: DT_I4
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/custom_gradebook_columns/{{=parameters.id}}/data.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- id: Required. Specify column identifier.
Documentation: https://canvas.instructure.com/doc/api/custom_gradebook_columns.html#method.custom_gradebook_column_data_api.index.
- [Update] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/custom_gradebook_columns/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{= { column_data : [item] } }}
Documentation: https://canvas.instructure.com/doc/api/custom_gradebook_columns.html#method.custom_gradebook_column_data_api.bulk_update.
-
application/json:
- id
A key field. Data type: DT_I4
- content
Template: ShortText.
- user_id
Data type: DT_I4
- column_id
Data type: DT_I4
- course_id
Data type: DT_I4
Based on resource template Base.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/pages.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/pages.html#method.wiki_pages_api.index.
- [Read group] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/pages.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
Documentation: https://canvas.instructure.com/doc/api/pages.html#method.wiki_pages_api.index.
- [Read course single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/pages/{{=parameters.url}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- url: Required. Specify page url.
Documentation: https://canvas.instructure.com/doc/api/pages.html#method.wiki_pages_api.show.
- [Read group single] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/pages/{{=parameters.url}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
- url: Required. Specify page url.
Documentation: https://canvas.instructure.com/doc/api/pages.html#method.wiki_pages_api.show.
- [Read course front] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/front_page.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/pages.html#method.wiki_pages_api.show_front_page.
- [Read group front] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/front_page.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
Documentation: https://canvas.instructure.com/doc/api/pages.html#method.wiki_pages_api.show_front_page.
- [Create] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/pages.Documentation: https://canvas.instructure.com/doc/api/pages.html#method.wiki_pages_api.show.
- [Update] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/pages/{{=item.url}}.Documentation: https://canvas.instructure.com/doc/api/pages.html#method.wiki_pages_api.update.
- [Delete] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/pages/{{=item.url}}.Documentation: https://canvas.instructure.com/doc/api/pages.html#method.wiki_pages_api.destroy.
- page_id
A key field. Data type: DT_I4
- title
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- url
A key field. Template: ShortText.
- editing_roles
Template: ShortText.
- last_edited_by
Template: AuthorT. A read-only field.
- published
Data type: DT_BOOL
- hide_from_students
Data type: DT_BOOL
- front_page
Data type: DT_BOOL
- html_url
Template: ShortText.
- todo_date
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
- locked_for_user
Data type: DT_BOOL
- body
Data type: DT_WSTR ( length 255 )
- lock_info
Template: ShortText.
- lock_explanation
Template: ShortText.
- context_type
Template: ShortText.
- context_id
Data type: DT_I4
Based on resource template Base.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/pages/{{=parameters.url}}/revisions.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- url: Required. Specify page url.
Documentation: https://canvas.instructure.com/doc/api/pages.html#method.wiki_pages_api.revisions.
- [Read group] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/pages/{{=parameters.url}}/revisions.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
- url: Required. Specify page url.
Documentation: https://canvas.instructure.com/doc/api/pages.html#method.wiki_pages_api.revisions.
- [Read course single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/pages/{{=parameters.url}}/revisions/{{=parameters.revision_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- url: Required. Specify page url.
- revision_id: Required. Specify revision identifier. Set to latest to get the latest.
Documentation: https://canvas.instructure.com/doc/api/pages.html#method.wiki_pages_api.revisions.
- [Read group single] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/pages/{{=parameters.url}}/revisions/{{=parameters.revision_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- group_id: Required. Specify course identifier.
- url: Required. Specify page url.
- revision_id: Required. Specify revision identifier. Set to latest to get the latest.
Documentation: https://canvas.instructure.com/doc/api/pages.html#method.wiki_pages_api.revisions.
- [Update] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/pages/{{=item.url}}/revisions/{{=item.revision_id}}.Documentation: https://canvas.instructure.com/doc/api/pages.html#method.wiki_pages_api.revert.
- revision_id
A key field. Data type: DT_I4
- updated_at
Template: DateTime. A read-only field.
- latest
Data type: DT_BOOL
- edited_by
Template: AuthorT.
- url
Template: ShortText.
- title
Template: ShortText.
- body
Template: LongText.
- context_type
Template: ShortText.
- context_id
Data type: DT_I4
Based on resource template General.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/students/submissions.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/submissions.html#method.submissions_api.for_students.
- [Read section] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.SectionEditor.getValue(parameters)}}/students/submissions.The action has the following user-defined parameters:
- section_id: Required. Specify section identifier.
Documentation: https://canvas.instructure.com/doc/api/submissions.html#method.submissions_api.for_students.
- [Read course assignment] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments/{{=Canvas.UI.AssignmentEditor.getValue(parameters)}}/submissions.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- assignment_id: Required. Specify the assignment identifier.
The following request parameters will be automatically processed:
-
include[]:
submission_history
Documentation: https://canvas.instructure.com/doc/api/submissions.html#Submission.
- [Read section assignment] action
-
Endpoint URL address:
/sections/{{=Canvas.UI.SectionEditor.getValue(parameters)}}/assignments/{{=parameters.assignment_id}}/submissions.The action has the following user-defined parameters:
- section_id: Required. Specify section identifier.
- assignment_id: Required. Specify the assignment identifier.
Documentation: https://canvas.instructure.com/doc/api/submissions.html#Submission.
- [Read course single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments/{{=Canvas.UI.AssignmentEditor.getValue(parameters)}}/submissions/{{=parameters.user_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- assignment_id: Required. Specify the assignment identifier.
- user_id: Required. Specify the user identifier.
Documentation: https://canvas.instructure.com/doc/api/submissions.html#method.submissions_api.show.
- [Read section single] action
-
Endpoint URL address:
/sections/{{=Canvas.UI.SectionEditor.getValue(parameters)}}/assignments/{{=parameters.assignment_id}/submissions/{{=parameters.user_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- section_id: Required. Specify section identifier.
- assignment_id: Required. Specify the assignment identifier.
- user_id: Required. Specify the user identifier.
Documentation: https://canvas.instructure.com/doc/api/submissions.html#method.submissions_api.show.
- [Read course anonymous] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments/{{=Canvas.UI.AssignmentEditor.getValue(parameters)}}/anonymous_submissions/{{=parameters.anonymous_id}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- assignment_id: Required. Specify the assignment identifier.
- anonymous_id: Required. Specify the submission anonymous_id identifier.
Documentation: https://canvas.instructure.com/doc/api/submissions.html#method.submissions_api.show_anonymous.
- [Read section anonymous] action
-
Endpoint URL address:
/sections/{{=Canvas.UI.SectionEditor.getValue(parameters)}}/assignments/{{=parameters.assignment_id}}/anonymous_submissions/{{=parameters.anonymous_id}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- assignment_id: Required. Specify the assignment identifier.
- anonymous_id: Required. Specify the submission anonymous_id identifier.
Documentation: https://canvas.instructure.com/doc/api/submissions.html#method.submissions_api.show_anonymous.
- [Create] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/assignments/{{=item.assignment_id}}/submissions.Documentation: https://canvas.instructure.com/doc/api/submissions.html#method.submissions.create.
- [Update] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/assignments/{{=item.assignment_id}}/submissions/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/submissions.html#method.submissions_api.update.
- id
A key field. Data type: DT_I4
- body
Data type: DT_NTEXT
- url
Template: ShortText.
- course
Template: courseT.
- assignment
Template: assignmentT.
- grade
Template: ShortText.
- score
Data type: DT_I4
- submitted_at
Template: DateTime.
- assignment_id
Data type: DT_I4
- submission_type
Template: ShortText.
- workflow_state
Template: ShortText.
- grade_matches_current_submission
Data type: DT_BOOL
- graded_at
Template: DateTime.
- grader_id
Template: ShortText.
- attempt
Template: ShortText.
- cached_due_date
Template: ShortText.
- excused
Template: ShortText.
- late_policy_status
Template: ShortText.
- points_deducted
Template: ShortText.
- grading_period_id
Template: ShortText.
- extra_attempts
Template: ShortText.
- posted_at
Template: DateTime.
- redo_request
Data type: DT_BOOL
- late
Data type: DT_BOOL
- missing
Data type: DT_BOOL
- seconds_late
Data type: DT_I4
- entered_grade
Template: ShortText.
- entered_score
Data type: DT_I4
- preview_url
Template: ShortText.
- user_id
A key field. Data type: DT_I4
- submission
Template: submissionT.
- comment
Template: submissionCommentT.
- include
Field components:
-
Uses template:
ShortText. - Contains the following components: visibility.
-
Uses template:
- submission_history
Field components:
- An array.
- Contains the following components: id, body, url, grade, score, submitted_at, assignment_id, user_id, submission_type, workflow_state, grade_matches_current_submission, graded_at, grader_id, attempt, cached_due_date, excused, late_policy_status, points_deducted, grading_period_id, extra_attempts, posted_at, redo_request, late, missing, seconds_late, entered_grade, entered_score, preview_url, submission_data.
- group
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name.
-
Uses template:
- user
Template: userT.
- prefer_points_over_scheme
Data type: DT_BOOL
- rubric_assessment
Template: rubricAssessmentT.
- context_type
Template: ShortText.
- context_id
Data type: DT_I4
- submission_summary
The value is gathered from
/{{=Canvas.getContextType(parameters)}}/{{=Canvas.getContextId(parameters)}}/assignments/{{=parameters.assignment_id}}/submission_summaryaddress. Field components:- An array.
- Contains the following components: graded, ungraded, not_submitted.
- gradeable_students
The value is gathered from
/{{=Canvas.getContextType(parameters)}}/{{=Canvas.getContextId(parameters)}}/assignments/{{=parameters.assignment_id}}/gradeable_studentsaddress. Field components:- An array.
-
Uses template:
userT.
- action
Template: ShortText. Field components:
- Contains the following components: read, unread.
Based on resource template General.
- [Update] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/assignments/{{=item.assignment_id}}/submissions/{{=item.user_id}}/comments/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/submission_comments.html#method.submission_comments_api.update.
- [Delete] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/assignments/{{=item.assignment_id}}/submissions/{{=item.user_id}}/comments/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/submission_comments.html#method.submission_comments_api.destroy.
The resource includes the fields from the submissionCommentT template.
- course_id
Data type: DT_I4
- assignment_id
Data type: DT_I4
- user_id
Data type: DT_I4
Based on resource template General.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/submissions.html#method.submissions_api.update.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/assignments.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/submissions.html#method.submissions_api.update.
- id
A key field. Data type: DT_I4
- course_id
Data type: DT_I4
- name
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- due_at
Template: DateTime.
- unlock_at
Template: DateTime.
- lock_at
Template: DateTime.
- points_possible
Data type: DT_I4
- submission_types
Template: LongText. A composite field.
- integration_id
Template: ShortText.
- integration_data
Template: NameValueT.
- include_in_final_grade
Data type: DT_BOOL
- assignment_group
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, group_weight, sis_source_id, integration_data.
-
Uses template:
- sections
Template: sectionT.
- user_overrides
Template: overrideT.
Based on resource template General.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/tabs.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/tabs.html#method.tabs.index.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/tabs.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/tabs.html#method.tabs.index.
- [Read group] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/tabs.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
Documentation: https://canvas.instructure.com/doc/api/tabs.html#method.tabs.index.
- [Read user] action
-
Endpoint URL address:
/users/{{=parameters.user_id)}}/tabs.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
Documentation: https://canvas.instructure.com/doc/api/tabs.html#method.tabs.index.
- [Update] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/tabs/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/tabs.html#method.tabs.update.
The resource includes the fields from the tabT template.
- course_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/sections.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/sections.html#method.sections.index.
- [Read single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/sections/{{=Canvas.UI.SectionEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- section_id: Required. Specify section identifier.
Documentation: https://canvas.instructure.com/doc/api/sections.html#method.sections.show.
- [Update] action
-
Endpoint URL address:
/sections/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/sections.html#method.sections.update.
- [Delete] action
-
Endpoint URL address:
/sections/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/sections.html#method.sections.destroy.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- sis_section_id
Template: ShortText.
- integration_id
Template: ShortText.
- sis_import_id
Data type: DT_I4
- course_id
Data type: DT_I4
- sis_course_id
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- start_at
Template: DateTime.
- end_at
Template: DateTime.
- restrict_enrollments_to_section_dates
Data type: DT_BOOL
- nonxlist_course_id
Template: ShortText.
- permissions
Field components:
- Contains the following components: manage_calendar.
- avatar_url
Field components:
- An array.
-
Uses template:
avatarUrlT.
- total_students
Data type: DT_I4
- passback_status
Data type: DT_BOOL
- students
Field components:
- An array.
-
Uses template:
userT.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/accounts/{{=item.user_id}}/shared_brand_configs.Documentation: https://canvas.instructure.com/doc/api/shared_brand_configs.html#method.shared_brand_configs.create.
- [Update] action
-
Endpoint URL address:
/accounts/{{=item.user_id}}/shared_brand_configs/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/shared_brand_configs.html#method.shared_brand_configs.update.
- [Delete] action
-
Endpoint URL address:
/shared_brand_configs/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/shared_brand_configs.html#method.shared_brand_configs.destroy.
- id
A key field. Data type: DT_I4
- account_id
Template: ShortText.
- brand_config_md5
Template: ShortText.
- name
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- user_id
Data type: DT_I4
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/users/self/groups.Documentation: https://canvas.instructure.com/doc/api/groups.html#method.groups.index.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/groups.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/groups.html#method.groups.context_index.
- [Read account] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/groups.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/groups.html#method.groups.context_index.
- [Read single] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
Documentation: https://canvas.instructure.com/doc/api/groups.html#method.groups.show.
- [Read favorite] action
-
Endpoint URL address:
/users/self/favorites/groups.Documentation: https://canvas.instructure.com/doc/api/favorites.html#method.favorites.list_favorite_courses.
- [Create] action
-
Endpoint URL address:
/groups.Documentation: https://canvas.instructure.com/doc/api/groups.html#method.groups.create.
- [Update] action
-
Endpoint URL address:
/groups/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/groups.html#method.groups.update.
- [Delete] action
-
Endpoint URL address:
/groups/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/groups.html#method.groups.destroy.
The resource includes the fields from the groupT template.
- users
The value is gathered from
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/usersaddress. Field components:- An array.
-
Uses template:
userT.
- external_feeds
The gathered value is processed with
{{=connection.resourceManager['Group | Announcement External Feed'].getData({ parameters: ['group_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
ExternalFeedT.
- activity_stream
The value is gathered from
/groups/{{=item.id}}/activity_streamaddress. Field components:- An array.
-
Uses template:
ActivityStreamT.
- activity_stream_summary
The value is gathered from
/groups/{{=item.id}}/activity_stream/summaryaddress. Field components:- An array.
- Contains the following components: count, type, unread_count.
- action
Field components:
- Contains the following components: add_favorite, remove_favorite.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/memberships.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
Documentation: https://canvas.instructure.com/doc/api/groups.html#method.group_memberships.index.
- [Read single] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/memberships/{{=parameters.membership_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
- membership_id: Required. Specify member identifier.
Documentation: https://canvas.instructure.com/doc/api/groups.html#method.group_memberships.show.
- [Create] action
-
Endpoint URL address:
/groups/{{=item.group_id}}/memberships.Documentation: https://canvas.instructure.com/doc/api/groups.html#method.group_memberships.create.
- [Update] action
-
Endpoint URL address:
/groups/{{=item.group_id}}/memberships/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/groups.html#method.group_memberships.update.
- [Delete] action
-
Endpoint URL address:
/groups/{{=item.group_id}}/memberships/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/groups.html#method.group_memberships.destroy.
- id
A key field. Data type: DT_I4
- group_id
Data type: DT_I4
- user_id
Data type: DT_I4
- workflow_state
Template: ShortText.
- moderator
Data type: DT_BOOL
- just_created
Data type: DT_BOOL
- sis_import_id
Data type: DT_I4
- invitees
A key field. Data type: DT_I4
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: invite.
-
Uses template:
Based on resource template General.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/group_categories.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/group_categories.html#method.group_categories.index.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/group_categories.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/group_categories.html#method.group_categories.index.
- [Read single] action
-
Endpoint URL address:
/group_categories/{{=parameters.group_category_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- group_category_id: Required. Specify group category id identifier.
Documentation: https://canvas.instructure.com/doc/api/group_categories.html#method.group_categories.show.
- [Create] action
-
Endpoint URL address:
/{{=item.context_type}}/{{=item.course_id || item.account_id}}/group_categories.Documentation: https://canvas.instructure.com/doc/api/group_categories.html#method.group_categories.create.
- [Update] action
-
Endpoint URL address:
/group_categories/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/group_categories.html#method.group_categories.update.
- [Delete] action
-
Endpoint URL address:
/group_categories/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/group_categories.html#method.group_categories.destroy.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- description
Template: ShortText.
- is_public
Data type: DT_BOOL
- followed_by_user
Data type: DT_BOOL
- join_level
Template: ShortText.
- members_count
Data type: DT_I4
- avatar_url
Field components:
- An array.
-
Uses template:
avatarUrlT.
- context_type
Template: ShortText.
- course_id
Data type: DT_I4
- account_id
Data type: DT_I4
- group_category_id
Data type: DT_I4
- sis_group_id
Template: ShortText.
- sis_import_id
Data type: DT_I4
- storage_quota_mb
Data type: DT_I4
- role
Template: ShortText.
- self_signup
Template: ShortText.
- group_limit
Data type: DT_I4
- auto_leader
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- protected
Data type: DT_BOOL
- allows_multiple_memberships
Data type: DT_BOOL
- is_member
Data type: DT_BOOL
- permissions
Template: permissionT.
- sync
Data type: DT_BOOL
- users
The value is gathered from
/group_categories/{{=item.id}}/usersaddress. Field components:- An array.
-
Uses template:
userT.
- groups
The value is gathered from
/group_categories/{{=item.id}}/groupsaddress. Field components:- An array.
-
Uses template:
groupT.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: assign_unassigned_members, import.
-
Uses template:
Based on resource template Base.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/grading_periods.
The result is extracted from:{{=response.grading_periods}}.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/grading_periods.html#method.grading_periods.index.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/grading_periods.
The result is extracted from:{{=response.grading_periods}}.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/grading_periods.html#method.grading_periods.index.
- [Read single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/{{=parameters.grading_period_id}}.
The result is extracted from:{{=response.grading_periods}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- grading_period_id: Required. Specify grading period identifier.
Documentation: https://canvas.instructure.com/doc/api/grading_periods.html#method.grading_periods.show.
- [Update] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/grading_periods/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/grading_periods.html#method.grading_periods.update.
- [Delete] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/grading_periods/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/grading_periods.html#method.grading_periods.destroy.
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- start_date
Template: DateTime.
- end_date
Template: DateTime.
- close_date
Template: DateTime.
- weight
Data type: DT_R8
- is_closed
Data type: DT_BOOL
- course_id
Data type: DT_I4
Based on resource template Base.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/grading_standards.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/grading_standards.html#method.grading_standards_api.context_index.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/grading_standards.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/grading_standards.html#method.grading_standards_api.context_index.
- [Read course single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/grading_standards/{{=parameters.grading_period_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- grading_period_id: Required. Specify grading period identifier.
Documentation: https://canvas.instructure.com/doc/api/groups.html#method.groups.show.
- [Read account single] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/grading_standards/{{=parameters.grading_period_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
- grading_period_id: Required. Specify grading period identifier.
Documentation: https://canvas.instructure.com/doc/api/groups.html#method.groups.show.
- [Create] action
-
Endpoint URL address:
/{{=item.context_type}}/{{=item.context_id}}/grading_standards.The following request parameters will be automatically processed:
-
application/json:
{{=_.extend({ grading_scheme_entry: item.grading_scheme }, _.omit(item, 'grading_scheme'))}}
Documentation: https://canvas.instructure.com/doc/api/grading_standards.html#method.grading_standards_api.create.
-
application/json:
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- context_type
Template: ShortText.
- context_id
Data type: DT_I4
- assignment_id
Data type: DT_I4
- assignment_name
Template: ShortText.
- body
Template: ShortText.
- current_grade
Template: ShortText.
- current_graded_at
Template: DateTime. A read-only field.
- current_grader
Template: ShortText.
- grade_matches_current_submission
Data type: DT_BOOL
- graded_at
Template: DateTime.
- grader
Template: ShortText.
- grader_id
Data type: DT_I4
- id
Data type: DT_I4
- new_grade
Template: ShortText.
- new_graded_at
Template: DateTime.
- new_grader
Template: ShortText.
- previous_grade
Template: ShortText.
- previous_graded_at
Template: DateTime.
- previous_grader
Template: ShortText.
- score
Data type: DT_I4
- user_name
Template: ShortText.
- submission_type
Template: ShortText.
- url
Template: ShortText.
- user_id
Data type: DT_I4
- workflow_state
Template: ShortText.
- grading_scheme
Field components:
- An array.
- Contains the following components: name, value.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/audit/grade_change.Documentation: https://canvas.instructure.com/doc/api/grade_change_log.html#method.grade_change_audit_api.query.
- [Read assignment] action
-
Endpoint URL address:
/audit/grade_change/assignments/{{=Canvas.UI.AssignmentEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- assignment_id: Required. Specify assignment identifier.
Documentation: https://canvas.instructure.com/doc/api/grade_change_log.html#method.grade_change_audit_api.for_assignment.
- [Read course] action
-
Endpoint URL address:
/audit/grade_change/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/grade_change_log.html#method.grade_change_audit_api.for_course.
- [Read student] action
-
Endpoint URL address:
/audit/grade_change/students/{{=parameters.student_id}}.The action has the following user-defined parameters:
- student_id: Required. Specify student identifier.
Documentation: https://canvas.instructure.com/doc/api/grade_change_log.html#method.grade_change_audit_api.for_student.
- [Read grader] action
-
Endpoint URL address:
/audit/grade_change/graders/{{=parameters.grader_id}}.The action has the following user-defined parameters:
- grader_id: Required. Specify grader identifier.
Documentation: https://canvas.instructure.com/doc/api/grade_change_log.html#method.grade_change_audit_api.for_grader.
- id
A key field. Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- event_type
Template: ShortText.
- excused_after
Data type: DT_BOOL
- excused_before
Data type: DT_BOOL
- grade_after
Template: ShortText.
- grade_before
Template: ShortText.
- graded_anonymously
Data type: DT_BOOL
- version_number
Template: ShortText.
- request_id
Template: ShortText.
- links
Field components:
- An array.
- Contains the following components: assignment, course, student, grader, page_view.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/history.The action has the following user-defined parameters:
- user_id: Required. Specify the user identifier.
Documentation: https://canvas.instructure.com/doc/api/history.html#HistoryEntry.
- asset_code
Template: ShortText.
- asset_name
Template: ShortText.
- asset_icon
Template: ShortText.
- asset_readable_category
Template: ShortText.
- context_type
Template: ShortText.
- context_id
Data type: DT_I4
- context_name
Template: ShortText.
- visited_url
Template: ShortText.
- visited_at
Template: DateTime.
- interaction_seconds
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/late_policy.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/late_policy.html#method.late_policy.show.
- [Create] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/late_policy.Documentation: https://canvas.instructure.com/doc/api/late_policy.html#method.late_policy.create.
- [Update] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/late_policy.
The action uses PATCH method.Documentation: https://canvas.instructure.com/doc/api/late_policy.html#method.late_policy.update.
- id
A key field. Data type: DT_I4
- course_id
Data type: DT_I4
- missing_submission_deduction_enabled
Data type: DT_BOOL
- missing_submission_deduction
Data type: DT_R8
- late_submission_deduction_enabled
Data type: DT_BOOL
- late_submission_deduction
Data type: DT_R8
- late_submission_interval
Template: ShortText.
- late_submission_minimum_percent_enabled
Data type: DT_BOOL
- late_submission_minimum_percent
Data type: DT_R8
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template LTI.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/line_items.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/line_items.html#method.lti/ims/line_items.index.
- [Read single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/line_items/{{=parameters.line_item_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- line_item_id: Required. Specify line item identifier.
Documentation: https://canvas.instructure.com/doc/api/line_items.html#method.lti/ims/line_items.show.
- [Create] action
-
Endpoint URL address:
/courses/{{=item.resourceLinkId}}/line_items.Documentation: https://canvas.instructure.com/doc/api/line_items.html#method.lti/ims/line_items.create.
- [Update] action
-
Endpoint URL address:
/courses/{{=item.resourceLinkId}}/line_items/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/line_items.html#method.lti/ims/line_items.update.
- [Delete] action
-
Endpoint URL address:
/courses/{{=item.resourceLinkId}}/line_items/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/line_items.html#method.lti/ims/line_items.destroy.
- id
A key field. Template: ShortText.
- scoreMaximum
Data type: DT_I4
- label
Template: ShortText.
- tag
Template: ShortText.
- resourceId
Template: ShortText.
- resourceLinkId
Template: ShortText.
- endDateTime
Template: DateTime.
- submission_type
The gathered value is processed with
{{=item['https://canvas.instructure.com/lti/submission_type'][field.name]}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: type, external_tool_url.
-
Uses template:
- launch_url
Template: ShortText. The gathered value is processed with
{{=item['https://canvas.instructure.com/lti/launch_url']}}expression.- results
The value is gathered from
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/line_items/{{=item.id}}/resultsaddress. Field components:-
Uses template:
ShortText. - Contains the following components: id, userId, resultScore, resultMaximum, comment, scoreOf.
-
Uses template:
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/live_assessments.
The result is extracted from:{{=response.assessments}}.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/live_assessments.html#method.live_assessments/assessments.index.
- [Create] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/live_assessments.The following request parameters will be automatically processed:
-
application/json:
{{= { assessments : [item] } }}
Documentation: https://canvas.instructure.com/doc/api/live_assessments.html#method.live_assessments/assessments.create.
-
application/json:
- id
A key field. Data type: DT_I4
- key
Template: ShortText.
- title
Template: ShortText.
- links
Template: LongText. A composite field.
- course_id
A key field. Data type: DT_I4
- results
The value is gathered from
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/live_assessments/{{=item.id}}/resultsaddress. The gathered value is processed with{{=response.results}}expression. The value is sent to/courses/{{=item.course_id}}/live_assessments/{{=item.id}}/resultsaddress. Field components:- An array.
- Contains the following components: id, passed, assessed_at, links.
Based on resource template General.
- [Read single] action
-
Endpoint URL address:
/outcomes/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. Specify outcome identifier.
Documentation: https://canvas.instructure.com/doc/api/outcomes.html#method.outcomes_api.show.
- [Read student] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/outcome_alignments.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- student_id: Required. Specify student identifier.
Documentation: https://canvas.instructure.com/doc/api/enrollments.html#method.enrollments_api.show.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/outcome_groups/{{=parameters.outcome_group_id}}/outcomes.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- outcome_group_id: Required. Specify the outcome group identifier.
Documentation: https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.outcomes.
- [Read account] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/outcome_groups/{{=parameters.outcome_group_id}}/outcomes.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
- outcome_group_id: Required. Specify the outcome group identifier.
Documentation: https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.outcomes.
- [Read global] action
-
Endpoint URL address:
/global/outcome_groups/{{=parameters.outcome_group_id}}/outcomes.The action has the following user-defined parameters:
- outcome_group_id: Required. Specify the outcome group identifier.
Documentation: https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.outcomes.
- [Create] action
-
Endpoint URL address:
{{=item.context_type}}/outcomes.Documentation: https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.link.
- [Update] action
-
Endpoint URL address:
{{=item.context_type}}/outcomes/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
{{=item.context_type}}/outcomes/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.update.
- id
A key field. Data type: DT_I4
- url
Template: ShortText.
- context_id
Data type: DT_I4
- context_type
Template: ShortText.
- title
Template: ShortText.
- display_name
Template: ShortText.
- description
Template: ShortText.
- vendor_guid
Template: ShortText.
- points_possible
Data type: DT_I4
- mastery_points
Data type: DT_I4
- calculation_method
Template: ShortText.
- calculation_int
Data type: DT_I4
- ratings
Field components:
- An array.
-
Uses template:
ratingT.
- subgroups_url
Template: ShortText.
- outcomes_url
Template: ShortText.
- import_url
Template: ShortText.
- can_edit
Data type: DT_BOOL
- can_unlink
Data type: DT_BOOL
- assessed
Data type: DT_BOOL
- has_updateable_rubrics
Data type: DT_BOOL
Based on resource template General.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/outcome_imports/{{=parameters.outcome_import_id}}.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- outcome_import_id: Required. Specify the outcome import identifier.
Documentation: https://canvas.instructure.com/doc/api/outcome_imports.html#method.outcome_imports_api.show.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/outcome_imports/{{=parameters.outcome_import_id}}.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
- outcome_import_id: Required. Specify the outcome import identifier.
Documentation: https://canvas.instructure.com/doc/api/outcome_imports.html#method.outcome_imports_api.show.
- [Create] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/outcome_imports.The following request parameters will be automatically processed:
-
item:
{{=item.content}}
Documentation: https://canvas.instructure.com/doc/api/outcome_imports.html#method.outcome_imports_api.create.
-
item:
- id
A key field. Data type: DT_I4
- learning_outcome_group_id
Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- ended_at
Template: DateTime.
- updated_at
Template: DateTime.
- workflow_state
Template: ShortText.
- data
Field components:
-
Uses template:
ShortText. - Contains the following components: import_type.
-
Uses template:
- progress
Data type: DT_I4
- user
Template: userT.
- processing_errors
Field components:
- An array.
- context_type
Template: ShortText.
- context_id
Data type: DT_I4
- content
Data type: DT_IMAGE
- filename
Template: ShortText.
Based on resource template General.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/outcome_groups.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.index.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/outcome_groups.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.index.
- [Read course single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/outcome_groups/{{=parameters.outcome_group_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- outcome_group_id: Required. Specify the outcome group identifier.
Documentation: https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.show.
- [Read account single] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/outcome_groups/{{=parameters.outcome_group_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
- outcome_group_id: Required. Specify the outcome group identifier.
Documentation: https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.show.
- [Read global] action
-
Endpoint URL address:
/global/outcome_groups/{{=parameters.outcome_group_id}}.The action has the following user-defined parameters:
- outcome_group_id: Required. Specify the outcome group identifier.
Documentation: https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.show.
- [Update] action
-
Endpoint URL address:
{{=item.context_type}}/outcome_groups/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.update.
- [Delete] action
-
Endpoint URL address:
{{=item.context_type}}/outcome_groups/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.update.
The resource includes the fields from the OutcomeGroupT template.
Based on resource template General.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/subgroups.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.subgroups.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/subgroups.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.subgroups.
- [Read course single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/outcome_groups/{{=parameters.outcome_group_id}}/subgroups.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- outcome_group_id: Required. Specify the outcome group identifier.
Documentation: https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.subgroups.
- [Read account single] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/outcome_groups/{{=parameters.outcome_group_id}}/subgroups.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
- outcome_group_id: Required. Specify the outcome group identifier.
Documentation: https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.subgroups.
- [Read global] action
-
Endpoint URL address:
/global/outcome_groups/{{=parameters.id}}/subgroups.The action has the following user-defined parameters:
- id: Required. Specify the outcome group identifier.
Documentation: https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.show.
- [Create] action
-
Endpoint URL address:
{{=item.context_type}}/outcome_groups/{{=item.id}}/subgroups.Documentation: https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.create.
The resource includes the fields from the OutcomeGroupT template.
Based on resource template Base.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/enrollments.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/enrollments.html#method.enrollments_api.index.
- [Read section] action
-
Endpoint URL address:
/courses/{{=parameters.section_id}}/enrollments.The action has the following user-defined parameters:
- section_id: Required. Specify section identifier.
Documentation: https://canvas.instructure.com/doc/api/enrollments.html#method.enrollments_api.index.
- [Read user] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/enrollments.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
Documentation: https://canvas.instructure.com/doc/api/enrollments.html#method.enrollments_api.index.
- [Read single] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/enrollments/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
- enrollment_id: Required. Specify grading enrollment identifier.
Documentation: https://canvas.instructure.com/doc/api/enrollments.html#method.enrollments_api.show.
- [Create] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/enrollments.Documentation: https://canvas.instructure.com/doc/api/enrollments.html#method.enrollments_api.create.
- [Delete] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/enrollments.The following request parameters will be automatically processed:
-
application/json:
{{={ task : item.task } }}
Documentation: https://canvas.instructure.com/doc/api/enrollments.html#method.enrollments_api.destroy.
-
application/json:
The resource includes the fields from the enrollmentT template.
- avatar_url
Template: avatarUrlT.
- uuid
Data type: DT_GUID
- task
Template: ShortText.
- group_ids
Template: LongText. A composite field.
- can_be_removed
Data type: DT_BOOL
- locked
Data type: DT_BOOL
- observed_users
Template: observeUserT.
- context_type
Template: ShortText.
- context_id
Data type: DT_I4
- action
Template: ShortText. Field components:
- Contains the following components: accept, reject, reactivate, last_attended.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/terms.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/enrollment_terms.html#method.terms_api.index.
- [Read single] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/terms/{{=parameters.term_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
- term_id: Required. Specify term identifier.
Documentation: https://canvas.instructure.com/doc/api/enrollment_terms.html#method.terms_api.show.
- [Create] action
-
Endpoint URL address:
/accounts/{{=item.account_id}}/terms.Documentation: https://canvas.instructure.com/doc/api/grading_standards.html#method.grading_standards_api.create.
- [Update] action
-
Endpoint URL address:
/accounts/{{=item.account_id}}/terms/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/enrollment_terms.html#method.terms.update.
- [Delete] action
-
Endpoint URL address:
/accounts/{{=item.account_id}}/terms/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/enrollment_terms.html#method.terms.destroy.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- start_at
Template: DateTime.
- end_at
Template: DateTime.
- created_at
Template: DateTime. A read-only field.
- workflow_state
Template: ShortText.
- grading_period_group_id
Data type: DT_I4
- sis_term_id
Template: ShortText.
- overrides
Field components:
- Contains the following components: StudentEnrollment, TeacherEnrollment.
- account_id
Data type: DT_I4
- analytics
A read-only field. Field components:
-
Uses template:
AccountActivityT. - Contains the following components: activity, statistics, statistics_by_subaccount.
-
Uses template:
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/eportfolios.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
Documentation: https://canvas.instructure.com/doc/api/e_portfolios.html#method.eportfolios_api.index.
- [Read single] action
-
Endpoint URL address:
/eportfolios/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Specify eportfolio identifier.
Documentation: https://canvas.instructure.com/doc/api/e_portfolios.html#method.eportfolios_api.show.
- [Create] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/enrollments.Documentation: https://canvas.instructure.com/doc/api/enrollments.html#method.enrollments_api.create.
- [Delete] action
-
Endpoint URL address:
/eportfolios/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/e_portfolios.html#method.eportfolios_api.delete.
- id
A key field. Data type: DT_I4
- user_id
Data type: DT_I4
- name
Template: ShortText.
- public
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- workflow_state
Template: ShortText.
- deleted_at
Template: DateTime.
- spam_status
Template: ShortText.
- context_type
Template: ShortText.
- context_id
Data type: DT_I4
- pages
The value is gathered from
/eportfolios/{{=item.id}}/pagesaddress. Field components:- An array.
- Contains the following components: id, eportfolio_id, position, name, content, created_at, updated_at.
- action
Template: ShortText. Field components:
- Contains the following components: restore.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/epub_exports.
The result is extracted from:{{=response.courses}}.Documentation: https://canvas.instructure.com/doc/api/e_pub_exports.html#method.epub_exports.index.
- [Read single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/epub_exports.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/e_pub_exports.html#method.epub_exports.show.
- [Create] action
-
Endpoint URL address:
/courses/{{=item.id}}/epub_exports.Documentation: https://canvas.instructure.com/doc/api/e_pub_exports.html#method.epub_exports.create.
- id
A key field. Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- attachment
Field components:
-
Uses template:
ShortText. - Contains the following components: url.
-
Uses template:
- progress_url
Template: ShortText.
- name
Template: ShortText.
- user_id
Data type: DT_I4
- workflow_state
Template: ShortText.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/error_reports.Documentation: https://canvas.instructure.com/doc/api/error_reports.html#method.errors.create.
- subject
Template: ShortText.
- comments
Template: ShortText.
- user_perceived_severity
Template: ShortText.
Template: ShortText.
- url
Template: ShortText.
- context_asset_string
Template: ShortText.
- user_roles
Template: ShortText.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/services/kaltura.
The result is extracted from:{{=[response]}}.Documentation: https://canvas.instructure.com/doc/api/error_reports.html#method.errors.create.
- domain
Template: ShortText.
- resource_domain
Template: ShortText.
- enable
Data type: DT_BOOL
- enable
Data type: DT_I4
- rtmp_domain
Template: ShortText.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/observees.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
Documentation: https://canvas.instructure.com/doc/api/user_observees.html#method.user_observees.index.
- [Read single] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/observees/{{=parameters.observee_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- observee_id: Required. Specify observee identifier.
Documentation: https://canvas.instructure.com/doc/api/user_observees.html#method.user_observees.show.
- [Update] action
-
Endpoint URL address:
/users/{{=item.parent_user_id}}/observees/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/user_observees.html#method.user_observees.update.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.parent_user_id}}/observees/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/user_observees.html#method.user_observees.destroy.
The resource includes the fields from the userT template.
- parent_user_id
Data type: DT_I4
- root_account_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/observers.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
Documentation: https://canvas.instructure.com/doc/api/user_observees.html#method.user_observees.observers.
- [Read single] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/observers/{{=parameters.observer_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- observer_id: Required. Specify observer identifier.
Documentation: https://canvas.instructure.com/doc/api/user_observees.html#method.user_observees.show_observer.
The resource includes the fields from the userT template.
- root_account_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/search/recipients.Documentation: https://canvas.instructure.com/doc/api/search.html#method.search.recipients.
The resource includes the fields from the RecipientT template.
Based on resource template Base.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/rubrics.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/rubrics.html#method.rubrics_api.index.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/rubrics.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/rubrics.html#method.rubrics_api.index.
- [Read course single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/rubrics/{{=parameters.rubric_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- rubric_id: Required. Specify rubric identifier.
Documentation: https://canvas.instructure.com/doc/api/rubrics.html#method.rubrics_api.show.
- [Read account single] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/rubrics/{{=parameters.rubric_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
- rubric_id: Required. Specify rubric identifier.
Documentation: https://canvas.instructure.com/doc/api/rubrics.html#method.rubrics_api.show.
- [Create] action
-
Endpoint URL address:
/courses/{{=item.context_id}}/rubrics.Documentation: https://canvas.instructure.com/doc/api/rubrics.html#method.rubrics.create.
- [Update] action
-
Endpoint URL address:
/courses/{{=item.context_id}}/rubrics/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/rubrics.html#method.rubrics.update.
- [Delete] action
-
Endpoint URL address:
/courses/{{=item.context_id}}/rubrics/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/rubrics.html#method.rubrics.destroy.
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- context_id
Data type: DT_I4
- context_type
Template: ShortText.
- points_possible
Data type: DT_I4
- reusable
Data type: DT_BOOL
- read_only
Data type: DT_BOOL
- public
Data type: DT_BOOL
- free_form_criterion_comments
Data type: DT_BOOL
- hide_score_total
Data type: DT_BOOL
- data
Field components:
- An array.
- Contains the following components: id, description, long_description, points, criterion_use_range, ratings.
- assessments
Field components:
- An array.
-
Uses template:
rubricAssessmentT.
- associations
Field components:
- An array.
-
Uses template:
rubricAssociationT.
- account_associations
Field components:
- An array.
-
Uses template:
accountT.
- course_associations
Field components:
- An array.
-
Uses template:
courseT.
Based on resource template General.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/rubrics/{{=parameters.rubric_id}}.
The result is extracted from:{{=response.assessments}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- rubric_id: Required. Specify rubric identifier.
The following request parameters will be automatically processed:
-
include[]:
assessments
Documentation: https://canvas.instructure.com/doc/api/rubrics.html#method.rubrics_api.show.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/rubrics/{{=parameters.rubric_id}}.
The result is extracted from:{{=response.assessments}}.
The result is paginated.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
- rubric_id: Required. Specify rubric identifier.
The following request parameters will be automatically processed:
-
include[]:
assessments
Documentation: https://canvas.instructure.com/doc/api/rubrics.html#method.rubrics_api.show.
- [Create] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/rubric_associations/{{=item.rubric_association_id}}/rubric_assessments.Documentation: https://canvas.instructure.com/doc/api/rubrics.html#method.rubric_assessments.create.
- [Update] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/rubric_associations/{{=item.rubric_association_id}}/rubric_assessments/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/submissions.html#method.submissions_api.update.
- [Delete] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/rubric_associations/{{=item.rubric_association_id}}/rubric_assessments/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/rubrics.html#method.rubric_assessments.destroy.
The resource includes the fields from the rubricAssessmentT template.
- course_id
Data type: DT_I4
Based on resource template Base.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/rubrics/{{=parameters.rubric_id}}.
The result is extracted from:{{=response.associations}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- rubric_id: Required. Specify rubric identifier.
The following request parameters will be automatically processed:
-
include[]:
associations
Documentation: https://canvas.instructure.com/doc/api/rubrics.html#method.rubrics_api.show.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/rubrics/{{=parameters.rubric_id}}.
The result is extracted from:{{=response.associations}}.
The result is paginated.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
- rubric_id: Required. Specify rubric identifier.
The following request parameters will be automatically processed:
-
include[]:
associations
Documentation: https://canvas.instructure.com/doc/api/rubrics.html#method.rubrics_api.show.
- [Create] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/rubric_associations.Documentation: https://canvas.instructure.com/doc/api/rubrics.html#method.rubric_associations.create.
- [Update] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/rubric_associations/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/rubrics.html#method.rubric_associations.update.
- [Delete] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/rubric_associations/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/rubrics.html#method.rubric_associations.destroy.
The resource includes the fields from the rubricAssociationT template.
- course_id
Data type: DT_I4
Based on resource template General.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/discussion_topics.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/discussion_topics.html#method.discussion_topics_api.show.
- [Read group] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/discussion_topics.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
Documentation: https://canvas.instructure.com/doc/api/discussion_topics.html#method.discussion_topics_api.show.
- [Read course single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/discussion_topics/{{=parameters.topic_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- topic_id: Required. Specify topic identifier.
Documentation: https://canvas.instructure.com/doc/api/discussion_topics.html#method.discussion_topics_api.show.
- [Read group single] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/discussion_topics/{{=parameters.topic_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
- topic_id: Required. Specify topic identifier.
Documentation: https://canvas.instructure.com/doc/api/discussion_topics.html#method.discussion_topics_api.show.
- [Create] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/discussion_topics.Documentation: https://canvas.instructure.com/doc/api/discussion_topics.html#method.discussion_topics.create.
- [Update] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/discussion_topics/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/discussion_topics.html#method.discussion_topics.update.
- [Delete] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/discussion_topics/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/discussion_topics.html#method.discussion_topics.destroy.
The resource includes the fields from the discussionTopicT template.
- context_type
Template: ShortText.
- context_id
Data type: DT_I4
- topic_entires
The value is gathered from
/{{=Canvas.getContextType(parameters)}}/{{=Canvas.getContextId(parameters)}}/discussion_topics/{{=item.id}}/entriesaddress. Field components:- An array.
-
Uses template:
topicEntryT.
- full
The value is gathered from
/{{=Canvas.getContextType(parameters)}}/{{=Canvas.getContextId(parameters)}}/discussion_topics/{{=item.id}}/viewaddress. The gathered value is processed with{{=response[field.name]}}expression. Field components:-
Uses template:
LongText. - Contains the following components: unread_entries, entry_ratings, forced_entries, participants, view.
-
Uses template:
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: read, read_all, unread, unread_all, subscribed, unsubscribed.
-
Uses template:
Based on resource template General.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/discussion_topics/{{=parameters.topic_id}}/entry_list.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- topic_id: Required. Specify topic identifier.
Documentation: https://canvas.instructure.com/doc/api/discussion_topics.html#method.discussion_topics_api.entry_list.
- [Read group] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/discussion_topics/{{=parameters.topic_id}}/entry_list.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
- topic_id: Required. Specify topic identifier.
Documentation: https://canvas.instructure.com/doc/api/discussion_topics.html#method.discussion_topics_api.entry_list.
- [Create] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/discussion_topics/{{=item.parent_id}}/entries.Documentation: https://canvas.instructure.com/doc/api/discussion_topics.html#method.discussion_topics_api.add_entry.
- [Update] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/discussion_topics/{{=item.parent_id}}/entries/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/discussion_topics.html#method.discussion_entries.update.
- [Delete] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/discussion_topics/{{=item.parent_id}}/entries/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/discussion_topics.html#method.discussion_entries.destroy.
The resource includes the fields from the topicEntryT template.
- content
Data type: DT_IMAGE
- filename
Template: ShortText.
- context_type
Template: ShortText.
- context_id
Data type: DT_I4
- replies
The value is gathered from
/{{=Canvas.getContextType(parameters)}}/{{=Canvas.getContextId(parameters)}}/discussion_topics/{{=parameters.topic_id}}/entries/{{=item.id}}/repliesaddress. Field components:- An array.
-
Uses template:
topicEntryT.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: read, unread, ratingEntry.
-
Uses template:
Based on resource template General.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments/{{=parameters.assignment_id}}/peer_reviews.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- assignment_id: Required. Specify assignment identifier.
Documentation: https://canvas.instructure.com/doc/api/peer_reviews.html#method.peer_reviews_api.index.
- [Read section] action
-
Endpoint URL address:
/sections/{{=Canvas.UI.SectionEditor.getValue(parameters)}}/assignments/{{=parameters.assignment_id}}/peer_reviews.The action has the following user-defined parameters:
- section_id: Required. Specify section identifier.
- assignment_id: Required. Specify assignment identifier.
Documentation: https://canvas.instructure.com/doc/api/peer_reviews.html#method.peer_reviews_api.index.
- [Read course single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments/{{=parameters.assignment_id}}/submissions/{{=parameters.submission_id}}/peer_reviews.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- assignment_id: Required. Specify assignment identifier.
- submission_id: Required. Specify submission identifier.
Documentation: https://canvas.instructure.com/doc/api/peer_reviews.html#method.peer_reviews_api.index.
- [Read section single] action
-
Endpoint URL address:
/sections/{{=Canvas.UI.SectionEditor.getValue(parameters)}}/assignments/{{=parameters.assignment_id}}/submissions/{{=parameters.submission_id}}/peer_reviews.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- section_id: Required. Specify section identifier.
- assignment_id: Required. Specify assignment identifier.
- submission_id: Required. Specify submission identifier.
Documentation: https://canvas.instructure.com/doc/api/peer_reviews.html#method.peer_reviews_api.index.
- [Create] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/assignments/{{=item.assignment_id}}/submissions/{{=item.submission_id}}/peer_reviews.Documentation: https://canvas.instructure.com/doc/api/peer_reviews.html#method.peer_reviews_api.index.
- [Delete] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/assignments/{{=item.assignment_id}}/submissions/{{=item.submission_id}}/peer_reviews.Documentation: https://canvas.instructure.com/doc/api/peer_reviews.html#method.peer_reviews_api.destroy.
- id
A key field. Data type: DT_I4
- assessor_id
Data type: DT_I4
- asset_id
Data type: DT_I4
- asset_type
Template: ShortText.
- user_id
Data type: DT_I4
- workflow_state
Template: ShortText.
- user
Template: userT.
- assessor
Template: ShortText.
- submission_comments
Field components:
- An array.
-
Uses template:
submissionCommentT.
- context_type
Template: ShortText.
- context_id
Data type: DT_I4
- assignment_id
Data type: DT_I4
- submission_id
Data type: DT_I4
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/roles.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/roles.html#method.role_overrides.api_index.
- [Read single] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/roles/{{=parameters.role_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
- role_id: Required. Specify role identifier.
Documentation: https://canvas.instructure.com/doc/api/roles.html#method.role_overrides.show.
- [Create] action
-
Endpoint URL address:
/accounts/{{=item.account_id}}/roles.Documentation: https://canvas.instructure.com/doc/api/roles.html#method.role_overrides.add_role.
- [Update] action
-
Endpoint URL address:
/accounts/{{=item.account_id}}/roles/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/roles.html#method.role_overrides.update.
- id
A key field. Template: ShortText.
- label
Template: ShortText.
- role
A key field. Template: ShortText.
- base_role_type
Template: ShortText.
- account
Template: accountT.
- workflow_state
Template: ShortText.
- permissions
Field components:
-
Uses template:
readPermissionT. - Contains the following components: read_course_content, read_course_list, read_question_banks, read_reports.
-
Uses template:
- account_id
Data type: DT_I4
- action
Template: ShortText. Field components:
- Contains the following components: activate, deactivate.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/calendar_events.Documentation: https://canvas.instructure.com/doc/api/rubrics.html#method.rubrics_api.index.
- [Read single] action
-
Endpoint URL address:
/calendar_events/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Specify the identifier.
Documentation: https://canvas.instructure.com/doc/api/calendar_events.html#method.calendar_events_api.show.
- [Read user] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/calendar_events.The action has the following user-defined parameters:
- user_id: Required. Specify the user identifier.
Documentation: https://canvas.instructure.com/doc/api/calendar_events.html#method.calendar_events_api.user_index.
- [Read self upcoming] action
-
Endpoint URL address:
/users/self/upcoming_events.Documentation: https://canvas.instructure.com/doc/api/users.html#method.users.upcoming_events.
- [Read next_appointment] action
-
Endpoint URL address:
/appointment_groups/next_appointment.Documentation: https://canvas.instructure.com/doc/api/appointment_groups.html#method.appointment_groups.next_appointment.
- [Create] action
-
Endpoint URL address:
/calendar_events.Documentation: https://canvas.instructure.com/doc/api/calendar_events.html#method.calendar_events_api.create.
- [Update] action
-
Endpoint URL address:
/calendar_events/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/calendar_events.html#method.calendar_events_api.update.
- [Delete] action
-
Endpoint URL address:
/calendar_events/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{=application/json}}
Documentation: https://canvas.instructure.com/doc/api/calendar_events.html#method.calendar_events_api.destroy.
-
application/json:
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- start_at
Template: DateTime.
- end_at
Template: DateTime.
- description
Template: ShortText.
- location_name
Template: ShortText.
- location_address
Template: ShortText.
- context_code
Template: ShortText.
- effective_context_code
Template: ShortText.
- context_name
Template: ShortText.
- cancel_reason
Template: ShortText.
- all_context_codes
Template: ShortText.
- workflow_state
Template: ShortText.
- hidden
Data type: DT_BOOL
- parent_event_id
Template: ShortText.
- child_events_count
Data type: DT_I4
- child_events
Template: ShortText.
- url
Template: ShortText.
- html_url
Template: ShortText.
- all_day_date
Template: ShortText.
- all_day
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- appointment_group_id
Template: ShortText.
- appointment_group_url
Template: ShortText.
- own_reservation
Data type: DT_BOOL
- reserve_url
Template: ShortText.
- reserved
Data type: DT_BOOL
- participant_type
Template: ShortText.
- participants_per_appointment
Template: ShortText.
- available_slots
Template: ShortText.
- user
Template: userT.
- group
Template: groupT.
- important_dates
Data type: DT_BOOL
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/calendar_events/timetable.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/calendar_events.html#method.calendar_events_api.get_course_timetable.
- [Create] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/calendar_events/timetable.The following request parameters will be automatically processed:
-
application/json:
{{={ timetables : { all : [item] } } }}
Documentation: https://canvas.instructure.com/doc/api/calendar_events.html#method.calendar_events_api.set_course_timetable.
-
application/json:
- id
A key field. Data type: DT_I4
- weekdays
Template: ShortText.
- start_time
Template: ShortText.
- end_time
Template: ShortText.
- location_name
Template: ShortText.
- course_start_at
Template: DateTime.
- course_end_at
Template: DateTime.
- course_id
Data type: DT_I4
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/progress/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. Specify the identifier.
Documentation: https://canvas.instructure.com/doc/api/progress.html#method.progress.show.
The resource includes the fields from the progressT template.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/planner/items.Documentation: https://canvas.instructure.com/doc/api/planner.html#method.planner.index.
- context_type
Template: ShortText.
- user_id
Data type: DT_I4
- plannable_id
A key field. Data type: DT_I4
- planner_override
Template: plannerOverrideT.
- plannable_type
Template: ShortText.
- new_activity
Data type: DT_BOOL
- submissions
Data type: DT_BOOL
- plannable_date
Template: DateTime. A read-only field.
- plannable
Field components:
-
Uses template:
ShortText. - Contains the following components: id, title, location_name, created_at, updated_at, all_day, location_address, description, start_at, end_at.
-
Uses template:
- html_url
Template: ShortText.
- context_name
Template: ShortText.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/planner_notes.Documentation: https://canvas.instructure.com/doc/api/planner.html#method.planner_notes.index.
- [Read single] action
-
Endpoint URL address:
/planner_notes/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Specify planner note identifier.
Documentation: https://canvas.instructure.com/doc/api/planner.html#PlannerNote.
- [Create] action
-
Endpoint URL address:
/planner_notes.Documentation: https://canvas.instructure.com/doc/api/planner.html#method.planner_notes.create.
- [Update] action
-
Endpoint URL address:
/planner_notes/{{=parameters.id}}.Documentation: https://canvas.instructure.com/doc/api/planner.html#method.planner_notes.update.
- [Delete] action
-
Endpoint URL address:
/planner_notes/{{=parameters.id}}.Documentation: https://canvas.instructure.com/doc/api/planner.html#method.planner_notes.destroy.
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- description
Template: ShortText.
- user_id
Data type: DT_I4
- workflow_state
Template: ShortText.
- course_id
Data type: DT_I4
- todo_date
Template: DateTime.
- linked_object_type
Template: ShortText.
- linked_object_id
Data type: DT_I4
- linked_object_html_url
Template: ShortText.
- linked_object_url
Template: ShortText.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/planner/overrides.Documentation: https://canvas.instructure.com/doc/api/planner.html#method.planner_overrides.index.
- [Read single] action
-
Endpoint URL address:
/planner/overrides/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Specify planner override identifier.
Documentation: https://canvas.instructure.com/doc/api/planner.html#method.planner_overrides.show.
- [Create] action
-
Endpoint URL address:
/planner/overrides.Documentation: https://canvas.instructure.com/doc/api/planner.html#method.planner_overrides.create.
- [Update] action
-
Endpoint URL address:
/planner/overrides/{{=parameters.id}}.Documentation: https://canvas.instructure.com/doc/api/planner.html#method.planner_overrides.update.
- [Delete] action
-
Endpoint URL address:
/planner/overrides/{{=parameters.id}}.Documentation: https://canvas.instructure.com/doc/api/planner.html#method.planner_overrides.destroy.
- id
A key field. Data type: DT_I4
- plannable_type
Template: ShortText.
- plannable_id
Data type: DT_I4
- user_id
Data type: DT_I4
- assignment_id
Data type: DT_I4
- workflow_state
Template: ShortText.
- marked_complete
Data type: DT_BOOL
- dismissed
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/polls.
The result is extracted from:{{=response.polls}}.Documentation: https://canvas.instructure.com/doc/api/polls.html#method.polling/polls.index.
- [Read single] action
-
Endpoint URL address:
/polls/{{=parameters.id}}.
The result is extracted from:{{=response.polls}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Specify poll identifier.
Documentation: https://canvas.instructure.com/doc/api/polls.html#method.polling/polls.show.
- [Create] action
-
Endpoint URL address:
/polls.The following request parameters will be automatically processed:
-
application/json:
{{={ polls : [item] } }}
Documentation: https://canvas.instructure.com/doc/api/polls.html#method.polling/polls.create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/polls/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ polls : [item] } }}
Documentation: https://canvas.instructure.com/doc/api/polls.html#method.polling/polls.update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/polls/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/polls.html#method.polling/polls.destroy.
- id
A key field. Data type: DT_I4
- question
Template: ShortText.
- description
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- user_id
Data type: DT_I4
- total_results
Template: NameValueT.
- choices
The gathered value is processed with
{{=connection.resourceManager['Poll | Choice'].getData({ parameters: ['poll_id=' + item.id] })}}expression. Field components:- An array.
- Contains the following components: id, poll_id, is_correct, text, position.
- sessions
The gathered value is processed with
{{=connection.resourceManager['Poll | Session'].getData({ parameters: ['poll_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
PollSessionT.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/polls/{{=parameters.poll_id}}/poll_choices.
The result is extracted from:{{=response.poll_choices}}.The action has the following user-defined parameters:
- poll_id: Required. Specify poll identifier.
Documentation: https://canvas.instructure.com/doc/api/poll_choices.html#method.polling/poll_choices.index.
- [Read single] action
-
Endpoint URL address:
/polls/{{=parameters.poll_id}}/poll_choices/{{=parameters.choice_id}}.
The result is extracted from:{{=response.poll_choices}}.
The result is paginated.The action has the following user-defined parameters:
- poll_id: Required. Specify poll identifier.
- choice_id: Required. Specify poll choice identifier.
Documentation: https://canvas.instructure.com/doc/api/poll_choices.html#method.polling/poll_choices.show.
- [Create] action
-
Endpoint URL address:
/polls/{{=item.poll_id}}/poll_choices.The following request parameters will be automatically processed:
-
application/json:
{{={ poll_choices : [item] } }}
Documentation: https://canvas.instructure.com/doc/api/poll_choices.html#method.polling/poll_choices.create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/polls/{{=item.poll_id}}/poll_choices/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ poll_choices : [item] } }}
Documentation: https://canvas.instructure.com/doc/api/poll_choices.html#method.polling/poll_choices.update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/polls/{{=item.poll_id}}/poll_choices/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/poll_choices.html#method.polling/poll_choices.destroy.
- id
A key field. Data type: DT_I4
- poll_id
Data type: DT_I4
- is_correct
Data type: DT_BOOL
- text
Template: ShortText.
- position
Data type: DT_I4
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/polls/{{=parameters.poll_id}}/poll_sessions.
The result is extracted from:{{=response.poll_sessions}}.The action has the following user-defined parameters:
- poll_id: Required. Specify poll identifier.
Documentation: https://canvas.instructure.com/doc/api/poll_sessions.html#method.polling/poll_sessions.index.
- [Read single] action
-
Endpoint URL address:
/polls/{{=parameters.poll_id}}/poll_sessions/{{=parameters.session_id}}.
The result is extracted from:{{=response.poll_choices}}.
The result is paginated.The action has the following user-defined parameters:
- poll_id: Required. Specify poll identifier.
- session_id: Required. Specify poll session identifier.
Documentation: https://canvas.instructure.com/doc/api/poll_sessions.html#method.polling/poll_sessions.show.
- [Create] action
-
Endpoint URL address:
/polls/{{=item.poll_id}}/poll_sessions.The following request parameters will be automatically processed:
-
application/json:
{{={ poll_sessions : [item] } }}
Documentation: https://canvas.instructure.com/doc/api/poll_sessions.html#method.polling/poll_sessions.create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/polls/{{=item.poll_id}}/poll_sessions/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ poll_sessions : [item] } }}
Documentation: https://canvas.instructure.com/doc/api/poll_sessions.html#method.polling/poll_sessions.update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/polls/{{=item.poll_id}}/poll_sessions/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/poll_sessions.html#method.polling/poll_sessions.destroy.
The resource includes the fields from the PollSessionT template.
- action
Template: ShortText. Field components:
- Contains the following components: open, close.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/polls/{{=parameters.poll_id}}/poll_sessions/{{=parameters.session_id}}.
The result is extracted from:{{=response.poll_submissions}}.The action has the following user-defined parameters:
- poll_id: Required. Specify poll identifier.
- session_id: Required. Specify poll session identifier.
Documentation: https://canvas.instructure.com/doc/api/poll_sessions.html#method.polling/poll_sessions.show.
- [Read single] action
-
Endpoint URL address:
/polls/{{=parameters.poll_id}}/poll_sessions/{{=parameters.session_id}}/poll_submissions/{{=parameters.submission_id}}.
The result is extracted from:{{=response.poll_submissions}}.The action has the following user-defined parameters:
- poll_id: Required. Specify poll identifier.
- session_id: Required. Specify poll session identifier.
- submission_id: Required. Specify poll submission identifier.
Documentation: https://canvas.instructure.com/doc/api/poll_submissions.html#method.polling/poll_submissions.show.
- [Create] action
-
Endpoint URL address:
/polls/{{=item.poll_id}}/poll_sessions/{{=item.session_id}}/poll_submissions.The following request parameters will be automatically processed:
-
application/json:
{{={ poll_submissions : [item] } }}
Documentation: https://canvas.instructure.com/doc/api/poll_submissions.html#method.polling/poll_submissions.create.
-
application/json:
- id
A key field. Data type: DT_I4
- poll_choice_id
Data type: DT_I4
- user_id
Data type: DT_I4
- course_section_id
Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- poll_id
Data type: DT_I4
- session_id
Data type: DT_I4
Based on resource template General.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/outcome_proficiency.
The result is extracted from:{{=response.ratings}}.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/proficiency_ratings.html#method.outcome_proficiency_api.show.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/outcome_proficiency.
The result is extracted from:{{=response.ratings}}.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/proficiency_ratings.html#method.outcome_proficiency_api.show.
- [Create] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/outcome_proficiency.The following request parameters will be automatically processed:
-
application/json:
{{={ ratings : [item] } }}
Documentation: https://canvas.instructure.com/doc/api/proficiency_ratings.html#method.outcome_proficiency_api.create.
-
application/json:
The resource includes the fields from the ratingT template.
- context_type
Template: ShortText.
- context_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/quizzes.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/quizzes.html#method.quizzes/quizzes_api.index.
- [Read single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/quizzes/{{=Canvas.UI.QuizzEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- quiz_id: Required. Specify quiz identifier.
Documentation: https://canvas.instructure.com/doc/api/quizzes.html#method.quizzes/quizzes_api.index.
- [Create] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/quizzes.Documentation: https://canvas.instructure.com/doc/api/quizzes.html#method.quizzes/quizzes_api.create.
- [Update] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/quizzes/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/quizzes.html#method.quizzes/quizzes_api.update.
- [Delete] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/quizzes/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/quizzes.html#method.quizzes/quizzes_api.create.
The resource includes the fields from the quizzT template.
- course_id
Data type: DT_I4
- reports
The value is gathered from
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/quizzes/{{=item.id}}/reportsaddress. Field components:- An array.
- Contains the following components: id, quiz_id, report_type, readable_type, includes_all_versions, anonymous, generatable, created_at, updated_at, url, progress_url, progress, file.
- quiz_ip_filters
The value is gathered from
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/quizzes/{{=item.id}}/ip_filtersaddress. The gathered value is processed with{{=response.quiz_ip_filters}}expression. Field components:- An array.
- Contains the following components: name, account, filter.
- statistics
The value is gathered from
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/quizzes/{{=item.id}}/statisticsaddress. The gathered value is processed with{{=response.quiz_statistics}}expression. Field components:- An array.
- Contains the following components: id, url, html_url, anonymous_survey, multiple_attempts_exist, generated_at, includes_all_versions, includes_sis_ids, points_possible, anonymous_survey, speed_grader_url, quiz_submissions_zip_url, question_statistics, submission_statistics, links.
- action
Field components:
- Contains the following components: report_delete, set_extensions, send_message.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/quizzes/{{=Canvas.UI.QuizzEditor.getValue(parameters)}}/questions.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- quiz_id: Required. Specify quiz identifier.
Documentation: https://canvas.instructure.com/doc/api/quiz_questions.html#method.quizzes/quiz_questions.index.
- [Read single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/quizzes/{{=Canvas.UI.QuizzEditor.getValue(parameters)/questions/{{=parameters.question_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- quiz_id: Required. Specify quiz identifier.
- question_id: Required. Specify question identifier.
Documentation: https://canvas.instructure.com/doc/api/quiz_questions.html#method.quizzes/quiz_questions.show.
- [Create] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/quizzes/{{=item.quiz_id}}/questions.Documentation: https://canvas.instructure.com/doc/api/quiz_questions.html#method.quizzes/quiz_questions.create.
- [Update] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/quizzes/{{=item.quiz_id}}/questions/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/quiz_questions.html#method.quizzes/quiz_questions.update.
- [Delete] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/quizzes/{{=item.quiz_id}}/questions/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/quiz_questions.html#method.quizzes/quiz_questions.destroy.
- id
A key field. Data type: DT_I4
- quiz_id
Data type: DT_I4
- quiz_group_id
Data type: DT_I4
- assessment_question_id
Data type: DT_I4
- position
Template: ShortText.
- question_name
Template: ShortText.
- question_type
Template: ShortText.
- question_text
Template: ShortText.
- points_possible
Data type: DT_I4
- correct_comments
Template: ShortText.
- incorrect_comments
Template: ShortText.
- neutral_comments
Template: ShortText.
- correct_comments_html
Template: ShortText.
- incorrect_comments_html
Template: ShortText.
- neutral_comments_html
Template: ShortText.
- variables
Template: ShortText.
- formulas
Template: ShortText.
- answer_tolerance
Template: ShortText.
- formula_decimal_places
Template: ShortText.
- matches
Template: ShortText.
- matching_answer_incorrect_matches
Template: ShortText.
- answers
Field components:
- An array.
- Contains the following components: id, answer_text, answer_weight, answer_comments, text_after_answers, answer_match_left, answer_match_right, matching_answer_incorrect_matches, numerical_answer_type, exact, margin, approximate, precision, start, end, blank_id.
- course_id
Data type: DT_I4
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/quizzes/{{=Canvas.UI.QuizzEditor.getValue(parameters)/groups/{{=parameters.group_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- quiz_id: Required. Specify quiz identifier.
- group_id: Required. Specify group identifier.
Documentation: https://canvas.instructure.com/doc/api/quiz_question_groups.html#method.quizzes/quiz_groups.show.
- [Create] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/quizzes/{{=item.quiz_id}}/groups.The following request parameters will be automatically processed:
-
application/json:
{{={ quiz_groups : [item] } }}
Documentation: https://canvas.instructure.com/doc/api/quiz_question_groups.html#method.quizzes/quiz_groups.create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/quizzes/{{=item.quiz_id}}/groups/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ quiz_groups : [item] } }}
Documentation: https://canvas.instructure.com/doc/api/quiz_question_groups.html#method.quizzes/quiz_groups.update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/quizzes/{{=item.quiz_id}}/groups/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/quiz_question_groups.html#method.quizzes/quiz_groups.destroy.
- id
A key field. Data type: DT_I4
- quiz_id
Data type: DT_I4
- name
Template: ShortText.
- pick_count
Data type: DT_I4
- question_points
Data type: DT_I4
- assessment_question_bank_id
Data type: DT_I4
- position
Data type: DT_I4
- course_id
Data type: DT_I4
- action
Field components:
- Contains the following components: reorder.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/quizzes/{{=Canvas.UI.QuizzEditor.getValue(parameters)}}/submissions.
The result is extracted from:{{=response.quiz_submissions}}.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- quiz_id: Required. Specify quiz identifier.
Documentation: https://canvas.instructure.com/doc/api/quiz_submissions.html#method.quizzes/quiz_submissions_api.index.
- [Read single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/quizzes/{{=Canvas.UI.QuizzEditor.getValue(parameters)}}/submissions/{{=parameters.submission_id}}.
The result is extracted from:{{=response.quiz_submissions}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- quiz_id: Required. Specify quiz identifier.
- submission_id: Required. Specify submission identifier.
Documentation: https://canvas.instructure.com/doc/api/quiz_submissions.html#method.quizzes/quiz_submissions_api.submission.
- [Create] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/quizzes/{{=item.quiz_id}}/submissions.The following request parameters will be automatically processed:
-
application/json:
{{={ quiz_submissions : [item] } }}
Documentation: https://canvas.instructure.com/doc/api/quiz_submissions.html#Manual+Scoring-appendix.
-
application/json:
- [Update] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/quizzes/{{=item.quiz_id}}/submissions/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ quiz_submissions : [item] } }}
Documentation: https://canvas.instructure.com/doc/api/quiz_question_groups.html#method.quizzes/quiz_groups.update.
-
application/json:
- id
A key field. Data type: DT_I4
- quiz_id
Data type: DT_I4
- user_id
Data type: DT_I4
- submission_id
Data type: DT_I4
- started_at
Template: DateTime.
- finished_at
Template: DateTime.
- end_at
Template: DateTime.
- comment
Template: ShortText.
- attempt
Data type: DT_I4
- extra_attempts
Data type: DT_I4
- extra_time
Data type: DT_I4
- manually_unlocked
Data type: DT_BOOL
- time_spent
Data type: DT_I4
- score
Data type: DT_I4
- score_before_regrade
Data type: DT_I4
- kept_score
Data type: DT_I4
- fudge_points
Data type: DT_I4
- has_seen_results
Data type: DT_BOOL
- workflow_state
Template: ShortText.
- overdue_and_needs_submission
Data type: DT_BOOL
- course_id
Data type: DT_I4
- validation_token
Template: ShortText.
- timing_data
The value is gathered from
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/quizzes/{{=item.quiz_id}}/submissions/{{=item.id}}/timeaddress. The gathered value is processed with{{=response[field.name]}}expression. Field components:-
Uses template:
DateTime. - Contains the following components: end_at, time_left.
-
Uses template:
- questions
The value is gathered from
/quiz_submissions/{{=item.id}}/questionsaddress. The gathered value is processed with{{=response.quiz_submission_questions}}expression. The value is sent to/quiz_submissions/{{=item.id}}/questionsaddress. Field components:- An array.
- Contains the following components: id, flagged, answer, answers, formatted_answer.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/quizzes/{{=Canvas.UI.QuizzEditor.getValue(parameters)}}/submissions.
The result is extracted from:{{=Canvas.getQuizzSubmissionData(response.quiz_submissions, resource.getFields(parameters))}}.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- quiz_id: Required. Specify quiz identifier.
Documentation: https://canvas.instructure.com/doc/api/quiz_submissions.html#method.quizzes/quiz_submissions_api.index.
- id
A key field. Data type: DT_I4
- [External]
-
The external fields URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/quizzes/{{=Canvas.UI.QuizzEditor.getValue(parameters)}}/questions.- {{=Canvas.getQuizzQuestionFieldName(external.question_text || external.id)}}
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/conferences.
The result is extracted from:{{=response.conferences}}.Documentation: https://canvas.instructure.com/doc/api/conferences.html.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/conferences.
The result is extracted from:{{=response.conferences}}.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/conferences.html#method.conferences.index.
- [Read group] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/conferences.
The result is extracted from:{{=response.conferences}}.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
Documentation: https://canvas.instructure.com/doc/api/conferences.html#method.conferences.index.
- id
A key field. Data type: DT_I4
- conference_type
Template: ShortText.
- conference_key
Template: ShortText.
- description
Template: ShortText.
- duration
Data type: DT_I4
- ended_at
Template: DateTime.
- started_at
Template: DateTime.
- title
Template: ShortText.
- users
Template: LongText. A composite field.
- has_advanced_settings
Data type: DT_BOOL
- long_running
Data type: DT_BOOL
- user_settings
Field components:
-
Uses template:
DateTime. - Contains the following components: record, scheduled_date, create_time.
-
Uses template:
- recordings
Field components:
- An array.
- Contains the following components: duration_minutes, title, updated_at, created_at, playback_url.
- url
Template: ShortText.
- join_url
Template: ShortText.
- context_type
Template: ShortText.
- context_id
Template: ShortText.
Based on resource template Base.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/collaborations.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/collaborations.html#Collaboration.
- [Read group] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/collaborations.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
Documentation: https://canvas.instructure.com/doc/api/collaborations.html#Collaboration.
- id
A key field. Data type: DT_I4
- collaboration_type
Template: ShortText.
- document_id
Template: ShortText.
- user_id
Data type: DT_I4
- context_id
Data type: DT_I4
- context_type
Template: ShortText.
- url
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- description
Template: ShortText.
- title
Template: ShortText.
- type
Template: ShortText.
- update_url
Template: ShortText.
- user_name
Template: ShortText.
- members
The value is gathered from
/collaborations/{{=item.id}}/membersaddress. Field components:- An array.
- Contains the following components: id, type, name, collaborator_lti_id, avatar_image_url.
- potential_collaborators
The value is gathered from
/{{=Canvas.getContextType(parameters)}}/{{=Canvas.getContextId(parameters)}}/potential_collaboratorsaddress. Field components:- An array.
-
Uses template:
userT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/comm_messages.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
The following request parameters will be automatically processed:
-
user_id:
{{=parameters.user_id}}
Documentation: https://canvas.instructure.com/doc/api/comm_messages.html.
- id
A key field. Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- sent_at
Template: DateTime.
- workflow_state
Template: ShortText.
- from
Template: ShortText.
- from_name
Template: ShortText.
- to
Template: ShortText.
- reply_to
Template: ShortText.
- subject
Template: ShortText.
- body
Template: LongText.
- html_body
Template: ShortText.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/users/self/bookmarks.Documentation: https://canvas.instructure.com/doc/api/bookmarks.html#method.bookmarks/bookmarks.index.
- [Read single] action
-
Endpoint URL address:
/users/self/bookmarks/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Specify bookmark identifier.
Documentation: https://canvas.instructure.com/doc/api/bookmarks.html#method.bookmarks/bookmarks.show.
- [Create] action
-
Endpoint URL address:
/users/self/bookmarks.Documentation: https://canvas.instructure.com/doc/api/bookmarks.html#method.bookmarks/bookmarks.create.
- [Update] action
-
Endpoint URL address:
/users/self/bookmarks/{{=parameters.id}}.Documentation: https://canvas.instructure.com/doc/api/bookmarks.html#method.bookmarks/bookmarks.update.
- [Delete] action
-
Endpoint URL address:
/users/self/bookmarks/{{=parameters.id}}.Documentation: https://canvas.instructure.com/doc/api/bookmarks.html#method.bookmarks/bookmarks.destroy.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- url
Template: ShortText.
- position
Data type: DT_I4
- data
Field components:
- Contains the following components: active_tab.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/brand_variables.
The result is extracted from:{{={{=_.map(response, function(v, k) { return { name: k, value: v }; })}}}}.Documentation: https://canvas.instructure.com/doc/api/brand_configs.html#method.brand_configs_api.show.
- name
Template: ShortText.
- value
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/communication_channels.The action has the following user-defined parameters:
- user_id: Required. Specify the user identifier.
Documentation: https://canvas.instructure.com/doc/api/communication_channels.html#method.communication_channels.index.
- [Create] action
-
Endpoint URL address:
/users/{{=item.user_id}}/communication_channels.Documentation: https://canvas.instructure.com/doc/api/communication_channels.html#method.communication_channels.create.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.user_id}}/communication_channels/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/communication_channels.html#method.communication_channels.destroy.
- id
A key field. Data type: DT_I4
- address
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- type
Template: ShortText.
- position
Data type: DT_I4
- user_id
Data type: DT_I4
- workflow_state
Template: ShortText.
Based on resource template General.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/content_exports.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/content_exports.html#method.content_exports_api.index.
- [Read group] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/content_exports.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
Documentation: https://canvas.instructure.com/doc/api/content_exports.html#method.content_exports_api.index.
- [Read user] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/content_exports.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
Documentation: https://canvas.instructure.com/doc/api/content_exports.html#method.content_exports_api.index.
- [Read course single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/content_exports/{{=parameters.context_export_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- context_export_id: Required. Specify content export identifier.
Documentation: https://canvas.instructure.com/doc/api/peer_reviews.html#method.peer_reviews_api.index.
- [Read group single] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/content_exports/{{=parameters.context_export_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
- context_export_id: Required. Specify content export identifier.
Documentation: https://canvas.instructure.com/doc/api/peer_reviews.html#method.peer_reviews_api.index.
- [Read user single] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/content_exports/{{=parameters.context_export_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- context_export_id: Required. Specify content export identifier.
Documentation: https://canvas.instructure.com/doc/api/peer_reviews.html#method.peer_reviews_api.index.
- [Create] action
-
Endpoint URL address:
/{{=item.context_type}}/{{=item.context_id}}/content_exports.
The action uses POST method.The following request parameters will be automatically processed:
-
params:
{{=item}}
Documentation: https://canvas.instructure.com/doc/api/content_exports.html#method.content_exports_api.create.
-
params:
- id
A key field. Data type: DT_I4
- export_type
Template: ShortText.
- user_id
Data type: DT_I4
- workflow_state
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- course_id
Data type: DT_I4
- attachment
Field components:
-
Uses template:
ShortText. - Contains the following components: id, uuid, folder_id, display_name, filename, upload_status, content-type, url, size, created_at, updated_at, unlock_at, locked, hidden, lock_at, hidden_for_user, thumbnail_url, modified_at, mime_class, media_entry_id, locked_for_user, content.
-
Uses template:
- progress_url
Template: ShortText.
- skip_notifications
Data type: DT_BOOL
- context_type
Template: ShortText.
- context_id
Data type: DT_I4
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/content_shares/sent.The action has the following user-defined parameters:
- user_id: Required. Specify the user identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.migration_issues.index.
- [Read single] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/content_shares/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- user_id: Required. Specify the user identifier.
- id: Required. Specify the content share identifier.
Documentation: https://canvas.instructure.com/doc/api/content_shares.html#method.content_shares.show.
- [Create] action
-
Endpoint URL address:
/users/{{=item.user_id}}/content_shares.Documentation: https://canvas.instructure.com/doc/api/content_shares.html#method.content_shares.create.
- [Update] action
-
Endpoint URL address:
/users/{{=item.user_id}}/content_shares/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/content_shares.html#method.content_shares.update.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.user_id}}/content_shares/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/content_shares.html#method.content_shares.destroy.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- content_type
Template: ShortText.
- receiver_ids
Template: LongText. A composite field.
- content_id
Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- receiver_ids
Template: LongText. A composite field.
- user_id
Data type: DT_I4
- sender
Template: UserSummaryT.
- receivers
Field components:
- An array.
-
Uses template:
UserSummaryT.
- source_course
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name.
-
Uses template:
- read_state
Template: ShortText.
- content_export
Field components:
- Contains the following components: id.
- unread_share
The value is gathered from
/user/{{=parameters.user_id}}/content_shares/unread_countaddress. The gathered value is processed with{{=response[field.name]}}expression. Field components:- Contains the following components: count.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/conversations.The action has the following user-defined parameters:
- filter: Optional. Specify to filter the rresult set. Use vertical bar (|) to separate multiple values.
The following request parameters will be automatically processed:
-
filter[]:
{{=Canvas.getMultiParameter(parameters.get('filter'))}}
Documentation: https://canvas.instructure.com/doc/api/conversations.html#method.conversations.index.
- [Read single] action
-
Endpoint URL address:
/conversations/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Specify the conversation identifier.
- filter: Optional. Specify to filter the rresult set. Use vertical bar (|) to separate multiple values.
The following request parameters will be automatically processed:
-
filter[]:
{{=Canvas.getMultiParameter(parameters.get('filter'))}}
Documentation: https://canvas.instructure.com/doc/api/conversations.html#method.conversations.show.
- [Read batch] action
-
Endpoint URL address:
/conversations/batches.Documentation: https://canvas.instructure.com/doc/api/conversations.html#method.conversations.batches.
- [Create] action
-
Endpoint URL address:
/conversations.Documentation: https://canvas.instructure.com/doc/api/conversations.html#method.conversations.create.
- [Update] action
-
Endpoint URL address:
/conversations/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ conversation : item } }}
Documentation: https://canvas.instructure.com/doc/api/conversations.html#method.conversations.update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/conversations/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/conversations.html#method.conversations.destroy.
- id
A key field. Data type: DT_I4
- subject
Template: ShortText.
- recipients
Template: LongText. A composite field.
- filter
Template: LongText. A composite field.
- attachment_ids
Template: LongText. A composite field.
- workflow_state
Template: ShortText.
- body
Template: LongText.
- last_message
Template: ShortText.
- last_message_at
Template: DateTime.
- last_authored_message
Template: ShortText.
- last_authored_message_at
Template: DateTime.
- message_count
Data type: DT_I4
- subscribed
Data type: DT_BOOL
- private
Data type: DT_BOOL
- starred
Data type: DT_BOOL
- properties
Template: LongText. A composite field.
- messages
Field components:
- An array.
- Contains the following components: id, author_id, created_at, generated, body, forwarded_messages, attachments, media_comment, participating_user_ids.
- audience
Template: LongText. A composite field.
- audience_contexts
Field components:
-
Uses template:
LongText. - Contains the following components: courses, groups.
-
Uses template:
- avatar_url
Template: ShortText.
- participants
Field components:
- An array.
-
Uses template:
RecipientT.
- visible
Data type: DT_BOOL
- user_note
Data type: DT_BOOL
- force_new
Data type: DT_BOOL
- group_conversation
Data type: DT_BOOL
- context_name
Template: ShortText.
- context_code
Template: ShortText.
- mode
Template: ShortText.
- scope
Template: ShortText.
- filter_mode
Template: ShortText.
- media_comment_id
Data type: DT_I4
- media_comment_type
Template: ShortText.
- recipients
The value is gathered from
/search/recipientsaddress. Field components:- An array.
-
Uses template:
RecipientT.
- unread
The value is gathered from
/conversations/unread_countaddress. The gathered value is processed with{{=response[field.name]}}expression. Field components:- Contains the following components: count.
- action
Field components:
-
Uses template:
ActionT. - Contains the following components: add_message, remove_message.
-
Uses template:
Based on resource template General.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/content_migrations.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.content_migrations.index.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/content_migrations.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.content_migrations.index.
- [Read group] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/content_migrations.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.content_migrations.index.
- [Read user] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/content_migrations.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.content_migrations.index.
- [Read account single] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/content_migrations/{{=parameters.content_migration_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
- content_migration_id: Required. Specify content migration identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.content_migrations.show.
- [Read course single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/content_migrations/{{=parameters.content_migration_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- content_migration_id: Required. Specify content migration identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.content_migrations.show.
- [Read group single] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/content_migrations/{{=parameters.content_migration_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
- content_migration_id: Required. Specify content migration identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.content_migrations.show.
- [Read user single] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/content_migrations/{{=parameters.content_migration_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- content_migration_id: Required. Specify content migration identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.content_migrations.show.
- [Create] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/content_migrations.Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.content_migrations.create.
- [Update] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/content_migrations/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.content_migrations.update.
- id
A key field. Data type: DT_I4
- migration_type
Template: ShortText.
- migration_type_title
Template: ShortText.
- migration_issues_url
Template: ShortText.
- attachment
Field components:
-
Uses template:
ShortText. - Contains the following components: url.
-
Uses template:
- settings
Field components:
-
Uses template:
ShortText. - Contains the following components: file_url, content_export_id, source_course_id, folder_id, question_bank_name, insert_into_module_type, overwrite_quizzes, importer_skips, insert_into_module_id, question_bank_id, move_to_assignment_group_id, insert_into_module_position.
-
Uses template:
- date_shift_options
Field components:
-
Uses template:
ShortText. - Contains the following components: file_url, shift_dates, importer_skips, day_substitutions, old_start_date, old_end_date, new_start_date, new_end_date, remove_dates.
-
Uses template:
- selective_import
Data type: DT_BOOL
- select
Template: ShortText.
- progress_url
Template: ShortText.
- user_id
Data type: DT_I4
- workflow_state
Template: ShortText.
- started_at
Template: DateTime.
- finished_at
Template: DateTime.
- context_type
Template: ShortText.
- context_id
Data type: DT_I4
- selective_data
The value is gathered from
/{{=Canvas.getContextType(parameters)}}/{{=Canvas.getContextId(parameters)}}/content_migrations/{{=item.id}}address. Field components:- An array.
- Contains the following components: type, property, title, count, sub_items_url, sub_items.
- issue
The value is gathered from
/{{=Canvas.getContextType(parameters)}}/{{=Canvas.getContextId(parameters)}}/content_migrations/{{=item.id}}/migration_issuesaddress. Field components:- An array.
- Contains the following components: id, content_migration_url, description, workflow_state, fix_issue_html_url, issue_type, error_report_html_url, error_message, created_at, updated_at.
- pre_attachment
Field components:
-
Uses template:
ShortText. - Contains the following components: upload_url, message, upload_params.
-
Uses template:
Based on resource template General.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/content_migrations/migrators.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.content_migrations.available_migrators.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/content_migrations/migrators.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.content_migrations.available_migrators.
- [Read group] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/content_migrations/migrators.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.content_migrations.available_migrators.
- [Read user] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/content_migrations/migrators.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.content_migrations.available_migrators.
- type
Template: ShortText.
- requires_file_upload
Data type: DT_BOOL
- name
Template: ShortText.
- required_settings
Template: LongText. A composite field.
Based on resource template General.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/content_migrations/{{=parameters.content_migration_id}}/migration_issues.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
- content_migration_id: Required. Specify content migration identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.migration_issues.index.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/content_migrations/{{=parameters.content_migration_id}}/migration_issues.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- content_migration_id: Required. Specify content migration identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.migration_issues.index.
- [Read group] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/content_migrations/{{=parameters.content_migration_id}}/migration_issues.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
- content_migration_id: Required. Specify content migration identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.migration_issues.index.
- [Read user] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/content_migrations/{{=parameters.content_migration_id}}/migration_issues.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- content_migration_id: Required. Specify content migration identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.migration_issues.index.
- [Read account single] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/content_migrations/{{=parameters.content_migration_id}}/migration_issues/{{=parameters.issue_id}}.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
- content_migration_id: Required. Specify content migration identifier.
- issue_id: Required. Specify issue identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.migration_issues.show.
- [Read course single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/content_migrations/{{=parameters.content_migration_id}}/migration_issues/{{=parameters.issue_id}}.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- content_migration_id: Required. Specify content migration identifier.
- issue_id: Required. Specify issue identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.migration_issues.show.
- [Read group single] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/content_migrations/{{=parameters.content_migration_id}}/migration_issues/{{=parameters.issue_id}}.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
- content_migration_id: Required. Specify content migration identifier.
- issue_id: Required. Specify issue identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.migration_issues.show.
- [Read user single] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/content_migrations/{{=parameters.content_migration_id}}/migration_issues/{{=parameters.issue_id}}.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- content_migration_id: Required. Specify content migration identifier.
- issue_id: Required. Specify issue identifier.
Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.migration_issues.show.
- [Update] action
-
Endpoint URL address:
/{{=item.context_type || 'courses'}}/{{=item.context_id}}/content_migrations/{{=item.content_migration_id}}/migration_issues/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/content_migrations.html#method.migration_issues.update.
- id
A key field. Data type: DT_I4
- content_migration_url
Template: ShortText.
- description
Template: ShortText.
- workflow_state
Template: ShortText.
- fix_issue_html_url
Template: ShortText.
- issue_type
Template: ShortText.
- error_report_html_url
Template: ShortText.
- error_message
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- context_type
Template: ShortText.
- context_id
Data type: DT_I4
- content_migration_id
Data type: DT_I4
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/assignments/{{=parameters.assignment_id}}/moderated_students.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- assignment_id: Required. Specify assignment identifier.
Documentation: https://canvas.instructure.com/doc/api/moderated_grading.html#method.moderation_set.index.
- [Create] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/assignments/{{=item.assignment_id}}/moderated_students.The following request parameters will be automatically processed:
-
student_ids[]:
{{=item.id}}
Documentation: https://canvas.instructure.com/doc/api/moderated_grading.html#method.moderation_set.create.
-
student_ids[]:
The resource includes the fields from the userT template.
- course_id
Data type: DT_I4
- assignment_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/modules.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/modules.html#method.context_modules_api.index.
- [Read single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/modules/{{=parameters.module_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- module_id: Required. Specify module identifier.
Documentation: https://canvas.instructure.com/doc/api/modules.html#method.context_modules_api.show.
- [Create] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/modules.Documentation: https://canvas.instructure.com/doc/api/modules.html#method.context_modules_api.create.
- [Update] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/modules/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/modules.html#method.context_modules_api.create.
- [Delete] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/modules/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/modules.html#method.context_modules_api.destroy.
The resource includes the fields from the moduleT template.
- course_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/modules/{{=parameters.module_id}}/items.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- module_id: Required. Specify module identifier.
Documentation: https://canvas.instructure.com/doc/api/modules.html#method.context_module_items_api.index.
- [Read single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/modules/{{=parameters.module_id}}/items/{{=parameters.item_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- module_id: Required. Specify module identifier.
- item_id: Required. Specify item identifier.
Documentation: https://canvas.instructure.com/doc/api/modules.html#method.context_module_items_api.show.
- [Create] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/modules/{{=item.module_id}}/items.Documentation: https://canvas.instructure.com/doc/api/modules.html#method.context_module_items_api.create.
- [Update] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/modules/{{=item.module_id}}/items/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/modules.html#method.context_module_items_api.update.
- [Delete] action
-
Endpoint URL address:
/courses/{{=item.course_id}}/modules/{{=item.module_id}}/items/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/modules.html#method.context_module_items_api.destroy.
The resource includes the fields from the moduleItemT template.
- course_id
Data type: DT_I4
- sequence
The value is gathered from
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/module_item_sequenceaddress. The gathered value is processed with{{=response[field.name]}}expression. Field components:- Contains the following components: items, modules.
- action
Template: ShortText. Field components:
- Contains the following components: done, not_done, read.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/users.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/users.html#method.users.api_index.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/users.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/courses.html#method.courses.users.
- [Read course search] action
-
Endpoint URL address:
/api/v1/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/search_users.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- search_term: Required. Specify the partial name or full ID of the users to match.
Documentation: https://canvas.instructure.com/doc/api/courses.html#method.courses.users.
- [Read course recent] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/recent_users.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/courses.html#method.courses.recent_students.
- [Read course content share] action
-
Endpoint URL address:
/api/v1/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/content_share_users.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/courses.html#method.courses.content_share_users.
- [Create] action
-
Endpoint URL address:
/accounts/{{=item.account_id}}/users.Documentation: https://canvas.instructure.com/doc/api/users.html#method.users.create.
- [Update] action
-
Endpoint URL address:
/users/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/users.html#method.users.update.
The resource includes the fields from the userT template.
- user
Field components:
-
Uses template:
userT. - Contains the following components: .
-
Uses template:
- communication_channel
Field components:
-
Uses template:
ShortText. - Contains the following components: type, address, confirmation_url, skip_confirmation, force_validations, enable_sis_reactivation, destination, initial_enrollment_type.
-
Uses template:
- pairing_code
Field components:
-
Uses template:
ShortText. - Contains the following components: code.
-
Uses template:
- account_id
Data type: DT_I4
- profile
The value is gathered from
/user/{{=item.id}}/profileaddress. The gathered value is processed with{{=response[field.name]}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: id, name, short_name, sortable_name, title, bio, primary_email, login_id, sis_user_id, lti_user_id, avatar_url, calendar, time_zone, locale, k5_user.
-
Uses template:
- page_views
The value is gathered from
/user/{{=item.id}}/page_viewsaddress. Field components:- An array.
- Contains the following components: id, app_name, url, context_type, asset_type, controller, action, contributed, interaction_seconds, created_at, user_request, render_time, user_agent, participated, http_method, remote_ip, links.
- most_graded_submissions
The value is gathered from
/user/{{=item.id}}/page_viewsaddress. Field components:- An array.
-
Uses template:
submissionT.
- avatar
The value is gathered from
/user/{{=item.id}}/avatarsaddress. Field components:- An array.
- Contains the following components: type, url, token, display_name, avatar_content.
- observees
The gathered value is processed with
connection.resourceManager['User Observee'].getData({ parameters: ['user_id=' + item.id] })expression. Field components:- An array.
-
Uses template:
userT.
- observers
The gathered value is processed with
connection.resourceManager['User Observer'].getData({ parameters: ['user_id=' + item.id] })expression. Field components:- An array.
-
Uses template:
userT.
- colors
Template: NameValueT. The value is gathered from
/users/{{=item.id}}/colorsaddress. The gathered value is processed with{{=_.map(response.custom_colors, function(v, k) { return { name: k, value: v }; })}}expression.- dashboard_positions
Template: NameValueT. The value is gathered from
/users/{{=item.id}}/dashboard_positionsaddress. The gathered value is processed with{{=_.map(response.dashboard_positions, function(v, k) { return { name: k, value: v }; })}}expression.- graded_submissions
The value is gathered from
/users/{{=item.id}}/graded_submissionsaddress. The gathered value is processed with{{=response.submissions}}expression. Field components:- An array.
-
Uses template:
submissionT.
- action
Field components:
- Contains the following components: set_color, set_dashboard_positions, terminate_sessions.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/missing_submissions.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
Documentation: https://canvas.instructure.com/doc/api/users.html#method.users.missing_submissions.
The resource includes the fields from the assignmentT template.
- course
Template: courseT.
- planner_overrides
Field components:
- An array.
-
Uses template:
plannerOverrideT.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/users/activity_stream.Documentation: https://canvas.instructure.com/doc/api/users.html#method.users.activity_stream.
The resource includes the fields from the ActivityStreamT template.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/users/self/todo.Documentation: https://canvas.instructure.com/doc/api/users.html#method.users.todo_items.
- type
Template: ShortText.
- assignment
Template: assignmentT.
- ignore
Template: ShortText.
- ignore_permanently
Template: ShortText.
- html_url
Template: ShortText.
- needs_grading_count
Data type: DT_I4
- context_type
Template: ShortText.
- course_id
Data type: DT_I4
- group_id
Data type: DT_I4
- ungraded_quizzes
Field components:
- An array.
-
Uses template:
quizzT.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/users/self/todo_item_count.Documentation: https://canvas.instructure.com/doc/api/users.html#method.users.todo_item_count.
- needs_grading_count
Data type: DT_I4
- assignments_needing_submitting
Data type: DT_I4
- ungraded_quizzes
Field components:
- An array.
-
Uses template:
quizzT.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/users/self/course_nicknames.Documentation: https://canvas.instructure.com/doc/api/users.html#method.course_nicknames.index.
- [Read single] action
-
Endpoint URL address:
/users/self/course_nicknames/{{=Canvas.UI.CourseEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/users.html#method.course_nicknames.index.
- [Update] action
-
Endpoint URL address:
/users/self/course_nicknames/{{=item.course_id}}.Documentation: https://canvas.instructure.com/doc/api/users.html#method.course_nicknames.update.
- [Delete] action
-
Endpoint URL address:
/users/self/course_nicknames/{{=item.course_id}}.Documentation: https://canvas.instructure.com/doc/api/users.html#method.course_nicknames.delete.
- course_id
A key field. Data type: DT_I4
- name
Template: ShortText.
- nickname
Template: ShortText.
Based on resource template LTI.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/names_and_roles.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/names_and_role.html#NamesAndRoleMemberships.
- [Read group] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/names_and_roles.The action has the following user-defined parameters:
- group_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/names_and_role.html#NamesAndRoleMemberships.
- id
A key field. Template: ShortText.
- context
Field components:
-
Uses template:
ShortText. - Contains the following components: id, label, title.
-
Uses template:
- members
Field components:
- An array.
- Contains the following components: status, name, picture, given_name, family_name, email, lis_person_sourcedid, user_id, roles, message.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/communication_channels/{{=parameters.communication_channel_id}}/notification_preferences.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- communication_channel_id: Required. Specify communication channel identifier.
Documentation: https://canvas.instructure.com/doc/api/notification_preferences.html#method.notification_preferences.index.
- [Read single] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/communication_channels/{{=parameters.communication_channel_id}}/notification_preferences/{{=parameters.notification_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- communication_channel_id: Required. Specify communication channel identifier.
- notification_id: Required. Specify notification identifier.
Documentation: https://canvas.instructure.com/doc/api/notification_preferences.html#method.notification_preferences.show.
- [Update] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/communication_channels/{{=parameters.communication_channel_id}}/notification_preferences/{{=item.notification}}.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- communication_channel_id: Required. Specify communication channel identifier.
Documentation: https://canvas.instructure.com/doc/api/notification_preferences.html#method.notification_preferences.update.
- notification
A key field. Template: ShortText.
- href
Template: ShortText.
- category
Template: ShortText.
- frequency
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/communication_channels/{{=parameters.communication_channel_id}}/notification_preference_categories.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- communication_channel_id: Required. Specify communication channel identifier.
Documentation: https://canvas.instructure.com/doc/api/notification_preferences.html#method.notification_preferences.category_index.
- [Update] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/communication_channels/{{=parameters.communication_channel_id}}/notification_preference_categories/{{=item.category}}.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- communication_channel_id: Required. Specify communication channel identifier.
Documentation: https://canvas.instructure.com/doc/api/notification_preferences.html#method.notification_preferences.update.
- category
A key field. Template: ShortText.
- href
Template: ShortText.
- notification
Template: ShortText.
- frequency
Template: ShortText.
Based on resource template LTI.
- [Read] action
-
Endpoint URL address:
/assignments/{{=parameters.assignment_id}}/submissions/{{=parameters.submission_id}}/originality_report.The action has the following user-defined parameters:
- assignment_id: Required. Specify assignment identifier.
- submission_id: Required. Specify submission identifier.
Documentation: https://canvas.instructure.com/doc/api/originality_reports.html#method.lti/originality_reports_api.show.
- [Create] action
-
Endpoint URL address:
/assignments/{{=item.assignment_id}}/submissions/{{=item.submission_id}}/originality_report.The following request parameters will be automatically processed:
-
application/json:
{{= { originality_report : item } }}
Documentation: https://canvas.instructure.com/doc/api/originality_reports.html#method.lti/originality_reports_api.create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/assignments/{{=item.assignment_id}}/submissions/{{=item.submission_id}}/originality_report/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{= { originality_report : item } }}
Documentation: https://canvas.instructure.com/doc/api/originality_reports.html#method.lti/originality_reports_api.update.
-
application/json:
- id
A key field. Data type: DT_I4
- file_id
Data type: DT_I4
- originality_score
Data type: DT_R8
- originality_report_file_id
Data type: DT_I4
- originality_report_url
Template: ShortText.
- tool_setting
Field components:
-
Uses template:
ShortText. - Contains the following components: resource_type_code, resource_url.
-
Uses template:
- error_report
Template: ShortText.
- submission_time
Template: ShortText.
- root_account_id
Data type: DT_I4
- assignment_id
Data type: DT_I4
- submission_id
Data type: DT_I4
Based on resource template General.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=Canvas.UI.AccountEditor.getValue(parameters)}}/features.The action has the following user-defined parameters:
- account_id: Required. Specify account identifier.
Documentation: https://canvas.instructure.com/doc/api/feature_flags.html#method.feature_flags.index.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/features.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/feature_flags.html#method.feature_flags.index.
- [Read user] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/features.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
Documentation: https://canvas.instructure.com/doc/api/feature_flags.html#method.feature_flags.index.
- [Read environment] action
-
Endpoint URL address:
/features/environment.
- feature
A key field. Template: ShortText.
- display_name
Template: ShortText.
- applies_to
Template: ShortText.
- name
Template: ShortText.
- type
Template: ShortText.
- description
Template: LongText.
- feature_flag
Field components:
-
Uses template:
ShortText. - Contains the following components: context_id, context_type, feature, state, locking_account_id, transitions, locked, parent_state.
-
Uses template:
- root_opt_in
Data type: DT_BOOL
- beta
Data type: DT_BOOL
- autoexpand
Data type: DT_BOOL
- release_notes_url
Template: ShortText.
- telepathic_navigation
Data type: DT_BOOL
- fancy_wickets
Data type: DT_BOOL
- automatic_essay_grading
Data type: DT_BOOL
- flag
The value is gathered from
/{{=Canvas.GetContextType(parameters)}}/{{=Canvas.GetContextId(parameters)}}/features/flags/{{=item.feature}}address. The gathered value is processed with{{=response[field.name]}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: context_type, context_id, feature, state, locking_account_id, transitions, locked, parent_state.
-
Uses template:
Based on resource template General.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/files.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/feature_flags.html#method.feature_flags.show.
- [Read group] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/files.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
Documentation: https://canvas.instructure.com/doc/api/feature_flags.html#method.feature_flags.show.
- [Read folder] action
-
Endpoint URL address:
/folders/{{=parameters.folder_id}}/files.The action has the following user-defined parameters:
- folder_id: Required. Specify folder identifier.
Documentation: https://canvas.instructure.com/doc/api/feature_flags.html#method.feature_flags.show.
- [Read user] action
-
Endpoint URL address:
/users/{{=parameters.users_id}}/files.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
Documentation: https://canvas.instructure.com/doc/api/feature_flags.html#method.feature_flags.show.
- [Read course single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/files/{{=parameters.file_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- file_id: Required. Specify the file identifier.
Documentation: https://canvas.instructure.com/doc/api/files.html#method.files.api_show.
- [Read group single] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/files/{{=parameters.file_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
- file_id: Required. Specify the file identifier.
Documentation: https://canvas.instructure.com/doc/api/files.html#method.files.api_show.
- [Read folder single] action
-
Endpoint URL address:
/folders/{{=parameters.folder_id}}/files/{{=parameters.file_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- folder_id: Required. Specify folder identifier.
- file_id: Required. Specify the file identifier.
Documentation: https://canvas.instructure.com/doc/api/files.html#method.files.api_show.
- [Read user single] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/files/{{=parameters.file_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- file_id: Required. Specify the file identifier.
Documentation: https://canvas.instructure.com/doc/api/files.html#method.files.api_show.
- [Read course file reference] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/files/file_ref/{{=parameters.migration_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- migration_id: Required. Specify the migration identifier.
Documentation: https://canvas.instructure.com/doc/api/files.html#method.files.file_ref.
- [Update] action
-
Endpoint URL address:
/files/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/files.html#method.files.api_update.
- [Delete] action
-
Endpoint URL address:
/files/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/files.html#method.files.destroy.
- id
A key field. Data type: DT_I4
- uuid
Data type: DT_GUID
- folder_id
Data type: DT_I4
- display_name
Template: ShortText.
- name
Template: ShortText.
- parent_folder_id
Template: ShortText.
- parent_folder_id
Template: ShortText.
- on_duplicate
Template: ShortText.
- content-type
Template: ShortText.
- url
Template: ShortText.
- size
Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- unlock_at
Template: DateTime.
- locked
Data type: DT_BOOL
- hidden
Data type: DT_BOOL
- lock_at
Template: DateTime.
- hidden_for_user
Data type: DT_BOOL
- thumbnail_url
Template: ShortText.
- modified_at
Template: DateTime.
- mime_class
Template: ShortText.
- media_entry_id
Template: ShortText.
- locked_for_user
Data type: DT_BOOL
- lock_info
Template: ShortText.
- lock_explanation
Template: ShortText.
- preview_url
Template: ShortText.
- user
Template: usert.
- quota
A read-only field. The value is gathered from
/{{=parameters.suffix}}/{{=parameters.suffix_id}}/files/quotaaddress. The gathered value is processed with{{=response[field.name]}}expression. Field components:- Contains the following components: quota, quota_used.
- public_inline_url
A read-only field. The value is gathered from
/files/{{=item.id}}/public_urladdress. Field components:-
Uses template:
ShortText. - Contains the following components: public_url.
-
Uses template:
Based on resource template General.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/folders.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/files.html#method.folders.list_all_folders.
- [Read group] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/folders.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
Documentation: https://canvas.instructure.com/doc/api/files.html#method.folders.list_all_folders.
- [Read user] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/folders.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
Documentation: https://canvas.instructure.com/doc/api/files.html#method.folders.list_all_folders.
- [Read course single] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/folders/{{=parameters.folder_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- folder_id: Required. Specify the folder identifier.
Documentation: https://canvas.instructure.com/doc/api/files.html#method.files.api_show.
- [Read group single] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/folders/{{=parameters.folder_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
- folder_id: Required. Specify the folder identifier.
Documentation: https://canvas.instructure.com/doc/api/files.html#method.files.api_show.
- [Read user single] action
-
Endpoint URL address:
/groups/{{=parameters.user_id}}/folders/{{=parameters.folder_id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- user_id: Required. Specify group identifier.
- folder_id: Required. Specify the folder identifier.
Documentation: https://canvas.instructure.com/doc/api/files.html#method.files.api_show.
- [Read course media] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/folders/media.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/files.html#method.folders.media_folder.
- [Read group media] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/folders/media.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
Documentation: https://canvas.instructure.com/doc/api/files.html#method.folders.media_folder.
- [Create] action
-
Endpoint URL address:
/{{=item.context_type}}/{{=item.context_id}}/folders.Documentation: https://canvas.instructure.com/doc/api/files.html#method.folders.create.
- [Update] action
-
Endpoint URL address:
/folders/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/files.html#method.folders.update.
- [Delete] action
-
Endpoint URL address:
/folders/{{=item.id}}.Documentation: https://canvas.instructure.com/doc/api/files.html#method.files.destroy.
The resource includes the fields from the FolderT template.
- on_duplicate
Data type: DT_BOOL
- folders
The value is gathered from
/folders/{{=item.id}}/foldersaddress. Field components:- An array.
-
Uses template:
FolderT.
- action
Field components:
- Contains the following components: copy_file, copy_folder.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/media_objects.Documentation: https://canvas.instructure.com/doc/api/media_objects.html#method.media_objects.index.
- [Read course] action
-
Endpoint URL address:
/courses/{{=Canvas.UI.CourseEditor.getValue(parameters)}}/media_objects.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
Documentation: https://canvas.instructure.com/doc/api/media_objects.html#method.media_objects.index.
- [Read group] action
-
Endpoint URL address:
/groups/{{=Canvas.UI.GroupEditor.getValue(parameters)}}/media_objects.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
Documentation: https://canvas.instructure.com/doc/api/media_objects.html#method.media_objects.index.
- [Update] action
-
Endpoint URL address:
/media_objects/{{=item.media_id}}.Documentation: https://canvas.instructure.com/doc/api/media_objects.html#method.media_objects.update_media_object.
- can_add_captions
Data type: DT_BOOL
- user_entered_title
Template: ShortText.
- title
Template: ShortText.
- media_id
A key field. Template: ShortText.
- media_type
Template: ShortText.
- media_tracks
Field components:
- An array.
- Contains the following components: id, user_id, media_object_id, kind, locale, content, created_at, updated_at, webvtt_content.
- media_sources
Field components:
- An array.
- Contains the following components: height, width, content_type, containerFormat, url, bitrate, size, isOriginal, fileExt.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/media_objects/{{=parameters.id}}/media_tracks.The action has the following user-defined parameters:
- id: Required. Specify media object identifier.
Documentation: https://canvas.instructure.com/doc/api/media_objects.html#method.media_tracks.index.
- [Update] action
-
Endpoint URL address:
/media_objects/{{=item.id}}/media_tracks.Documentation: https://canvas.instructure.com/doc/api/media_objects.html#method.media_tracks.update.
- id
A key field. Data type: DT_I4
- user_id
Data type: DT_I4
- media_object_id
Data type: DT_I4
- kind
Template: ShortText.
- locale
Template: ShortText.
- content
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- webvtt_content
Template: ShortText.
Based on resource template LTI.
- [Create] action
-
Endpoint URL address:
/courses/{=Canvas.UI.CourseEditor.getValue(parameters)}}/line_items/{{=parameters.line_item_id}}/scores.The action has the following user-defined parameters:
- course_id: Required. Specify course identifier.
- line_item_id: Required. Specify line item identifier.
Documentation: https://canvas.instructure.com/doc/api/score.html#method.lti/ims/scores.create.
- userId
Template: ShortText.
- scoreGiven
Data type: DT_I4
- scoreMaximum
Data type: DT_I4
- comment
Template: LongText.
- timestamp
Template: DateTime. A read-only field.
- activityProgress
Template: ShortText.
- gradingProgress
Template: ShortText.
- https://canvas.instructure.com/lti/submission
Field components:
-
Uses template:
ShortText. - Contains the following components: new_submission, submission_type, submission_data, submitted_at, content_items.
-
Uses template:
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=Canvas.getParameters(parameters)}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{= function(item) { var result = {}; result[resource.object] = item; return result; }(item) }}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{= function(item) { var result = {}; result[resource.object] = item; return result; }(item) }}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- [Read] action
-
The result is extracted from:{{=utils.ensureArray(response)}}.
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=Canvas.getParameters(parameters)}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}} -
_includeUserParameters:
{{=parameters}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}} -
_includeUserParameters:
{{=parameters}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
Based on resource template General.
- [Read] action
-
The result is paginated.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- alldateT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, base, can_edit, in_closed_grading_period, title, due_at, unlock_at, lock_at.
-
Uses template:
- accountT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, uuid, parent_account_id, root_account_id, default_storage_quota_mb, default_user_storage_quota_mb, default_group_storage_quota_mb, default_time_zone, sis_account_id, integration_id, sis_import_id, lti_guid, workflow_state, role, manage_account_memberships, become_user, services, send_confirmation, role_id.
-
Uses template:
- attachmentT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, uuid, folder_id, display_name, filename, upload_status, content-type, url, size, created_at, updated_at, unlock_at, locked, hidden, lock_at, hidden_for_user, thumbnail_url, modified_at, mime_class, media_entry_id, locked_for_user.
-
Uses template:
- avatarUrlT
Field components:
-
Uses template:
ShortText. - Contains the following components: type, url, token, display_name, id, content-type, filename, size.
-
Uses template:
- ratingT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, points, description, long_description, points, mastery, color.
-
Uses template:
- permissionT
Field components:
- Contains the following components: create_discussion_topic, create_announcement, attach, update, reply, delete, read, submit, view_answer_audits, preview, grade, manage, read_statistics, review_grades, update.
- sectionT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, start_at, end_at, enrollment_role.
-
Uses template:
- enrollmentT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, course_id, sis_course_id, course_integration_id, course_section_id, section_integration_id, sis_account_id, sis_section_id, sis_user_id, enrollment_state, limit_privileges_to_course_section, sis_import_id, root_account_id, type, user_id, associated_user_id, role, role_id, created_at, updated_at, start_at, end_at, last_activity_at, last_attended_at, total_activity_time, html_url, override_grade, override_score, unposted_current_grade, unposted_final_grade, unposted_current_score, unposted_final_score, has_grading_periods, totals_for_all_grading_periods_option, current_grading_period_title, current_grading_period_id, current_period_override_grade, current_period_override_score, current_period_unposted_current_score, current_period_unposted_final_score, current_period_unposted_current_grade, current_period_unposted_final_grade, user, grades.
-
Uses template:
- customLinkT
Field components:
-
Uses template:
ShortText. - Contains the following components: text, url, icon_class, tool_id.
-
Uses template:
- NameValueT
The gathered value is processed with
{{=_.map(value, function(v, k) { return { name: k, value: v }; })}}expression. Field components:- An array.
- Contains the following components: name, value.
- UserSummaryT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, display_name, avatar_image_url, html_url.
-
Uses template:
- userT
Template: UserSummaryT. Field components:
-
Uses template:
ShortText. - Contains the following components: name, sortable_name, last_name, first_name, event, short_name, sis_user_id, sis_import_id, integration_id, root_account, login_id, anonymous_id, pronouns, avatar_url, email, locale, locked, last_login, created_at, time_zone, bio, enrollments, custom_links.
-
Uses template:
- lockInfoT
Field components:
-
Uses template:
ShortText. - Contains the following components: asset_string, unlock_at, lock_at, context_module, manually_locked.
-
Uses template:
- reservedAppointmentT
Field components:
-
Uses template:
DateTime. - Contains the following components: id, start_at, end_at.
-
Uses template:
- helpLinkT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, text, subtext, url, type, available_to, is_featured, is_new, feature_headline.
-
Uses template:
- courseProgressT
Field components:
-
Uses template:
ShortText. - Contains the following components: requirement_count, requirement_completed_count, next_requirement_url, completed_at.
-
Uses template:
- overrideT
Field components:
-
Uses template:
LongText. - Contains the following components: id, assignment_id, student_ids, group_id, course_section_id, title, due_at, all_day, all_day_date, unlock_at, lock_at.
-
Uses template:
- submissionCommentT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, attempt, author_id, author_name, author, text_comment, group_comment, comment, created_at, edited_at, media_comment, media_comment_id, media_comment_type, file_ids.
-
Uses template:
- observeUserT
Field components:
-
Uses template:
ShortText. - Contains the following components: assignment_id, attempt, body, grade, grade_matches_current_submission, html_url, preview_url, score, submission_comments, submission_type, submitted_at, url, user_id, grader_id, graded_at, user, late, assignment_visible, excused, missing, late_policy_status, points_deducted, seconds_late, workflow_state, extra_attempts, anonymous_id, posted_at, read_status.
-
Uses template:
- tabT
Field components:
-
Uses template:
ShortText. - Contains the following components: html_url, id, label, type, hidden, visibility, position, course_subject_tabs.
-
Uses template:
- submissionT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, assignment_id, attempt, body, grade, grade_matches_current_submission, html_url, preview_url, score, submission_comments, submission_type, submitted_at, url, user_id, grader_id, graded_at, late, assignment_visible, excused, excuse, missing, late_policy_status, points_deducted, seconds_late, workflow_state, extra_attempts, anonymous_id, posted_at, read_status, workflow_state, cached_due_date, excused, grading_period_id, redo_request, late, seconds_late, seconds_late_override, entered_grade, entered_score, grader, assignment_name, user_name, current_grade, current_graded_at, current_grader, previous_grade, previous_graded_at, previous_grader, new_grade, new_graded_at, new_grader, new_score, posted_grade.
-
Uses template:
- discussionTopicT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, title, message, html_url, posted_at, last_reply_at, require_initial_post, user_can_see_posts, discussion_subentry_count, read_state, unread_count, subscribed, subscription_hold, assignment_id, delayed_post_at, published, lock_at, locked, pinned, locked_for_user, lock_info, lock_explanation, user_name, topic_children, group_topic_children, root_topic_id, podcast_url, discussion_type, group_category_id, attachments, permissions, allow_rating, only_graders_can_rate, sort_by_rating.
-
Uses template:
- assignmentT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, description, created_at, updated_at, due_at, lock_at, unlock_at, important_dates, has_overrides, muted, all_dates, course_id, sis_assignment_id, html_url, workflow_state, submissions_download_url, assignment_group_id, due_date_required, in_closed_grading_period, allowed_extensions, max_name_length, turnitin_enabled, is_quiz_assignment, vericite_enabled, anonymous_peer_reviews, anonymous_instructor_annotations, turnitin_settings, grade_group_students_individually, external_tool_tag_attributes, peer_reviews, automatic_peer_reviews, peer_review_count, peer_reviews_assign_at, intra_group_peer_reviews, group_category_id, needs_grading_count, needs_grading_count_by_section, position, post_to_sis, integration_id, integration_data, points_possible, submission_types, has_submitted_submissions, grading_type, grading_standard_id, published, unpublishable, only_visible_to_overrides, locked_for_user, lock_info, lock_explanation, quiz_id, anonymous_submissions, free_form_criterion_comments, discussion_topic, freeze_on_copy, frozen, frozen_attributes, observed_users, submission, use_rubric_for_grading, rubric_settings, rubric, assignment_visibility, discussion_topic, overrides, omit_from_final_grade, moderated_grading, grader_count, final_grader_id, grader_comments_visible_to_graders, graders_anonymous_to_graders, grader_names_visible_to_final_grader, anonymous_grading, anonymous_students, allowed_attempts, original_course_id, original_quiz_id, original_lti_resource_link_id, original_assignment_id, post_manually, require_lockdown_browser, score_statistics, can_submit, can_duplicate, can_edit, annotatable_attachment_id, original_assignment_name, secure_params.
-
Uses template:
- readPermissionT
Field components:
- Contains the following components: enabled, locked, readonly, explicit, prior_default, applies_to_self, applies_to_descendants.
- groupT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, description, is_public, followed_by_user, join_level, members_count, context_type, course_id, role, group_category_id, sis_group_id, sis_import_id, storage_quota_mb, permissions, tabs, users.
-
Uses template:
- bluePrintDetailT
Field components:
-
Uses template:
ShortText. - Contains the following components: asset_id, asset_type, asset_name, change_type, html_url, locked, exceptions.
-
Uses template:
- bluePrintGeneralT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, template_id, user_id, workflow_state, created_at, exports_started_at, imports_queued_at, imports_completed_at, comment.
-
Uses template:
- courseT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, sis_course_id, uuid, integration_id, sis_import_id, name, status_url, workflow_state, conclude_at, allow_student_wiki_edits, updated_at, show_public_context_messages, default_wiki_editing_roles, wiki_id, allow_student_organized_groups, abstract_course_id, sis_source_id, sis_batch_id, storage_quota, tab_configuration, turnitin_comments, indexed, template_course_id, settings, replacement_course_id, stuck_sis_fields, self_enrollment_code, self_enrollment_limit, lti_context_id, turnitin_id, show_announcements_on_home_page, home_page_announcement_limit, latest_outcome_import_id, homeroom_course, sync_enrollments_from_homeroom, homeroom_course_id, progress, course_code, workflow_state, account_id, root_account_id, account, observe_users, enrollment_term_id, grading_periods, passback_status, concluded, favorites, teachers, observed_users, tabs, grading_standard_id, grade_passback_setting, created_at, start_at, end_at, locale, enrollments, total_students, total_scores, computed_current_score, computed_final_score, computed_current_grade, computed_final_grade, unposted_current_score, unposted_final_score, unposted_current_grade, unposted_final_grade, current_grading_period_scores, calendar, default_view, syllabus_body, needs_grading_count, term, course_progress, sections, apply_assignment_group_weights, permissions, is_public, is_public_to_auth_users, public_syllabus, public_syllabus_to_auth, public_description, storage_quota_mb, storage_quota_used_mb, hide_final_grades, license, allow_student_assignment_edits, allow_wiki_comments, allow_student_forum_attachments, open_enrollment, self_enrollment, restrict_enrollments_to_course_dates, course_format, access_restricted_by_date, time_zone, event, blueprint, blueprint_restrictions, blueprint_restrictions_by_object_type, template.
-
Uses template:
- OutcomeGroupT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, url, parent_outcome_group, context_id, context_type, title, description, vendor_guid, subgroups_url, outcomes_url, import_url, can_edit.
-
Uses template:
- quizzT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, title, html_url, mobile_url, preview_url, description, quiz_type, assignment_group_id, time_limit, shuffle_answers, hide_results, show_correct_answers, show_correct_answers_last_attempt, show_correct_answers_at, hide_correct_answers_at, one_time_results, scoring_policy, allowed_attempts, one_question_at_a_time, question_count, points_possible, cant_go_back, access_code, ip_filter, due_at, lock_at, unlock_at, published, unpublishable, locked_for_user, only_visible_to_overrides, lock_info, lock_explanation, speedgrader_url, quiz_extensions_url, permissions, all_dates, version_number, question_types, anonymous_submissions.
-
Uses template:
- plannerOverrideT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, plannable_type, plannable_id, user_id, assignment_id, workflow_state, marked_complete, dismissed, created_at, updated_at, deleted_at.
-
Uses template:
- ActionT
- moduleItemT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, module_id, position, indent, type, content_id, html_url, url, page_url, external_url, new_tab, completion_requirement, content_details, published.
-
Uses template:
- moduleT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, workflow_state, position, name, unlock_at, require_sequential_progress, prerequisite_module_ids, items_count, items_url, state, completed_at, publish_final_grade, published, items.
-
Uses template:
- moduleCurrNextT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, title, position, indent, quiz_lti, type, module_id, html_url, content_id, url, published.
-
Uses template:
- progressT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, context_id, context_type, user_id, tag, completion, workflow_state, created_at, updated_at, message, results, url.
-
Uses template:
- topicEntryT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, user_id, parent_id, rating_count, rating_sum, user_name, message, read_state, forced_read_state, created_at, updated_at, user, attachment.
-
Uses template:
- rubricAssessmentT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, user_id, rubric_id, rubric_association_id, score, artifact_type, artifact_id, artifact_attempt, assessment_type, assessor_id, data, comments, criterion_id.
-
Uses template:
- rubricAssociationT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, rubric_id, association_id, association_type, title, use_for_grading, purpose, hide_score_total, hide_points, hide_outcome_results, bookmarked.
-
Uses template:
- TardinessBreakdownT
Field components:
- Contains the following components: total, on_time, late, missing, floating.
- AccountActivityT
Field components:
- Contains the following components: by_date, by_category.
- AccountStatsT
Field components:
- Contains the following components: courses, subaccounts, teachers, students, discussion_topics, media_objects, attachments, assignments.
- ExternalFeedT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, display_name, url, header_match, created_at, verbosity.
-
Uses template:
- AuthorT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, anonymous_id, display_name, avatar_image_url, html_url, pronouns.
-
Uses template:
- ActivityStreamT
Field components:
-
Uses template:
DateTime. - Contains the following components: created_at, updated_at, id, title, message, read_state, context_type, course_id, group_id, html_url, type, discussion_topic_id, total_root_discussion_entries, require_initial_post, user_has_posted, announcement_id, conversation_id, private, participant_count, message_id, notification_category, web_conference_id, assessment_request_id, collaboration_id, root_discussion_entries.
-
Uses template:
- OutcomeLinkT
Field components:
-
Uses template:
ShortText. - Contains the following components: context_id, context_type, quiz_lti, url, outcome_group, outcome, can_unlink, assessed.
-
Uses template:
- RecipientT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, full_name, common_courses, common_groups, permissions, user_count, types, avatar_url.
-
Uses template:
- PollSessionT
Field components:
-
Uses template:
DateTime. - Contains the following components: id, poll_id, course_id, course_section_id, is_published, has_public_results, has_submitted, created_at, poll_submissions, results.
-
Uses template:
- FolderT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, context_type, context_id, files_count, position, updated_at, folders_url, files_url, full_name, lock_at, folders_count, name, parent_folder_id, created_at, unlock_at, hidden, hidden_for_user, locked, locked_for_user, for_submissions.
-
Uses template:
Knowledge Base
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.