-
Notifications
You must be signed in to change notification settings - Fork 24
/
Copy pathcustom_gradebook_columns.json
328 lines (326 loc) · 9.65 KB
/
custom_gradebook_columns.json
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
{
"apiVersion": "1.0",
"swaggerVersion": "1.2",
"basePath": "https://canvas.instructure.com/api",
"resourcePath": "/custom_gradebook_columns",
"produces": [
"application/json"
],
"apis": [
{
"path": "/v1/courses/{course_id}/custom_gradebook_columns",
"description": "A paginated list of all custom gradebook columns for a course",
"operations": [
{
"method": "GET",
"summary": "List custom gradebook columns",
"notes": "A paginated list of all custom gradebook columns for a course",
"nickname": "list_custom_gradebook_columns",
"parameters": [
{
"paramType": "path",
"name": "course_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "query",
"name": "include_hidden",
"description": "Include hidden parameters (defaults to false)",
"type": "boolean",
"format": null,
"required": false
}
],
"type": "array",
"items": {
"$ref": "CustomColumn"
}
}
]
},
{
"path": "/v1/courses/{course_id}/custom_gradebook_columns",
"description": "Create a custom gradebook column",
"operations": [
{
"method": "POST",
"summary": "Create a custom gradebook column",
"notes": "Create a custom gradebook column",
"nickname": "create_custom_gradebook_column",
"parameters": [
{
"paramType": "path",
"name": "course_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "column[title]",
"description": "no description",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "column[position]",
"description": "The position of the column relative to other custom columns",
"type": "integer",
"format": "int64",
"required": false
},
{
"paramType": "form",
"name": "column[hidden]",
"description": "Hidden columns are not displayed in the gradebook",
"type": "boolean",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "column[teacher_notes]",
"description": "Set this if the column is created by a teacher. The gradebook only\nsupports one teacher_notes column.",
"type": "boolean",
"format": null,
"required": false
}
],
"type": "CustomColumn"
}
]
},
{
"path": "/v1/courses/{course_id}/custom_gradebook_columns/{id}",
"description": "Accepts the same parameters as custom gradebook column creation",
"operations": [
{
"method": "PUT",
"summary": "Update a custom gradebook column",
"notes": "Accepts the same parameters as custom gradebook column creation",
"nickname": "update_custom_gradebook_column",
"parameters": [
{
"paramType": "path",
"name": "course_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "id",
"description": "ID",
"type": "string",
"format": null,
"required": true
}
],
"type": "CustomColumn"
}
]
},
{
"path": "/v1/courses/{course_id}/custom_gradebook_columns/{id}",
"description": "Permanently deletes a custom column and its associated data",
"operations": [
{
"method": "DELETE",
"summary": "Delete a custom gradebook column",
"notes": "Permanently deletes a custom column and its associated data",
"nickname": "delete_custom_gradebook_column",
"parameters": [
{
"paramType": "path",
"name": "course_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "id",
"description": "ID",
"type": "string",
"format": null,
"required": true
}
],
"type": "CustomColumn"
}
]
},
{
"path": "/v1/courses/{course_id}/custom_gradebook_columns/reorder",
"description": "Puts the given columns in the specified order\n\n<b>200 OK</b> is returned if successful",
"operations": [
{
"method": "POST",
"summary": "Reorder custom columns",
"notes": "Puts the given columns in the specified order\n\n<b>200 OK</b> is returned if successful",
"nickname": "reorder_custom_columns",
"parameters": [
{
"paramType": "path",
"name": "course_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "order",
"description": "no description",
"type": "array",
"format": "int64",
"required": true,
"items": {
"type": "integer"
}
}
],
"type": "void"
}
]
},
{
"path": "/v1/courses/{course_id}/custom_gradebook_columns/{id}/data",
"description": "This does not list entries for students without associated data.",
"operations": [
{
"method": "GET",
"summary": "List entries for a column",
"notes": "This does not list entries for students without associated data.",
"nickname": "list_entries_for_column",
"parameters": [
{
"paramType": "path",
"name": "course_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "query",
"name": "include_hidden",
"description": "If true, hidden columns will be included in the\nresult. If false or absent, only visible columns\nwill be returned.",
"type": "boolean",
"format": null,
"required": false
}
],
"type": "array",
"items": {
"$ref": "ColumnDatum"
}
}
]
},
{
"path": "/v1/courses/{course_id}/custom_gradebook_columns/{id}/data/{user_id}",
"description": "Set the content of a custom column",
"operations": [
{
"method": "PUT",
"summary": "Update column data",
"notes": "Set the content of a custom column",
"nickname": "update_column_data",
"parameters": [
{
"paramType": "path",
"name": "course_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "user_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "column_data[content]",
"description": "Column content. Setting this to blank will delete the datum object.",
"type": "string",
"format": null,
"required": true
}
],
"type": "ColumnDatum"
}
]
}
],
"models": {
"CustomColumn": {
"id": "CustomColumn",
"description": "",
"required": [
],
"properties": {
"title": {
"description": "header text",
"example": "Stuff",
"type": "string"
},
"position": {
"description": "column order",
"example": 1,
"type": "integer"
},
"hidden": {
"description": "won't be displayed if hidden is true",
"example": false,
"type": "boolean"
}
}
},
"ColumnDatum": {
"id": "ColumnDatum",
"description": "ColumnDatum objects contain the entry for a column for each user.",
"required": [
],
"properties": {
"content": {
"example": "Nut allergy",
"type": "string"
},
"user_id": {
"example": 2,
"type": "integer"
}
}
}
}
}