lms-graphql-api 1.9.0 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/lms_graphql/mutations/canvas/add_multiple_allowed_domains_to_account.rb +1 -1
- data/lib/lms_graphql/mutations/canvas/add_users_to_content_share.rb +1 -1
- data/lib/lms_graphql/mutations/canvas/create_content_share.rb +1 -1
- data/lib/lms_graphql/mutations/canvas/create_instaccess_token.rb +22 -0
- data/lib/lms_graphql/mutations/canvas/create_jwt.rb +5 -3
- data/lib/lms_graphql/mutations/canvas/create_user_login.rb +4 -2
- data/lib/lms_graphql/mutations/canvas/create_webhook_subscription.rb +1 -1
- data/lib/lms_graphql/mutations/canvas/delete_eportfolio.rb +24 -0
- data/lib/lms_graphql/mutations/canvas/edit_user.rb +4 -2
- data/lib/lms_graphql/mutations/canvas/edit_user_login.rb +6 -2
- data/lib/lms_graphql/mutations/canvas/grade_or_comment_on_multiple_submissions_courses_assignments.rb +3 -3
- data/lib/lms_graphql/mutations/canvas/grade_or_comment_on_multiple_submissions_courses_submissions.rb +3 -3
- data/lib/lms_graphql/mutations/canvas/grade_or_comment_on_multiple_submissions_sections_assignments.rb +3 -3
- data/lib/lms_graphql/mutations/canvas/grade_or_comment_on_multiple_submissions_sections_submissions.rb +3 -3
- data/lib/lms_graphql/mutations/canvas/grade_or_comment_on_submission_by_anonymous_id_courses.rb +51 -0
- data/lib/lms_graphql/mutations/canvas/grade_or_comment_on_submission_by_anonymous_id_sections.rb +51 -0
- data/lib/lms_graphql/mutations/canvas/mark_document_annotations_as_read_courses.rb +28 -0
- data/lib/lms_graphql/mutations/canvas/mark_document_annotations_as_read_sections.rb +28 -0
- data/lib/lms_graphql/mutations/canvas/mark_rubric_comments_as_read_courses.rb +28 -0
- data/lib/lms_graphql/mutations/canvas/mark_rubric_comments_as_read_sections.rb +28 -0
- data/lib/lms_graphql/mutations/canvas/moderate_all_eportfolios_for_user.rb +27 -0
- data/lib/lms_graphql/mutations/canvas/moderate_eportfolio.rb +27 -0
- data/lib/lms_graphql/mutations/canvas/mutations.rb +19 -8
- data/lib/lms_graphql/mutations/canvas/restore_deleted_eportfolio.rb +24 -0
- data/lib/lms_graphql/mutations/canvas/terminate_all_user_sessions.rb +24 -0
- data/lib/lms_graphql/mutations/canvas/update_associated_courses.rb +2 -2
- data/lib/lms_graphql/mutations/canvas/update_course.rb +8 -2
- data/lib/lms_graphql/mutations/canvas/update_course_settings.rb +3 -1
- data/lib/lms_graphql/resolvers/canvas/get_all_eportfolios_for_user.rb +25 -0
- data/lib/lms_graphql/resolvers/canvas/get_bulk_user_progress.rb +22 -0
- data/lib/lms_graphql/resolvers/canvas/get_custom_colors.rb +1 -1
- data/lib/lms_graphql/resolvers/canvas/get_department_level_statistics_broken_down_by_subaccount_completed.rb +22 -0
- data/lib/lms_graphql/resolvers/canvas/get_department_level_statistics_broken_down_by_subaccount_current.rb +22 -0
- data/lib/lms_graphql/resolvers/canvas/get_department_level_statistics_broken_down_by_subaccount_terms.rb +24 -0
- data/lib/lms_graphql/resolvers/canvas/get_document_annotations_read_state_courses.rb +26 -0
- data/lib/lms_graphql/resolvers/canvas/get_document_annotations_read_state_sections.rb +26 -0
- data/lib/lms_graphql/resolvers/canvas/get_eportfolio.rb +22 -0
- data/lib/lms_graphql/resolvers/canvas/get_eportfolio_pages.rb +23 -0
- data/lib/lms_graphql/resolvers/canvas/get_manually_created_courses_sub_account_for_domain_root_account.rb +22 -0
- data/lib/lms_graphql/resolvers/canvas/get_rubric_comments_read_state_courses.rb +26 -0
- data/lib/lms_graphql/resolvers/canvas/get_rubric_comments_read_state_sections.rb +26 -0
- data/lib/lms_graphql/resolvers/canvas/get_single_submission_by_anonymous_id_courses.rb +28 -0
- data/lib/lms_graphql/resolvers/canvas/get_single_submission_by_anonymous_id_sections.rb +28 -0
- data/lib/lms_graphql/resolvers/canvas/list_announcements.rb +1 -1
- data/lib/lms_graphql/resolvers/canvas/list_missing_submissions.rb +3 -1
- data/lib/lms_graphql/resolvers/canvas/list_planner_items_planner.rb +3 -1
- data/lib/lms_graphql/resolvers/canvas/list_planner_items_users.rb +3 -1
- data/lib/lms_graphql/types/canvas/account_notification_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/appointment_group_input.rb +6 -6
- data/lib/lms_graphql/types/canvas/assignment.rb +1 -0
- data/lib/lms_graphql/types/canvas/assignment_event_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/assignment_input.rb +5 -4
- data/lib/lms_graphql/types/canvas/authentication_event_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/change_record.rb +1 -1
- data/lib/lms_graphql/types/canvas/change_record_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/collaborator_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/comm_message_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/communication_channel_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/completion_requirement_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/content_export_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/content_migration_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/content_share.rb +1 -1
- data/lib/lms_graphql/types/canvas/content_share_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/course_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/discussion_topic.rb +1 -1
- data/lib/lms_graphql/types/canvas/discussion_topic_input.rb +7 -7
- data/lib/lms_graphql/types/canvas/e_portfolio.rb +24 -0
- data/lib/lms_graphql/types/canvas/e_portfolio_input.rb +24 -0
- data/lib/lms_graphql/types/canvas/e_portfolio_page.rb +20 -0
- data/lib/lms_graphql/types/canvas/e_portfolio_page_input.rb +20 -0
- data/lib/lms_graphql/types/canvas/epub_export_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/exception_record.rb +1 -1
- data/lib/lms_graphql/types/canvas/exception_record_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/external_feed_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/favorite_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/feature.rb +1 -1
- data/lib/lms_graphql/types/canvas/feature_flag_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/feature_input.rb +3 -3
- data/lib/lms_graphql/types/canvas/group_category_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/group_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/group_membership_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/inst_access_token.rb +14 -0
- data/lib/lms_graphql/types/canvas/inst_access_token_input.rb +14 -0
- data/lib/lms_graphql/types/canvas/migration_issue_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/module_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/module_item_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/notification_preference_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/outcome_import.rb +2 -1
- data/lib/lms_graphql/types/canvas/outcome_import_input.rb +4 -3
- data/lib/lms_graphql/types/canvas/outcome_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/proficiency.rb +1 -1
- data/lib/lms_graphql/types/canvas/proficiency_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/progress_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/query_type.rb +107 -51
- data/lib/lms_graphql/types/canvas/quiz_input.rb +6 -6
- data/lib/lms_graphql/types/canvas/quiz_report_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/report_parameter_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/rubric_assessment.rb +1 -1
- data/lib/lms_graphql/types/canvas/rubric_assessment_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/sis_assignment_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/sis_import.rb +3 -3
- data/lib/lms_graphql/types/canvas/sis_import_input.rb +5 -5
- data/lib/lms_graphql/types/canvas/submission_input.rb +6 -6
- data/lib/lms_graphql/types/canvas/user.rb +2 -0
- data/lib/lms_graphql/types/canvas/user_input.rb +2 -0
- data/lib/lms_graphql/types/canvas_forward_declarations.rb +20 -16
- data/lib/lms_graphql/types/date_time_type.rb +4 -0
- data/lib/lms_graphql/version.rb +1 -1
- metadata +38 -6
@@ -7,10 +7,6 @@ module LMSGraphQL
|
|
7
7
|
module Canvas
|
8
8
|
class QueryType < BaseType
|
9
9
|
description "The root query of Canvas schema"
|
10
|
-
field :list_scopes,
|
11
|
-
resolver: LMSGraphQL::Resolvers::Canvas::ListScope,
|
12
|
-
description: "List scopes. A list of scopes that can be applied to developer keys and access tokens."
|
13
|
-
|
14
10
|
field :search_account_domains,
|
15
11
|
resolver: LMSGraphQL::Resolvers::Canvas::SearchAccountDomain,
|
16
12
|
description: "Search account domains. Returns a list of up to 5 matching account domains Partial match on name / domain are supported"
|
@@ -71,6 +67,10 @@ module LMSGraphQL
|
|
71
67
|
resolver: LMSGraphQL::Resolvers::Canvas::GetHelpLink,
|
72
68
|
description: "Get help links. Returns the help links for that account"
|
73
69
|
|
70
|
+
field :get_manually_created_courses_sub_account_for_domain_root_account,
|
71
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetManuallyCreatedCoursesSubAccountForDomainRootAccount,
|
72
|
+
description: "Get the manually-created courses sub-account for the domain root account. "
|
73
|
+
|
74
74
|
field :list_active_courses_in_account,
|
75
75
|
resolver: LMSGraphQL::Resolvers::Canvas::ListActiveCoursesInAccount,
|
76
76
|
description: "List active courses in an account. Retrieve a paginated list of courses in this account."
|
@@ -119,6 +119,18 @@ module LMSGraphQL
|
|
119
119
|
resolver: LMSGraphQL::Resolvers::Canvas::GetDepartmentLevelStatisticsCompleted,
|
120
120
|
description: "Get department-level statistics. Returns numeric statistics about the department and term (or filter). Shares the same variations on endpoint as the participation data."
|
121
121
|
|
122
|
+
field :get_department_level_statistics_broken_down_by_subaccount_terms,
|
123
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetDepartmentLevelStatisticsBrokenDownBySubaccountTerm,
|
124
|
+
description: "Get department-level statistics, broken down by subaccount. Returns numeric statistics about the department subaccounts and term (or filter). Shares the same variations on endpoint as the participation data."
|
125
|
+
|
126
|
+
field :get_department_level_statistics_broken_down_by_subaccount_current,
|
127
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetDepartmentLevelStatisticsBrokenDownBySubaccountCurrent,
|
128
|
+
description: "Get department-level statistics, broken down by subaccount. Returns numeric statistics about the department subaccounts and term (or filter). Shares the same variations on endpoint as the participation data."
|
129
|
+
|
130
|
+
field :get_department_level_statistics_broken_down_by_subaccount_completed,
|
131
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetDepartmentLevelStatisticsBrokenDownBySubaccountCompleted,
|
132
|
+
description: "Get department-level statistics, broken down by subaccount. Returns numeric statistics about the department subaccounts and term (or filter). Shares the same variations on endpoint as the participation data."
|
133
|
+
|
122
134
|
field :get_course_level_participation_data,
|
123
135
|
resolver: LMSGraphQL::Resolvers::Canvas::GetCourseLevelParticipationDatum,
|
124
136
|
description: "Get course-level participation data. Returns page view hits and participation numbers grouped by day through the entire history of the course. Page views is returned as a hash, where the hash keys are dates in the format 'YYYY-MM-DD'. The page_views result set includes page views broken out by access category. Participations is returned as an array of dates in the format 'YYYY-MM-DD'."
|
@@ -155,6 +167,10 @@ module LMSGraphQL
|
|
155
167
|
resolver: LMSGraphQL::Resolvers::Canvas::ListAnnouncement,
|
156
168
|
description: "List announcements. Returns the paginated list of announcements for the given courses and date range. Note that a +context_code+ field is added to the responses so you can tell which course each announcement belongs to."
|
157
169
|
|
170
|
+
field :list_scopes,
|
171
|
+
resolver: LMSGraphQL::Resolvers::Canvas::ListScope,
|
172
|
+
description: "List scopes. A list of scopes that can be applied to developer keys and access tokens."
|
173
|
+
|
158
174
|
field :list_appointment_groups,
|
159
175
|
resolver: LMSGraphQL::Resolvers::Canvas::ListAppointmentGroup,
|
160
176
|
description: "List appointment groups. Retrieve the paginated list of appointment groups that can be reserved or managed by the current user."
|
@@ -253,7 +269,7 @@ module LMSGraphQL
|
|
253
269
|
|
254
270
|
field :get_unsynced_changes,
|
255
271
|
resolver: LMSGraphQL::Resolvers::Canvas::GetUnsyncedChange,
|
256
|
-
description: "Get unsynced changes. Retrieve a list of learning objects that have changed since the last blueprint sync operation."
|
272
|
+
description: "Get unsynced changes. Retrieve a list of learning objects that have changed since the last blueprint sync operation. If no syncs have been completed, a ChangeRecord with a change_type of +initial_sync+ is returned."
|
257
273
|
|
258
274
|
field :list_blueprint_migrations,
|
259
275
|
resolver: LMSGraphQL::Resolvers::Canvas::ListBlueprintMigration,
|
@@ -599,6 +615,10 @@ module LMSGraphQL
|
|
599
615
|
resolver: LMSGraphQL::Resolvers::Canvas::CoursesPermission,
|
600
616
|
description: "Permissions. Returns permission information for the calling user in the given course. See also the {api:AccountsController#permissions Account} and {api:GroupsController#permissions Group} counterparts."
|
601
617
|
|
618
|
+
field :get_bulk_user_progress,
|
619
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetBulkUserProgress,
|
620
|
+
description: "Get bulk user progress. Returns progress information for all users enrolled in the given course. You must be a user who has permission to view all grades in the course (such as a teacher or administrator)."
|
621
|
+
|
602
622
|
field :get_course_copy_status,
|
603
623
|
resolver: LMSGraphQL::Resolvers::Canvas::GetCourseCopyStatus,
|
604
624
|
description: "Get course copy status. DEPRECATED: Please use the {api:ContentMigrationsController#create Content Migrations API} Retrieve the status of a course copy"
|
@@ -669,20 +689,40 @@ module LMSGraphQL
|
|
669
689
|
|
670
690
|
field :list_enrollments_courses,
|
671
691
|
resolver: LMSGraphQL::Resolvers::Canvas::ListEnrollmentsCourse,
|
672
|
-
description: "List enrollments. Depending on the URL given, return a paginated list of either (1) all of the enrollments in a course, (2) all of the enrollments in a section or (3) all of a user's enrollments. This includes student, teacher, TA, and observer enrollments. If a user has multiple enrollments in a context (e.g. as a teacher and a student or in multiple course sections), each enrollment will be listed separately. note: Currently, only a root level admin user can return other users' enrollments.
|
692
|
+
description: "List enrollments. Depending on the URL given, return a paginated list of either (1) all of the enrollments in a course, (2) all of the enrollments in a section or (3) all of a user's enrollments. This includes student, teacher, TA, and observer enrollments. If a user has multiple enrollments in a context (e.g. as a teacher and a student or in multiple course sections), each enrollment will be listed separately. note: Currently, only a root level admin user can return other users' enrollments. A user can, however, return his/her own enrollments. Enrollments scoped to a course context will include inactive states by default if the caller has account admin authorization and the state[] parameter is omitted."
|
673
693
|
|
674
694
|
field :list_enrollments_sections,
|
675
695
|
resolver: LMSGraphQL::Resolvers::Canvas::ListEnrollmentsSection,
|
676
|
-
description: "List enrollments. Depending on the URL given, return a paginated list of either (1) all of the enrollments in a course, (2) all of the enrollments in a section or (3) all of a user's enrollments. This includes student, teacher, TA, and observer enrollments. If a user has multiple enrollments in a context (e.g. as a teacher and a student or in multiple course sections), each enrollment will be listed separately. note: Currently, only a root level admin user can return other users' enrollments.
|
696
|
+
description: "List enrollments. Depending on the URL given, return a paginated list of either (1) all of the enrollments in a course, (2) all of the enrollments in a section or (3) all of a user's enrollments. This includes student, teacher, TA, and observer enrollments. If a user has multiple enrollments in a context (e.g. as a teacher and a student or in multiple course sections), each enrollment will be listed separately. note: Currently, only a root level admin user can return other users' enrollments. A user can, however, return his/her own enrollments. Enrollments scoped to a course context will include inactive states by default if the caller has account admin authorization and the state[] parameter is omitted."
|
677
697
|
|
678
698
|
field :list_enrollments_users,
|
679
699
|
resolver: LMSGraphQL::Resolvers::Canvas::ListEnrollmentsUser,
|
680
|
-
description: "List enrollments. Depending on the URL given, return a paginated list of either (1) all of the enrollments in a course, (2) all of the enrollments in a section or (3) all of a user's enrollments. This includes student, teacher, TA, and observer enrollments. If a user has multiple enrollments in a context (e.g. as a teacher and a student or in multiple course sections), each enrollment will be listed separately. note: Currently, only a root level admin user can return other users' enrollments.
|
700
|
+
description: "List enrollments. Depending on the URL given, return a paginated list of either (1) all of the enrollments in a course, (2) all of the enrollments in a section or (3) all of a user's enrollments. This includes student, teacher, TA, and observer enrollments. If a user has multiple enrollments in a context (e.g. as a teacher and a student or in multiple course sections), each enrollment will be listed separately. note: Currently, only a root level admin user can return other users' enrollments. A user can, however, return his/her own enrollments. Enrollments scoped to a course context will include inactive states by default if the caller has account admin authorization and the state[] parameter is omitted."
|
681
701
|
|
682
702
|
field :enrollment_by_id,
|
683
703
|
resolver: LMSGraphQL::Resolvers::Canvas::EnrollmentById,
|
684
704
|
description: "Enrollment by ID. Get an Enrollment object by Enrollment ID"
|
685
705
|
|
706
|
+
field :get_all_eportfolios_for_user,
|
707
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetAllEportfoliosForUser,
|
708
|
+
description: "Get all ePortfolios for a User. Get a list of all ePortfolios for the specified user."
|
709
|
+
|
710
|
+
field :get_eportfolio,
|
711
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetEportfolio,
|
712
|
+
description: "Get an ePortfolio. Get details for a single ePortfolio."
|
713
|
+
|
714
|
+
field :get_eportfolio_pages,
|
715
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetEportfolioPage,
|
716
|
+
description: "Get ePortfolio Pages. Get details for the pages of an ePortfolio"
|
717
|
+
|
718
|
+
field :list_courses_with_their_latest_epub_export,
|
719
|
+
resolver: LMSGraphQL::Resolvers::Canvas::ListCoursesWithTheirLatestEpubExport,
|
720
|
+
description: "List courses with their latest ePub export. A paginated list of all courses a user is actively participating in, and the latest ePub export associated with the user & course."
|
721
|
+
|
722
|
+
field :show_epub_export,
|
723
|
+
resolver: LMSGraphQL::Resolvers::Canvas::ShowEpubExport,
|
724
|
+
description: "Show ePub export. Get information about a single ePub export."
|
725
|
+
|
686
726
|
field :list_external_tools_courses,
|
687
727
|
resolver: LMSGraphQL::Resolvers::Canvas::ListExternalToolsCourse,
|
688
728
|
description: "List external tools. Returns the paginated list of external tools for the current context. See the get request docs for a single tool for a list of properties on an external tool."
|
@@ -1371,10 +1411,6 @@ module LMSGraphQL
|
|
1371
1411
|
resolver: LMSGraphQL::Resolvers::Canvas::GetSinglePollChoice,
|
1372
1412
|
description: "Get a single poll choice. Returns the poll choice with the given id"
|
1373
1413
|
|
1374
|
-
field :get_single_poll_submission,
|
1375
|
-
resolver: LMSGraphQL::Resolvers::Canvas::GetSinglePollSubmission,
|
1376
|
-
description: "Get a single poll submission. Returns the poll submission with the given id"
|
1377
|
-
|
1378
1414
|
field :list_polls,
|
1379
1415
|
resolver: LMSGraphQL::Resolvers::Canvas::ListPoll,
|
1380
1416
|
description: "List polls. Returns the paginated list of polls for the current user."
|
@@ -1383,6 +1419,10 @@ module LMSGraphQL
|
|
1383
1419
|
resolver: LMSGraphQL::Resolvers::Canvas::GetSinglePoll,
|
1384
1420
|
description: "Get a single poll. Returns the poll with the given id"
|
1385
1421
|
|
1422
|
+
field :get_single_poll_submission,
|
1423
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetSinglePollSubmission,
|
1424
|
+
description: "Get a single poll submission. Returns the poll submission with the given id"
|
1425
|
+
|
1386
1426
|
field :get_proficiency_ratings_accounts,
|
1387
1427
|
resolver: LMSGraphQL::Resolvers::Canvas::GetProficiencyRatingsAccount,
|
1388
1428
|
description: "Get proficiency ratings. Get account-level proficiency ratings. If not defined for this account, it will return proficiency ratings for the nearest super-account with ratings defined. Will return 404 if none found. Examples: curl https: <canvas>/api/v1/accounts/<account_id>/outcome_proficiency \ -H 'Authorization: Bearer <token>'"
|
@@ -1503,34 +1543,6 @@ module LMSGraphQL
|
|
1503
1543
|
resolver: LMSGraphQL::Resolvers::Canvas::GetSingleRubricCourse,
|
1504
1544
|
description: "Get a single rubric. Returns the rubric with the given id."
|
1505
1545
|
|
1506
|
-
field :get_sis_import_error_list_sis_imports,
|
1507
|
-
resolver: LMSGraphQL::Resolvers::Canvas::GetSisImportErrorListSisImport,
|
1508
|
-
description: "Get SIS import error list. Returns the list of SIS import errors for an account or a SIS import. Import errors are only stored for 30 days. Example: curl 'https: <canvas>/api/v1/accounts/<account_id>/sis_imports/<id>/sis_import_errors' \ -H 'Authorization: Bearer <token>' Example: curl 'https: <canvas>/api/v1/accounts/<account_id>/sis_import_errors' \ -H 'Authorization: Bearer <token>'"
|
1509
|
-
|
1510
|
-
field :get_sis_import_error_list_sis_import_errors,
|
1511
|
-
resolver: LMSGraphQL::Resolvers::Canvas::GetSisImportErrorListSisImportError,
|
1512
|
-
description: "Get SIS import error list. Returns the list of SIS import errors for an account or a SIS import. Import errors are only stored for 30 days. Example: curl 'https: <canvas>/api/v1/accounts/<account_id>/sis_imports/<id>/sis_import_errors' \ -H 'Authorization: Bearer <token>' Example: curl 'https: <canvas>/api/v1/accounts/<account_id>/sis_import_errors' \ -H 'Authorization: Bearer <token>'"
|
1513
|
-
|
1514
|
-
field :get_sis_import_list,
|
1515
|
-
resolver: LMSGraphQL::Resolvers::Canvas::GetSisImportList,
|
1516
|
-
description: "Get SIS import list. Returns the list of SIS imports for an account Example: curl https: <canvas>/api/v1/accounts/<account_id>/sis_imports \ -H 'Authorization: Bearer <token>'"
|
1517
|
-
|
1518
|
-
field :get_current_importing_sis_import,
|
1519
|
-
resolver: LMSGraphQL::Resolvers::Canvas::GetCurrentImportingSisImport,
|
1520
|
-
description: "Get the current importing SIS import. Returns the SIS imports that are currently processing for an account. If no imports are running, will return an empty array. Example: curl https: <canvas>/api/v1/accounts/<account_id>/sis_imports/importing \ -H 'Authorization: Bearer <token>'"
|
1521
|
-
|
1522
|
-
field :get_sis_import_status,
|
1523
|
-
resolver: LMSGraphQL::Resolvers::Canvas::GetSisImportStatus,
|
1524
|
-
description: "Get SIS import status. Get the status of an already created SIS import. Examples: curl https: <canvas>/api/v1/accounts/<account_id>/sis_imports/<sis_import_id> \ -H 'Authorization: Bearer <token>'"
|
1525
|
-
|
1526
|
-
field :retrieve_assignments_enabled_for_grade_export_to_sis_accounts,
|
1527
|
-
resolver: LMSGraphQL::Resolvers::Canvas::RetrieveAssignmentsEnabledForGradeExportToSisAccount,
|
1528
|
-
description: "Retrieve assignments enabled for grade export to SIS. Retrieve a list of published assignments flagged as 'post_to_sis'. See the Assignments API for more details on assignments. Assignment group and section information are included for convenience. Each section includes course information for the origin course and the cross-listed course, if applicable. The `origin_course` is the course to which the section belongs or the course from which the section was cross-listed. Generally, the `origin_course` should be preferred when performing integration work. The `xlist_course` is provided for consistency and is only present when the section has been cross-listed. See Sections API and Courses Api for me details. The `override` is only provided if the Differentiated Assignments course feature is turned on and the assignment has an override for that section. When there is an override for the assignment the override object's keys/values can be merged with the top level assignment object to create a view of the assignment object specific to that section. See Assignments api for more information on assignment overrides. restricts to courses that start before this date (if they have a start date) restricts to courses that end after this date (if they have an end date) information to include. 'student_overrides':: returns individual student override information"
|
1529
|
-
|
1530
|
-
field :retrieve_assignments_enabled_for_grade_export_to_sis_courses,
|
1531
|
-
resolver: LMSGraphQL::Resolvers::Canvas::RetrieveAssignmentsEnabledForGradeExportToSisCourse,
|
1532
|
-
description: "Retrieve assignments enabled for grade export to SIS. Retrieve a list of published assignments flagged as 'post_to_sis'. See the Assignments API for more details on assignments. Assignment group and section information are included for convenience. Each section includes course information for the origin course and the cross-listed course, if applicable. The `origin_course` is the course to which the section belongs or the course from which the section was cross-listed. Generally, the `origin_course` should be preferred when performing integration work. The `xlist_course` is provided for consistency and is only present when the section has been cross-listed. See Sections API and Courses Api for me details. The `override` is only provided if the Differentiated Assignments course feature is turned on and the assignment has an override for that section. When there is an override for the assignment the override object's keys/values can be merged with the top level assignment object to create a view of the assignment object specific to that section. See Assignments api for more information on assignment overrides. restricts to courses that start before this date (if they have a start date) restricts to courses that end after this date (if they have an end date) information to include. 'student_overrides':: returns individual student override information"
|
1533
|
-
|
1534
1546
|
field :find_recipients_conversations,
|
1535
1547
|
resolver: LMSGraphQL::Resolvers::Canvas::FindRecipientsConversation,
|
1536
1548
|
description: "Find recipients. Find valid recipients (users, courses and groups) that the current user can send messages to. The /api/v1/search/recipients path is the preferred endpoint, /api/v1/conversations/find_recipients is deprecated. Pagination is supported."
|
@@ -1559,6 +1571,34 @@ module LMSGraphQL
|
|
1559
1571
|
resolver: LMSGraphQL::Resolvers::Canvas::GetKalturaConfig,
|
1560
1572
|
description: "Get Kaltura config. Return the config information for the Kaltura plugin in json format."
|
1561
1573
|
|
1574
|
+
field :get_sis_import_error_list_sis_imports,
|
1575
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetSisImportErrorListSisImport,
|
1576
|
+
description: "Get SIS import error list. Returns the list of SIS import errors for an account or a SIS import. Import errors are only stored for 30 days. Example: curl 'https: <canvas>/api/v1/accounts/<account_id>/sis_imports/<id>/sis_import_errors' \ -H 'Authorization: Bearer <token>' Example: curl 'https: <canvas>/api/v1/accounts/<account_id>/sis_import_errors' \ -H 'Authorization: Bearer <token>'"
|
1577
|
+
|
1578
|
+
field :get_sis_import_error_list_sis_import_errors,
|
1579
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetSisImportErrorListSisImportError,
|
1580
|
+
description: "Get SIS import error list. Returns the list of SIS import errors for an account or a SIS import. Import errors are only stored for 30 days. Example: curl 'https: <canvas>/api/v1/accounts/<account_id>/sis_imports/<id>/sis_import_errors' \ -H 'Authorization: Bearer <token>' Example: curl 'https: <canvas>/api/v1/accounts/<account_id>/sis_import_errors' \ -H 'Authorization: Bearer <token>'"
|
1581
|
+
|
1582
|
+
field :get_sis_import_list,
|
1583
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetSisImportList,
|
1584
|
+
description: "Get SIS import list. Returns the list of SIS imports for an account Example: curl https: <canvas>/api/v1/accounts/<account_id>/sis_imports \ -H 'Authorization: Bearer <token>'"
|
1585
|
+
|
1586
|
+
field :get_current_importing_sis_import,
|
1587
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetCurrentImportingSisImport,
|
1588
|
+
description: "Get the current importing SIS import. Returns the SIS imports that are currently processing for an account. If no imports are running, will return an empty array. Example: curl https: <canvas>/api/v1/accounts/<account_id>/sis_imports/importing \ -H 'Authorization: Bearer <token>'"
|
1589
|
+
|
1590
|
+
field :get_sis_import_status,
|
1591
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetSisImportStatus,
|
1592
|
+
description: "Get SIS import status. Get the status of an already created SIS import. Examples: curl https: <canvas>/api/v1/accounts/<account_id>/sis_imports/<sis_import_id> \ -H 'Authorization: Bearer <token>'"
|
1593
|
+
|
1594
|
+
field :retrieve_assignments_enabled_for_grade_export_to_sis_accounts,
|
1595
|
+
resolver: LMSGraphQL::Resolvers::Canvas::RetrieveAssignmentsEnabledForGradeExportToSisAccount,
|
1596
|
+
description: "Retrieve assignments enabled for grade export to SIS. Retrieve a list of published assignments flagged as 'post_to_sis'. See the Assignments API for more details on assignments. Assignment group and section information are included for convenience. Each section includes course information for the origin course and the cross-listed course, if applicable. The `origin_course` is the course to which the section belongs or the course from which the section was cross-listed. Generally, the `origin_course` should be preferred when performing integration work. The `xlist_course` is provided for consistency and is only present when the section has been cross-listed. See Sections API and Courses Api for me details. The `override` is only provided if the Differentiated Assignments course feature is turned on and the assignment has an override for that section. When there is an override for the assignment the override object's keys/values can be merged with the top level assignment object to create a view of the assignment object specific to that section. See Assignments api for more information on assignment overrides. restricts to courses that start before this date (if they have a start date) restricts to courses that end after this date (if they have an end date) information to include. 'student_overrides':: returns individual student override information"
|
1597
|
+
|
1598
|
+
field :retrieve_assignments_enabled_for_grade_export_to_sis_courses,
|
1599
|
+
resolver: LMSGraphQL::Resolvers::Canvas::RetrieveAssignmentsEnabledForGradeExportToSisCourse,
|
1600
|
+
description: "Retrieve assignments enabled for grade export to SIS. Retrieve a list of published assignments flagged as 'post_to_sis'. See the Assignments API for more details on assignments. Assignment group and section information are included for convenience. Each section includes course information for the origin course and the cross-listed course, if applicable. The `origin_course` is the course to which the section belongs or the course from which the section was cross-listed. Generally, the `origin_course` should be preferred when performing integration work. The `xlist_course` is provided for consistency and is only present when the section has been cross-listed. See Sections API and Courses Api for me details. The `override` is only provided if the Differentiated Assignments course feature is turned on and the assignment has an override for that section. When there is an override for the assignment the override object's keys/values can be merged with the top level assignment object to create a view of the assignment object specific to that section. See Assignments api for more information on assignment overrides. restricts to courses that start before this date (if they have a start date) restricts to courses that end after this date (if they have an end date) information to include. 'student_overrides':: returns individual student override information"
|
1601
|
+
|
1562
1602
|
field :list_assignment_submissions_courses,
|
1563
1603
|
resolver: LMSGraphQL::Resolvers::Canvas::ListAssignmentSubmissionsCourse,
|
1564
1604
|
description: "List assignment submissions. A paginated list of all existing submissions for an assignment."
|
@@ -1583,6 +1623,14 @@ module LMSGraphQL
|
|
1583
1623
|
resolver: LMSGraphQL::Resolvers::Canvas::GetSingleSubmissionSection,
|
1584
1624
|
description: "Get a single submission. Get a single submission, based on user id."
|
1585
1625
|
|
1626
|
+
field :get_single_submission_by_anonymous_id_courses,
|
1627
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetSingleSubmissionByAnonymousIdCourse,
|
1628
|
+
description: "Get a single submission by anonymous id. Get a single submission, based on the submission's anonymous id."
|
1629
|
+
|
1630
|
+
field :get_single_submission_by_anonymous_id_sections,
|
1631
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetSingleSubmissionByAnonymousIdSection,
|
1632
|
+
description: "Get a single submission by anonymous id. Get a single submission, based on the submission's anonymous id."
|
1633
|
+
|
1586
1634
|
field :list_gradeable_students,
|
1587
1635
|
resolver: LMSGraphQL::Resolvers::Canvas::ListGradeableStudent,
|
1588
1636
|
description: "List gradeable students. A paginated list of students eligible to submit the assignment. The caller must have permission to view grades. If anonymous grading is enabled for the current assignment and the allow_new_anonymous_id parameter is passed, the returned data will not include any values identifying the student, but will instead include an assignment-specific anonymous ID for each student. Section-limited instructors will only see students in their own sections."
|
@@ -1591,6 +1639,22 @@ module LMSGraphQL
|
|
1591
1639
|
resolver: LMSGraphQL::Resolvers::Canvas::ListMultipleAssignmentsGradeableStudent,
|
1592
1640
|
description: "List multiple assignments gradeable students. A paginated list of students eligible to submit a list of assignments. The caller must have permission to view grades for the requested course. Section-limited instructors will only see students in their own sections."
|
1593
1641
|
|
1642
|
+
field :get_rubric_comments_read_state_courses,
|
1643
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetRubricCommentsReadStateCourse,
|
1644
|
+
description: "Get rubric comments read state. Return whether new rubric comments made on a submission have been seen by the student being assessed."
|
1645
|
+
|
1646
|
+
field :get_rubric_comments_read_state_sections,
|
1647
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetRubricCommentsReadStateSection,
|
1648
|
+
description: "Get rubric comments read state. Return whether new rubric comments made on a submission have been seen by the student being assessed."
|
1649
|
+
|
1650
|
+
field :get_document_annotations_read_state_courses,
|
1651
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetDocumentAnnotationsReadStateCourse,
|
1652
|
+
description: "Get document annotations read state. Return whether annotations made on a submitted document have been read by the student"
|
1653
|
+
|
1654
|
+
field :get_document_annotations_read_state_sections,
|
1655
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetDocumentAnnotationsReadStateSection,
|
1656
|
+
description: "Get document annotations read state. Return whether annotations made on a submitted document have been read by the student"
|
1657
|
+
|
1594
1658
|
field :submission_summary_courses,
|
1595
1659
|
resolver: LMSGraphQL::Resolvers::Canvas::SubmissionSummaryCourse,
|
1596
1660
|
description: "Submission Summary. Returns the number of submissions for the given assignment based on gradeable students that fall into three categories: graded, ungraded, not submitted."
|
@@ -1621,7 +1685,7 @@ module LMSGraphQL
|
|
1621
1685
|
|
1622
1686
|
field :list_observers,
|
1623
1687
|
resolver: LMSGraphQL::Resolvers::Canvas::ListObserver,
|
1624
|
-
description: "List observers. A paginated list of the
|
1688
|
+
description: "List observers. A paginated list of the observers of a given user. *Note:* all users are allowed to list their own observers. Administrators can list other users' observers. The returned observers will include an attribute 'observation_link_root_account_ids', a list of ids for the root accounts the observer and observee are linked on. The observer will only be able to observe in courses associated with these root accounts."
|
1625
1689
|
|
1626
1690
|
field :show_observee,
|
1627
1691
|
resolver: LMSGraphQL::Resolvers::Canvas::ShowObservee,
|
@@ -1629,7 +1693,7 @@ module LMSGraphQL
|
|
1629
1693
|
|
1630
1694
|
field :show_observer,
|
1631
1695
|
resolver: LMSGraphQL::Resolvers::Canvas::ShowObserver,
|
1632
|
-
description: "Show an observer. Gets information about an
|
1696
|
+
description: "Show an observer. Gets information about an observer. *Note:* all users are allowed to view their own observers."
|
1633
1697
|
|
1634
1698
|
field :list_users_in_account,
|
1635
1699
|
resolver: LMSGraphQL::Resolvers::Canvas::ListUsersInAccount,
|
@@ -1672,7 +1736,7 @@ module LMSGraphQL
|
|
1672
1736
|
description: "Update user settings.. Update an existing user's settings."
|
1673
1737
|
|
1674
1738
|
field :get_custom_colors,
|
1675
|
-
resolver: LMSGraphQL::Resolvers::Canvas::
|
1739
|
+
resolver: LMSGraphQL::Resolvers::Canvas::GetCustomColors,
|
1676
1740
|
description: "Get custom colors. Returns all custom colors that have been saved for a user."
|
1677
1741
|
|
1678
1742
|
field :get_custom_color,
|
@@ -1718,14 +1782,6 @@ module LMSGraphQL
|
|
1718
1782
|
field :list_all_webhook_subscription_for_tool_proxy,
|
1719
1783
|
resolver: LMSGraphQL::Resolvers::Canvas::ListAllWebhookSubscriptionForToolProxy,
|
1720
1784
|
description: "List all Webhook Subscription for a tool proxy. This endpoint returns a paginated list with a default limit of 100 items per result set. You can retrieve the next result set by setting a 'StartKey' header in your next request with the value of the 'EndKey' header in the response. Example use of a 'StartKey' header object: { 'Id':'71d6dfba-0547-477d-b41d-db8cb528c6d1','DeveloperKey':'10000000000001' }"
|
1721
|
-
|
1722
|
-
field :list_courses_with_their_latest_epub_export,
|
1723
|
-
resolver: LMSGraphQL::Resolvers::Canvas::ListCoursesWithTheirLatestEpubExport,
|
1724
|
-
description: "List courses with their latest ePub export. A paginated list of all courses a user is actively participating in, and the latest ePub export associated with the user & course."
|
1725
|
-
|
1726
|
-
field :show_epub_export,
|
1727
|
-
resolver: LMSGraphQL::Resolvers::Canvas::ShowEpubExport,
|
1728
|
-
description: "Show ePub export. Get information about a single ePub export."
|
1729
1785
|
end
|
1730
1786
|
end
|
1731
1787
|
end
|
@@ -7,19 +7,19 @@ module LMSGraphQL
|
|
7
7
|
module Types
|
8
8
|
module Canvas
|
9
9
|
class CanvasQuizInput < BaseInputObject
|
10
|
-
class
|
10
|
+
class QuizInputQuizTypeEnum < ::GraphQL::Schema::Enum
|
11
11
|
value "practice_quiz"
|
12
12
|
value "assignment"
|
13
13
|
value "graded_survey"
|
14
14
|
value "survey"
|
15
15
|
end
|
16
16
|
|
17
|
-
class
|
17
|
+
class QuizInputHideResultEnum < ::GraphQL::Schema::Enum
|
18
18
|
value "always"
|
19
19
|
value "until_after_last_attempt"
|
20
20
|
end
|
21
21
|
|
22
|
-
class
|
22
|
+
class QuizInputScoringPolicyEnum < ::GraphQL::Schema::Enum
|
23
23
|
value "keep_highest"
|
24
24
|
value "keep_latest"
|
25
25
|
end
|
@@ -30,17 +30,17 @@ module LMSGraphQL
|
|
30
30
|
argument :mobile_url, String, "a url suitable for loading the quiz in a mobile webview. it will persiste the headless session and, for quizzes in public courses, will force the user to login.Example: http://canvas.example.edu/courses/1/quizzes/2?persist_healdess=1&force_user=1", required: false
|
31
31
|
argument :preview_url, String, "A url that can be visited in the browser with a POST request to preview a quiz as the teacher. Only present when the user may grade.Example: http://canvas.example.edu/courses/1/quizzes/2/take?preview=1", required: false
|
32
32
|
argument :description, String, "the description of the quiz.Example: This is a quiz on Act 3 of Hamlet", required: false
|
33
|
-
argument :quiz_type,
|
33
|
+
argument :quiz_type, QuizInputQuizTypeEnum, "type of quiz possible values: 'practice_quiz', 'assignment', 'graded_survey', 'survey'.Example: assignment", required: false
|
34
34
|
argument :assignment_group_id, ID, "the ID of the quiz's assignment group:.Example: 3", required: false
|
35
35
|
argument :time_limit, Int, "quiz time limit in minutes.Example: 5", required: false
|
36
36
|
argument :shuffle_answers, Boolean, "shuffle answers for students?.", required: false
|
37
|
-
argument :hide_results,
|
37
|
+
argument :hide_results, QuizInputHideResultEnum, "let students see their quiz responses? possible values: null, 'always', 'until_after_last_attempt'.Example: always", required: false
|
38
38
|
argument :show_correct_answers, Boolean, "show which answers were correct when results are shown? only valid if hide_results=null.Example: true", required: false
|
39
39
|
argument :show_correct_answers_last_attempt, Boolean, "restrict the show_correct_answers option above to apply only to the last submitted attempt of a quiz that allows multiple attempts. only valid if show_correct_answers=true and allowed_attempts > 1.Example: true", required: false
|
40
40
|
argument :show_correct_answers_at, LMSGraphQL::Types::DateTimeType, "when should the correct answers be visible by students? only valid if show_correct_answers=true.Example: 2013-01-23T23:59:00-07:00", required: false
|
41
41
|
argument :hide_correct_answers_at, LMSGraphQL::Types::DateTimeType, "prevent the students from seeing correct answers after the specified date has passed. only valid if show_correct_answers=true.Example: 2013-01-23T23:59:00-07:00", required: false
|
42
42
|
argument :one_time_results, Boolean, "prevent the students from seeing their results more than once (right after they submit the quiz).Example: true", required: false
|
43
|
-
argument :scoring_policy,
|
43
|
+
argument :scoring_policy, QuizInputScoringPolicyEnum, "which quiz score to keep (only if allowed_attempts != 1) possible values: 'keep_highest', 'keep_latest'.Example: keep_highest", required: false
|
44
44
|
argument :allowed_attempts, Int, "how many times a student can take the quiz -1 = unlimited attempts.Example: 3", required: false
|
45
45
|
argument :one_question_at_a_time, Boolean, "show one question at a time?.", required: false
|
46
46
|
argument :question_count, Int, "the number of questions in the quiz.Example: 12", required: false
|
@@ -6,14 +6,14 @@ module LMSGraphQL
|
|
6
6
|
module Types
|
7
7
|
module Canvas
|
8
8
|
class CanvasQuizReportInput < BaseInputObject
|
9
|
-
class
|
9
|
+
class QuizReportInputReportTypeEnum < ::GraphQL::Schema::Enum
|
10
10
|
value "student_analysis"
|
11
11
|
value "item_analysis"
|
12
12
|
end
|
13
13
|
description "Quiz Reports. API Docs: https://canvas.instructure.com/doc/api/quiz_reports.html"
|
14
14
|
argument :id, ID, "the ID of the quiz report.Example: 5", required: false
|
15
15
|
argument :quiz_id, ID, "the ID of the quiz.Example: 4", required: false
|
16
|
-
argument :report_type,
|
16
|
+
argument :report_type, QuizReportInputReportTypeEnum, "which type of report this is possible values: 'student_analysis', 'item_analysis'.Example: student_analysis", required: false
|
17
17
|
argument :readable_type, String, "a human-readable (and localized) version of the report_type.Example: Student Analysis", required: false
|
18
18
|
argument :includes_all_versions, Boolean, "boolean indicating whether the report represents all submissions or only the most recent ones for each student.Example: true", required: false
|
19
19
|
argument :anonymous, Boolean, "boolean indicating whether the report is for an anonymous survey. if true, no student names will be included in the csv.", required: false
|
@@ -5,7 +5,7 @@ module LMSGraphQL
|
|
5
5
|
module Types
|
6
6
|
module Canvas
|
7
7
|
class CanvasReportParameterInput < BaseInputObject
|
8
|
-
class
|
8
|
+
class ReportParameterInputOrderEnum < ::GraphQL::Schema::Enum
|
9
9
|
value "users"
|
10
10
|
value "courses"
|
11
11
|
value "outcomes"
|
@@ -14,7 +14,7 @@ module LMSGraphQL
|
|
14
14
|
argument :enrollment_term_id, ID, "The canvas id of the term to get grades from.Example: 2", required: false
|
15
15
|
argument :include_deleted, Boolean, "If true, deleted objects will be included. If false, deleted objects will be omitted..", required: false
|
16
16
|
argument :course_id, ID, "The id of the course to report on.Example: 2", required: false
|
17
|
-
argument :order,
|
17
|
+
argument :order, ReportParameterInputOrderEnum, "The sort order for the csv, Options: 'users', 'courses', 'outcomes'..Example: users", required: false
|
18
18
|
argument :users, Boolean, "If true, user data will be included. If false, user data will be omitted..", required: false
|
19
19
|
argument :accounts, Boolean, "If true, account data will be included. If false, account data will be omitted..", required: false
|
20
20
|
argument :terms, Boolean, "If true, term data will be included. If false, term data will be omitted..", required: false
|
@@ -15,7 +15,7 @@ module LMSGraphQL
|
|
15
15
|
field :artifact_attempt, Int, "the current number of attempts made on the object of the assessment.Example: 2", null: true
|
16
16
|
field :assessment_type, String, "the type of assessment. values will be either 'grading', 'peer_review', or 'provisional_grade'.Example: grading", null: true
|
17
17
|
field :assessor_id, ID, "user id of the person who made the assessment.Example: 6", null: true
|
18
|
-
field :data, String, "(Optional) If 'full' is included in the 'style' parameter, returned assessments will have their full details contained in their data hash. If the user does not request a style, this key will be absent..", null: true
|
18
|
+
field :data, [String], "(Optional) If 'full' is included in the 'style' parameter, returned assessments will have their full details contained in their data hash. If the user does not request a style, this key will be absent..", null: true
|
19
19
|
field :comments, [String], "(Optional) If 'comments_only' is included in the 'style' parameter, returned assessments will include only the comments portion of their data hash. If the user does not request a style, this key will be absent..", null: true
|
20
20
|
|
21
21
|
end
|
@@ -15,7 +15,7 @@ module LMSGraphQL
|
|
15
15
|
argument :artifact_attempt, Int, "the current number of attempts made on the object of the assessment.Example: 2", required: false
|
16
16
|
argument :assessment_type, String, "the type of assessment. values will be either 'grading', 'peer_review', or 'provisional_grade'.Example: grading", required: false
|
17
17
|
argument :assessor_id, ID, "user id of the person who made the assessment.Example: 6", required: false
|
18
|
-
argument :data, String, "(Optional) If 'full' is included in the 'style' parameter, returned assessments will have their full details contained in their data hash. If the user does not request a style, this key will be absent..", required: false
|
18
|
+
argument :data, [String], "(Optional) If 'full' is included in the 'style' parameter, returned assessments will have their full details contained in their data hash. If the user does not request a style, this key will be absent..", required: false
|
19
19
|
argument :comments, [String], "(Optional) If 'comments_only' is included in the 'style' parameter, returned assessments will include only the comments portion of their data hash. If the user does not request a style, this key will be absent..", required: false
|
20
20
|
|
21
21
|
end
|
@@ -7,7 +7,7 @@ module LMSGraphQL
|
|
7
7
|
module Types
|
8
8
|
module Canvas
|
9
9
|
class CanvasSisAssignmentInput < BaseInputObject
|
10
|
-
class
|
10
|
+
class SisAssignmentInputSubmissionTypeEnum < ::GraphQL::Schema::Enum
|
11
11
|
value "discussion_topic"
|
12
12
|
value "online_quiz"
|
13
13
|
value "on_paper"
|
@@ -29,7 +29,7 @@ module LMSGraphQL
|
|
29
29
|
argument :unlock_at, LMSGraphQL::Types::DateTimeType, "(Optional) Time at which this was/will be unlocked..Example: 2013-01-01T00:00:00-06:00", required: false
|
30
30
|
argument :lock_at, LMSGraphQL::Types::DateTimeType, "(Optional) Time at which this was/will be locked..Example: 2013-02-01T00:00:00-06:00", required: false
|
31
31
|
argument :points_possible, Int, "The maximum points possible for the assignment.Example: 12", required: false
|
32
|
-
argument :submission_types,
|
32
|
+
argument :submission_types, SisAssignmentInputSubmissionTypeEnum, "the types of submissions allowed for this assignment list containing one or more of the following: 'discussion_topic', 'online_quiz', 'on_paper', 'none', 'external_tool', 'online_text_entry', 'online_url', 'online_upload', 'media_recording', 'student_annotation'.Example: online_text_entry", required: false
|
33
33
|
argument :integration_id, ID, "Third Party integration id for assignment.Example: 12341234", required: false
|
34
34
|
argument :integration_data, String, "(optional, Third Party integration data for assignment).Example: other_data", required: false
|
35
35
|
argument :include_in_final_grade, Boolean, "If false, the assignment will be omitted from the student's final grade.Example: true", required: false
|
@@ -45,8 +45,8 @@ module LMSGraphQL
|
|
45
45
|
field :progress, String, "The progress of the SIS import. The progress will reset when using batch_mode and have a different progress for the cleanup stage.Example: 100", null: true
|
46
46
|
field :errors_attachment, LMSGraphQL::Types::Canvas::CanvasFile, "The errors_attachment api object of the SIS import. Only available if there are errors or warning and import has completed..", null: true
|
47
47
|
field :user, LMSGraphQL::Types::Canvas::CanvasUser, "The user that initiated the sis_batch. See the Users API for details..", null: true
|
48
|
-
field :processing_warnings, String, "Only imports that are complete will get this data. An array of CSV_file/warning_message pairs..Example: students.csv, user John Doe has already claimed john_doe's requested login information, skipping", null: true
|
49
|
-
field :processing_errors, String, "An array of CSV_file/error_message pairs..Example: students.csv, Error while importing CSV. Please contact support.", null: true
|
48
|
+
field :processing_warnings, [String], "Only imports that are complete will get this data. An array of CSV_file/warning_message pairs..Example: students.csv, user John Doe has already claimed john_doe's requested login information, skipping", null: true
|
49
|
+
field :processing_errors, [String], "An array of CSV_file/error_message pairs..Example: students.csv, Error while importing CSV. Please contact support.", null: true
|
50
50
|
field :batch_mode, Boolean, "Whether the import was run in batch mode..Example: true", null: true
|
51
51
|
field :batch_mode_term_id, ID, "The term the batch was limited to..Example: 1234", null: true
|
52
52
|
field :multi_term_batch_mode, Boolean, "Enables batch mode against all terms in term file. Requires change_threshold to be set..Example: false", null: true
|
@@ -56,7 +56,7 @@ module LMSGraphQL
|
|
56
56
|
field :clear_sis_stickiness, Boolean, "Whether stickiness was cleared..Example: false", null: true
|
57
57
|
field :diffing_data_set_identifier, String, "The identifier of the data set that this SIS batch diffs against.Example: account-5-enrollments", null: true
|
58
58
|
field :diffed_against_import_id, ID, "The ID of the SIS Import that this import was diffed against.Example: 1", null: true
|
59
|
-
field :csv_attachments, String, "An array of CSV files for processing.", null: true
|
59
|
+
field :csv_attachments, [String], "An array of CSV files for processing.", null: true
|
60
60
|
|
61
61
|
end
|
62
62
|
end
|
@@ -8,7 +8,7 @@ module LMSGraphQL
|
|
8
8
|
module Types
|
9
9
|
module Canvas
|
10
10
|
class CanvasSisImportInput < BaseInputObject
|
11
|
-
class
|
11
|
+
class SisImportInputWorkflowStateEnum < ::GraphQL::Schema::Enum
|
12
12
|
value "initializing"
|
13
13
|
value "created"
|
14
14
|
value "importing"
|
@@ -27,7 +27,7 @@ module LMSGraphQL
|
|
27
27
|
argument :created_at, LMSGraphQL::Types::DateTimeType, "The date the SIS import was created..Example: 2013-12-01T23:59:00-06:00", required: false
|
28
28
|
argument :ended_at, LMSGraphQL::Types::DateTimeType, "The date the SIS import finished. Returns null if not finished..Example: 2013-12-02T00:03:21-06:00", required: false
|
29
29
|
argument :updated_at, LMSGraphQL::Types::DateTimeType, "The date the SIS import was last updated..Example: 2013-12-02T00:03:21-06:00", required: false
|
30
|
-
argument :workflow_state,
|
30
|
+
argument :workflow_state, SisImportInputWorkflowStateEnum, "The current state of the SIS import.
|
31
31
|
- 'initializing': The SIS import is being created, if this gets stuck in initializing, it will not import and will continue on to next import.
|
32
32
|
- 'created': The SIS import has been created.
|
33
33
|
- 'importing': The SIS import is currently processing.
|
@@ -45,8 +45,8 @@ module LMSGraphQL
|
|
45
45
|
argument :progress, String, "The progress of the SIS import. The progress will reset when using batch_mode and have a different progress for the cleanup stage.Example: 100", required: false
|
46
46
|
argument :errors_attachment, LMSGraphQL::Types::Canvas::CanvasFileInput, "The errors_attachment api object of the SIS import. Only available if there are errors or warning and import has completed..", required: false
|
47
47
|
argument :user, LMSGraphQL::Types::Canvas::CanvasUserInput, "The user that initiated the sis_batch. See the Users API for details..", required: false
|
48
|
-
argument :processing_warnings, String, "Only imports that are complete will get this data. An array of CSV_file/warning_message pairs..Example: students.csv, user John Doe has already claimed john_doe's requested login information, skipping", required: false
|
49
|
-
argument :processing_errors, String, "An array of CSV_file/error_message pairs..Example: students.csv, Error while importing CSV. Please contact support.", required: false
|
48
|
+
argument :processing_warnings, [String], "Only imports that are complete will get this data. An array of CSV_file/warning_message pairs..Example: students.csv, user John Doe has already claimed john_doe's requested login information, skipping", required: false
|
49
|
+
argument :processing_errors, [String], "An array of CSV_file/error_message pairs..Example: students.csv, Error while importing CSV. Please contact support.", required: false
|
50
50
|
argument :batch_mode, Boolean, "Whether the import was run in batch mode..Example: true", required: false
|
51
51
|
argument :batch_mode_term_id, ID, "The term the batch was limited to..Example: 1234", required: false
|
52
52
|
argument :multi_term_batch_mode, Boolean, "Enables batch mode against all terms in term file. Requires change_threshold to be set..Example: false", required: false
|
@@ -56,7 +56,7 @@ module LMSGraphQL
|
|
56
56
|
argument :clear_sis_stickiness, Boolean, "Whether stickiness was cleared..Example: false", required: false
|
57
57
|
argument :diffing_data_set_identifier, String, "The identifier of the data set that this SIS batch diffs against.Example: account-5-enrollments", required: false
|
58
58
|
argument :diffed_against_import_id, ID, "The ID of the SIS Import that this import was diffed against.Example: 1", required: false
|
59
|
-
argument :csv_attachments, String, "An array of CSV files for processing.", required: false
|
59
|
+
argument :csv_attachments, [String], "An array of CSV files for processing.", required: false
|
60
60
|
|
61
61
|
end
|
62
62
|
end
|
@@ -8,7 +8,7 @@ module LMSGraphQL
|
|
8
8
|
module Types
|
9
9
|
module Canvas
|
10
10
|
class CanvasSubmissionInput < BaseInputObject
|
11
|
-
class
|
11
|
+
class SubmissionInputSubmissionTypeEnum < ::GraphQL::Schema::Enum
|
12
12
|
value "online_text_entry"
|
13
13
|
value "online_url"
|
14
14
|
value "online_upload"
|
@@ -16,14 +16,14 @@ module LMSGraphQL
|
|
16
16
|
value "student_annotation"
|
17
17
|
end
|
18
18
|
|
19
|
-
class
|
19
|
+
class SubmissionInputWorkflowStateEnum < ::GraphQL::Schema::Enum
|
20
20
|
value "graded"
|
21
21
|
value "submitted"
|
22
22
|
value "unsubmitted"
|
23
23
|
value "pending_review"
|
24
24
|
end
|
25
25
|
|
26
|
-
class
|
26
|
+
class SubmissionInputReadStatusEnum < ::GraphQL::Schema::Enum
|
27
27
|
value "read"
|
28
28
|
value "unread"
|
29
29
|
end
|
@@ -39,7 +39,7 @@ module LMSGraphQL
|
|
39
39
|
argument :preview_url, String, "URL to the submission preview. This will require the user to log in..Example: http://example.com/courses/255/assignments/543/submissions/134?preview=1", required: false
|
40
40
|
argument :score, Float, "The raw score.Example: 13.5", required: false
|
41
41
|
argument :submission_comments, [LMSGraphQL::Types::Canvas::CanvasSubmissionCommentInput], "Associated comments for a submission (optional).", required: false
|
42
|
-
argument :submission_type,
|
42
|
+
argument :submission_type, SubmissionInputSubmissionTypeEnum, "The types of submission ex: ('online_text_entry'|'online_url'|'online_upload'|'media_recording'|'student_annotation').Example: online_text_entry", required: false
|
43
43
|
argument :submitted_at, LMSGraphQL::Types::DateTimeType, "The timestamp when the assignment was submitted.Example: 2012-01-01T01:00:00Z", required: false
|
44
44
|
argument :url, String, "The URL of the submission (for 'online_url' submissions)..", required: false
|
45
45
|
argument :user_id, ID, "The id of the user who created the submission.Example: 134", required: false
|
@@ -53,11 +53,11 @@ module LMSGraphQL
|
|
53
53
|
argument :late_policy_status, String, "The status of the submission in relation to the late policy. Can be late, missing, none, or null..Example: missing", required: false
|
54
54
|
argument :points_deducted, Float, "The amount of points automatically deducted from the score by the missing/late policy for a late or missing assignment..Example: 12.3", required: false
|
55
55
|
argument :seconds_late, Float, "The amount of time, in seconds, that an submission is late by..Example: 300", required: false
|
56
|
-
argument :workflow_state,
|
56
|
+
argument :workflow_state, SubmissionInputWorkflowStateEnum, "The current state of the submission.Example: submitted", required: false
|
57
57
|
argument :extra_attempts, Float, "Extra submission attempts allowed for the given user and assignment..Example: 10", required: false
|
58
58
|
argument :anonymous_id, ID, "A unique short ID identifying this submission without reference to the owning user. Only included if the caller has administrator access for the current account..Example: acJ4Q", required: false
|
59
59
|
argument :posted_at, LMSGraphQL::Types::DateTimeType, "The date this submission was posted to the student, or nil if it has not been posted..Example: 2020-01-02T11:10:30Z", required: false
|
60
|
-
argument :read_status,
|
60
|
+
argument :read_status, SubmissionInputReadStatusEnum, "The read status of this submission for the given user (optional). Including read_status will mark submission(s) as read..Example: read", required: false
|
61
61
|
|
62
62
|
end
|
63
63
|
end
|
@@ -9,6 +9,8 @@ module LMSGraphQL
|
|
9
9
|
field :id, ID, "The ID of the user..Example: 2", null: true
|
10
10
|
field :name, String, "The name of the user..Example: Sheldon Cooper", null: true
|
11
11
|
field :sortable_name, String, "The name of the user that is should be used for sorting groups of users, such as in the gradebook..Example: Cooper, Sheldon", null: true
|
12
|
+
field :last_name, String, "The last name of the user..Example: Cooper", null: true
|
13
|
+
field :first_name, String, "The first name of the user..Example: Sheldon", null: true
|
12
14
|
field :short_name, String, "A short name the user has selected, for use in conversations or other less formal places through the site..Example: Shelly", null: true
|
13
15
|
field :sis_user_id, ID, "The SIS ID associated with the user. This field is only included if the user came from a SIS import and has permissions to view SIS information..Example: SHEL93921", null: true
|
14
16
|
field :sis_import_id, ID, "The id of the SIS import. This field is only included if the user came from a SIS import and has permissions to manage SIS information..Example: 18", null: true
|
@@ -9,6 +9,8 @@ module LMSGraphQL
|
|
9
9
|
argument :id, ID, "The ID of the user..Example: 2", required: false
|
10
10
|
argument :name, String, "The name of the user..Example: Sheldon Cooper", required: false
|
11
11
|
argument :sortable_name, String, "The name of the user that is should be used for sorting groups of users, such as in the gradebook..Example: Cooper, Sheldon", required: false
|
12
|
+
argument :last_name, String, "The last name of the user..Example: Cooper", required: false
|
13
|
+
argument :first_name, String, "The first name of the user..Example: Sheldon", required: false
|
12
14
|
argument :short_name, String, "A short name the user has selected, for use in conversations or other less formal places through the site..Example: Shelly", required: false
|
13
15
|
argument :sis_user_id, ID, "The SIS ID associated with the user. This field is only included if the user came from a SIS import and has permissions to view SIS information..Example: SHEL93921", required: false
|
14
16
|
argument :sis_import_id, ID, "The id of the SIS import. This field is only included if the user came from a SIS import and has permissions to manage SIS information..Example: 18", required: false
|