forked from instructure/pandarus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathoutcomes.json
241 lines (240 loc) · 8.63 KB
/
outcomes.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
{
"apiVersion": "1.0",
"swaggerVersion": "1.2",
"basePath": "https://canvas.instructure.com/api",
"resourcePath": "/outcomes",
"produces": [
"application/json"
],
"apis": [
{
"path": "/v1/outcomes/{id}",
"description": "Returns the details of the outcome with the given id.",
"operations": [
{
"method": "GET",
"summary": "Show an outcome",
"notes": "Returns the details of the outcome with the given id.",
"nickname": "show_outcome",
"parameters": [
{
"paramType": "path",
"name": "id",
"description": "ID",
"type": "string",
"format": null,
"required": true
}
],
"type": "Outcome"
}
]
},
{
"path": "/v1/outcomes/{id}",
"description": "Modify an existing outcome. Fields not provided are left as is;\nunrecognized fields are ignored.\n\nIf any new ratings are provided, the combination of all new ratings\nprovided completely replace any existing embedded rubric criterion; it is\nnot possible to tweak the ratings of the embedded rubric criterion.\n\nA new embedded rubric criterion's mastery_points default to the maximum\npoints in the highest rating if not specified in the mastery_points\nparameter. Any new ratings lacking a description are given a default of \"No\ndescription\". Any new ratings lacking a point value are given a default of\n0.",
"operations": [
{
"method": "PUT",
"summary": "Update an outcome",
"notes": "Modify an existing outcome. Fields not provided are left as is;\nunrecognized fields are ignored.\n\nIf any new ratings are provided, the combination of all new ratings\nprovided completely replace any existing embedded rubric criterion; it is\nnot possible to tweak the ratings of the embedded rubric criterion.\n\nA new embedded rubric criterion's mastery_points default to the maximum\npoints in the highest rating if not specified in the mastery_points\nparameter. Any new ratings lacking a description are given a default of \"No\ndescription\". Any new ratings lacking a point value are given a default of\n0.",
"nickname": "update_outcome",
"parameters": [
{
"paramType": "path",
"name": "id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "title",
"description": "The new outcome title.",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "display_name",
"description": "A friendly name shown in reports for outcomes with cryptic titles,\nsuch as common core standards names.",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "description",
"description": "The new outcome description.",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "vendor_guid",
"description": "A custom GUID for the learning standard.",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "mastery_points",
"description": "The new mastery threshold for the embedded rubric criterion.",
"type": "integer",
"format": "int64",
"required": false
},
{
"paramType": "form",
"name": "ratings[description]",
"description": "The description of a new rating level for the embedded rubric criterion.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
},
{
"paramType": "form",
"name": "ratings[points]",
"description": "The points corresponding to a new rating level for the embedded rubric\ncriterion.",
"type": "array",
"format": "int64",
"required": false,
"items": {
"type": "integer"
}
},
{
"paramType": "form",
"name": "calculation_method",
"description": "The new calculation method.",
"type": "string",
"format": null,
"required": false,
"enum": [
"decaying_average",
"n_mastery",
"latest",
"highest"
]
},
{
"paramType": "form",
"name": "calculation_int",
"description": "The new calculation int. Only applies if the calculation_method is \"decaying_average\" or \"n_mastery\"",
"type": "integer",
"format": "int64",
"required": false
}
],
"type": "Outcome"
}
]
}
],
"models": {
"Outcome": {
"id": "Outcome",
"description": "",
"required": [
],
"properties": {
"id": {
"description": "the ID of the outcome",
"example": 1,
"type": "integer"
},
"url": {
"description": "the URL for fetching/updating the outcome. should be treated as opaque",
"example": "/api/v1/outcomes/1",
"type": "string"
},
"context_id": {
"description": "the context owning the outcome. may be null for global outcomes",
"example": 1,
"type": "integer"
},
"context_type": {
"example": "Account",
"type": "string"
},
"title": {
"description": "title of the outcome",
"example": "Outcome title",
"type": "string"
},
"display_name": {
"description": "Optional friendly name for reporting",
"example": "My Favorite Outcome",
"type": "string"
},
"description": {
"description": "description of the outcome. omitted in the abbreviated form.",
"example": "Outcome description",
"type": "string"
},
"vendor_guid": {
"description": "A custom GUID for the learning standard.",
"example": "customid9000",
"type": "string"
},
"points_possible": {
"description": "maximum points possible. included only if the outcome embeds a rubric criterion. omitted in the abbreviated form.",
"example": 5,
"type": "integer"
},
"mastery_points": {
"description": "points necessary to demonstrate mastery outcomes. included only if the outcome embeds a rubric criterion. omitted in the abbreviated form.",
"example": 3,
"type": "integer"
},
"calculation_method": {
"description": "the method used to calculate a students score",
"example": "decaying_average",
"type": "string",
"allowableValues": {
"values": [
"decaying_average",
"n_mastery",
"latest",
"highest"
]
}
},
"calculation_int": {
"description": "this defines the variable value used by the calculation_method. included only if calculation_method uses it",
"example": 75,
"type": "integer"
},
"ratings": {
"description": "possible ratings for this outcome. included only if the outcome embeds a rubric criterion. omitted in the abbreviated form.",
"type": "array",
"items": {
"$ref": "RubricRating"
}
},
"can_edit": {
"description": "whether the current user can update the outcome",
"example": true,
"type": "boolean"
},
"can_unlink": {
"description": "whether the outcome can be unlinked",
"example": true,
"type": "boolean"
},
"assessed": {
"description": "whether this outcome has been used to assess a student",
"example": true,
"type": "boolean"
}
}
}
}
}