forked from instructure/canvas-lms
-
Notifications
You must be signed in to change notification settings - Fork 0
/
schema.graphql
3444 lines (3010 loc) · 62.1 KB
/
schema.graphql
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
type Account implements LegacyIDInterface & Node {
"""
legacy canvas id
"""
_id: ID!
id: ID!
name: String
proficiencyRatingsConnection(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): ProficiencyRatingConnection
}
"""
A list of students that an `AssignmentOverride` applies to
"""
type AdhocStudents {
students: [User!]
}
"""
The type of assessment
"""
enum AssessmentType {
grading
peer_review
provisional_grade
}
type Assignment implements LegacyIDInterface & ModuleItemInterface & Node & Timestamped {
"""
legacy canvas id
"""
_id: ID!
allowGoogleDocsSubmission: Boolean
"""
The number of submission attempts a student can make for this assignment. null implies unlimited.
"""
allowedAttempts: Int
"""
permitted uploaded file extensions (e.g. ['doc', 'xls', 'txt'])
"""
allowedExtensions: [String!]
anonymizeStudents: Boolean
anonymousGrading: Boolean
anonymousInstructorAnnotations: Boolean
assignmentGroup: AssignmentGroup
assignmentOverrides(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): AssignmentOverrideConnection
canDuplicate: Boolean
canUnpublish: Boolean
course: Course
createdAt: DateTime
description: String
discussion: Discussion
"""
when this assignment is due
"""
dueAt(
"""
When true, return the overridden dates.
Not all roles have permission to view un-overridden dates (in which
case the overridden dates will be returned)
"""
applyOverrides: Boolean = true
): DateTime
dueDateRequired: Boolean
expectsExternalSubmission: Boolean
expectsSubmission: Boolean
"""
If this is a group assignment, boolean flag indicating whether or not students will be graded individually.
"""
gradeGroupStudentsIndividually: Boolean
gradingType: GradingType
groupSet: GroupSet
"""
returns submissions grouped to one submission object per group
"""
groupSubmissionsConnection(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
filter: SubmissionSearchFilterInput
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
orderBy: [SubmissionSearchOrder!]
): SubmissionConnection
"""
If true, the assignment has been submitted to by at least one student
"""
hasSubmittedSubmissions: Boolean
htmlUrl: URL
id: ID!
inClosedGradingPeriod: Boolean
"""
the lock date (assignment is locked after this date)
"""
lockAt(
"""
When true, return the overridden dates.
Not all roles have permission to view un-overridden dates (in which
case the overridden dates will be returned)
"""
applyOverrides: Boolean = true
): DateTime
lockInfo: LockInfo
moderatedGrading: ModeratedGrading
modules: [Module!]
muted: Boolean!
name: String
needsGradingCount: Int
nonDigitalSubmission: Boolean
"""
If true, the assignment will be omitted from the student's final grade
"""
omitFromFinalGrade: Boolean
"""
specifies that this assignment is only assigned to students for whom an
`AssignmentOverride` applies.
"""
onlyVisibleToOverrides: Boolean!
peerReviews: PeerReviews
"""
the assignment is out of this many points
"""
pointsPossible: Float
"""
determines the order this assignment is displayed in in its assignment group
"""
position: Int
postPolicy: PostPolicy
"""
present if Sync Grades to SIS feature is enabled
"""
postToSis: Boolean
quiz: Quiz
rubric: Rubric
state: AssignmentState!
submissionTypes: [SubmissionType!]
"""
submissions for this assignment
"""
submissionsConnection(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
filter: SubmissionSearchFilterInput
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
orderBy: [SubmissionSearchOrder!]
): SubmissionConnection
submissionsDownloads: Int
timeZoneEdited: String
"""
the unlock date (assignment is unlocked after this date)
"""
unlockAt(
"""
When true, return the overridden dates.
Not all roles have permission to view un-overridden dates (in which
case the overridden dates will be returned)
"""
applyOverrides: Boolean = true
): DateTime
updatedAt: DateTime
}
"""
The connection type for Assignment.
"""
type AssignmentConnection {
"""
A list of edges.
"""
edges: [AssignmentEdge]
"""
A list of nodes.
"""
nodes: [Assignment]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
}
"""
An edge in a connection.
"""
type AssignmentEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: Assignment
}
input AssignmentFilter {
"""
only return assignments for the given grading period. Defaults to
the current grading period. Pass `null` to return all assignments
(irrespective of the assignment's grading period)
"""
gradingPeriodId: ID
}
type AssignmentGroup implements AssignmentsConnectionInterface & LegacyIDInterface & Node & Timestamped {
"""
legacy canvas id
"""
_id: ID!
"""
returns a list of assignments.
**NOTE**: for courses with grading periods, this will only return grading
periods in the current course; see `AssignmentFilter` for more info.
In courses with grading periods that don't have students, it is necessary
to *not* filter by grading period to list assignments.
"""
assignmentsConnection(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
filter: AssignmentFilter
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): AssignmentConnection
createdAt: DateTime
"""
grades for this assignment group
"""
gradesConnection(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): GradesConnection
groupWeight: Float
id: ID!
name: String
position: Int
rules: AssignmentGroupRules
state: AssignmentGroupState!
updatedAt: DateTime
}
"""
The connection type for AssignmentGroup.
"""
type AssignmentGroupConnection {
"""
A list of edges.
"""
edges: [AssignmentGroupEdge]
"""
A list of nodes.
"""
nodes: [AssignmentGroup]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
}
"""
An edge in a connection.
"""
type AssignmentGroupEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: AssignmentGroup
}
type AssignmentGroupRules {
"""
The highest N assignments are not included in grade calculations
"""
dropHighest: Int
"""
The lowest N assignments are not included in grade calculations
"""
dropLowest: Int
neverDrop: [Assignment!]
}
"""
States that Assignment Group can be in
"""
enum AssignmentGroupState {
available
deleted
}
input AssignmentModeratedGradingUpdate {
enabled: Boolean
finalGraderId: ID
graderCommentsVisibleToGraders: Boolean
graderCount: Int
graderNamesVisibleToFinalGrader: Boolean
gradersAnonymousToGraders: Boolean
}
type AssignmentOverride implements LegacyIDInterface & Node & Timestamped {
"""
legacy canvas id
"""
_id: ID!
allDay: Boolean
assignment: Assignment
createdAt: DateTime
dueAt: DateTime
"""
ID of the object.
"""
id: ID!
lockAt: DateTime
"""
This object specifies what students this override applies to
"""
set: AssignmentOverrideSet
title: String
unlockAt: DateTime
updatedAt: DateTime
}
"""
The connection type for AssignmentOverride.
"""
type AssignmentOverrideConnection {
"""
A list of edges.
"""
edges: [AssignmentOverrideEdge]
"""
A list of nodes.
"""
nodes: [AssignmentOverride]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
}
input AssignmentOverrideCreateOrUpdate {
dueAt: DateTime
groupId: ID
id: ID
lockAt: DateTime
sectionId: ID
studentIds: [ID!]
unlockAt: DateTime
}
"""
An edge in a connection.
"""
type AssignmentOverrideEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: AssignmentOverride
}
"""
Objects that can be assigned overridden dates
"""
union AssignmentOverrideSet = AdhocStudents | Group | Section
input AssignmentPeerReviewsUpdate {
anonymousReviews: Boolean
automaticReviews: Boolean
count: Int
dueAt: DateTime
enabled: Boolean
intraReviews: Boolean
}
"""
States that an Assignment can be in
"""
enum AssignmentState {
deleted
published
unpublished
}
interface AssignmentsConnectionInterface {
"""
returns a list of assignments.
**NOTE**: for courses with grading periods, this will only return grading
periods in the current course; see `AssignmentFilter` for more info.
In courses with grading periods that don't have students, it is necessary
to *not* filter by grading period to list assignments.
"""
assignmentsConnection(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
filter: AssignmentFilter
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): AssignmentConnection
}
type AuditLogs {
"""
A list of all recent graphql mutations run on the specified object
"""
mutationLogs(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
assetString: String!
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
endTime: DateTime
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
startTime: DateTime
): MutationLogConnection
}
"""
Determines if/how a leader is chosen for each group
"""
enum AutoLeaderPolicy {
"""
the first student assigned to the group is the leader
"""
first
"""
a leader is chosen at random
"""
random
}
type Course implements AssignmentsConnectionInterface & LegacyIDInterface & Node & Timestamped {
"""
legacy canvas id
"""
_id: ID!
account: Account
assignmentGroupsConnection(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): AssignmentGroupConnection
"""
PostPolicies for assignments within a course
"""
assignmentPostPolicies(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): PostPolicyConnection
"""
returns a list of assignments.
**NOTE**: for courses with grading periods, this will only return grading
periods in the current course; see `AssignmentFilter` for more info.
In courses with grading periods that don't have students, it is necessary
to *not* filter by grading period to list assignments.
"""
assignmentsConnection(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
filter: AssignmentFilter
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): AssignmentConnection
"""
course short name
"""
courseCode: String
createdAt: DateTime
externalToolsConnection(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
filter: ExternalToolFilterInput = {}
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): ExternalToolConnection
gradingPeriodsConnection(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): GradingPeriodConnection
"""
Project group sets for this course.
"""
groupSetsConnection(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): GroupSetConnection
groupsConnection(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): GroupConnection
id: ID!
modulesConnection(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): ModuleConnection
name: String!
"""
returns permission information for the current user in this course
"""
permissions: CoursePermissions
"""
A course-specific post policy
"""
postPolicy: PostPolicy
sectionsConnection(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): SectionConnection
state: CourseWorkflowState!
"""
all the submissions for assignments in this course
"""
submissionsConnection(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
filter: SubmissionFilterInput
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
orderBy: [SubmissionOrderCriteria!]
"""
Only return submissions for the given students.
"""
studentIds: [ID!]
): SubmissionConnection
term: Term
updatedAt: DateTime
usersConnection(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
filter: CourseUsersFilter
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Only include users with the given ids.
**This field is deprecated, use `filter: {userIds}` instead.**
"""
userIds: [ID!]
): UserConnection
}
"""
The connection type for Course.
"""
type CourseConnection {
"""
A list of edges.
"""
edges: [CourseEdge]
"""
A list of nodes.
"""
nodes: [Course]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
}
"""
An edge in a connection.
"""
type CourseEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: Course
}
"""
Users in a course can be returned based on these enrollment states
"""
enum CourseFilterableEnrollmentState {
active
completed
creation_pending
inactive
invited
rejected
}
type CoursePermissions {
becomeUser: Boolean
manageGrades: Boolean
sendMessages: Boolean
viewAllGrades: Boolean
viewAnalytics: Boolean
}
input CourseUsersFilter {
"""
only return users with the given enrollment state. defaults
to `invited`, `creation_pending`, `active`
"""
enrollmentStates: [CourseFilterableEnrollmentState!]
"""
only include users with the given ids
"""
userIds: [ID!]
}
"""
States that Courses can be in
"""
enum CourseWorkflowState {
available
claimed
completed
created
deleted
}
"""
Autogenerated input type of CreateAssignment
"""
input CreateAssignmentInput {
allowedAttempts: Int
allowedExtensions: [String!]
"""
requires anonymous_marking course feature to be set to true
"""
anonymousGrading: Boolean
anonymousInstructorAnnotations: Boolean
assignmentGroupId: ID
assignmentOverrides: [AssignmentOverrideCreateOrUpdate!]
courseId: ID!
description: String
dueAt: DateTime
gradeGroupStudentsIndividually: Boolean
gradingType: GradingType
groupSetId: ID
lockAt: DateTime
moderatedGrading: AssignmentModeratedGradingUpdate
moduleIds: [ID!]
muted: Boolean