Website : rimsha.abasa.com
backdoor
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
var
/
canvas
/
public
/
doc
/
api
/
Filename :
outcomes.html
back
Copy
<!DOCTYPE html> <html> <head> <meta name="Content-Type" content="text/html;charset=UTF-8"> <meta charset="UTF-8"> <title>Outcomes - Canvas LMS REST API Documentation</title> <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" /> <link href="css/prettify.css" rel="stylesheet" type="text/css" media="screen" /> <script src="js/jquery.min.js" type="text/javascript"></script> <script src="js/prettify.js" type="text/javascript"></script> <script type="text/javascript"> $(function() { // set up pretty-printing in static docs generated from .md files $('pre.code.bash').addClass('prettyprint language-bash'); $('pre.code.html').addClass('prettyprint language-html'); $('pre.code.xml').addClass('prettyprint language-xml'); $('pre.code.json').addClass('prettyprint language-js'); $('pre.code.javascript').addClass('prettyprint language-js'); prettyPrint(); }); </script> </head> <body> <div id="header"> <h1> <a href="index.html">Canvas LMS - REST API and Extensions Documentation</a> </h1> </div> <div id="sidebar"> <nav> <div class="expand-all-toggle"> <input id="toggle-input" type="checkbox" onClick="toggle(this)"> <label for="toggle-input" class="toggle-label">Expand all</label> </div> <div class="ac-container"> <input name="header" class="ac-input" id="sidebar-basics" type="checkbox" > <label class="ac-label" for="sidebar-basics">Basics</label> <div class="ac-text"> <div class="ac-sub"> <a class="" href="file.graphql.html">GraphQL</a><a class="" href="file.changelog.html">API Change Log</a><a class="" href="file.object_ids.html">SIS IDs</a><a class="" href="file.pagination.html">Pagination</a><a class="" href="file.throttling.html">Throttling</a><a class="" href="file.compound_documents.html">Compound Documents</a><a class="" href="file.file_uploads.html">File Uploads</a><a class="" href="file.endpoint_attributes.html">API Endpoint Attributes</a><a class="" href="file.masquerading.html">Masquerading</a> </div> </div> </div> <div class="ac-container"> <input name="header" class="ac-input" id="sidebar-oauth2" type="checkbox" > <label class="ac-label" for="sidebar-oauth2">OAuth2</label> <div class="ac-text"> <div class="ac-sub"> <a class="" href="file.oauth.html">OAuth2 Overview</a><a class="" href="file.oauth_endpoints.html">OAuth2 Endpoints</a><a class="" href="file.developer_keys.html">Developer Keys</a> </div> </div> </div> <div class="ac-container"> <input name="header" class="ac-input" id="sidebar-resources" type="checkbox" checked > <label class="ac-label" for="sidebar-resources">Resources</label> <div class="ac-text"> <div class="ac-sub"> <a href="all_resources.html" class="">All Resources Reference</a> <a class="" href="access_tokens.html">Access Tokens</a> <a class="" href="account_calendars.html">Account Calendars</a> <a class="" href="account_notifications.html">Account Notifications</a> <a class="" href="account_reports.html">Account Reports</a> <a class="" href="accounts.html">Accounts</a> <a class="" href="accounts_(lti).html">Accounts (LTI)</a> <a class="" href="admins.html">Admins</a> <a class="" href="announcement_external_feeds.html">Announcement External Feeds</a> <a class="" href="announcements.html">Announcements</a> <a class="" href="api_token_scopes.html">API Token Scopes</a> <a class="" href="appointment_groups.html">Appointment Groups</a> <a class="" href="assignment_extensions.html">Assignment Extensions</a> <a class="" href="assignment_groups.html">Assignment Groups</a> <a class="" href="assignments.html">Assignments</a> <a class="" href="authentication_providers.html">Authentication Providers</a> <a class="" href="authentications_log.html">Authentications Log</a> <a class="" href="blackout_dates.html">Blackout Dates</a> <a class="" href="blueprint_courses.html">Blueprint Courses</a> <a class="" href="bookmarks.html">Bookmarks</a> <a class="" href="brand_configs.html">Brand Configs</a> <a class="" href="calendar_events.html">Calendar Events</a> <a class="" href="collaborations.html">Collaborations</a> <a class="" href="comm_messages.html">CommMessages</a> <a class="" href="communication_channels.html">Communication Channels</a> <a class="" href="conferences.html">Conferences</a> <a class="" href="content_exports.html">Content Exports</a> <a class="" href="content_migrations.html">Content Migrations</a> <a class="" href="content_security_policy_settings.html">Content Security Policy Settings</a> <a class="" href="content_shares.html">Content Shares</a> <a class="" href="conversations.html">Conversations</a> <a class="" href="course_audit_log.html">Course Audit log</a> <a class="" href="course_pace.html">Course Pace</a> <a class="" href="course_quiz_extensions.html">Course Quiz Extensions</a> <a class="" href="courses.html">Courses</a> <a class="" href="custom_gradebook_columns.html">Custom Gradebook Columns</a> <a class="" href="discussion_topics.html">Discussion Topics</a> <a class="" href="enrollment_terms.html">Enrollment Terms</a> <a class="" href="enrollments.html">Enrollments</a> <a class="" href="e_portfolios.html">ePortfolios</a> <a class="" href="e_pub_exports.html">ePub Exports</a> <a class="" href="error_reports.html">Error Reports</a> <a class="" href="external_tools.html">External Tools</a> <a class="" href="favorites.html">Favorites</a> <a class="" href="feature_flags.html">Feature Flags</a> <a class="" href="files.html">Files</a> <a class="" href="grade_change_log.html">Grade Change Log</a> <a class="" href="gradebook_history.html">Gradebook History</a> <a class="" href="grading_period_sets.html">Grading Period Sets</a> <a class="" href="grading_periods.html">Grading Periods</a> <a class="" href="grading_standards.html">Grading Standards</a> <a class="" href="group_categories.html">Group Categories</a> <a class="" href="groups.html">Groups</a> <a class="" href="history.html">History</a> <a class="" href="inst_access_tokens.html">InstAccess tokens</a> <a class="" href="jw_ts.html">JWTs</a> <a class="" href="late_policy.html">Late Policy</a> <a class="" href="learning_object_dates.html">Learning Object Dates</a> <a class="" href="line_items.html">Line Items</a> <a class="" href="live_assessments.html">LiveAssessments</a> <a class="" href="logins.html">Logins</a> <a class="" href="lti_resource_links.html">LTI Resource Links</a> <a class="" href="media_objects.html">Media Objects</a> <a class="" href="moderated_grading.html">Moderated Grading</a> <a class="" href="modules.html">Modules</a> <a class="" href="names_and_role.html">Names and Role</a> <a class="" href="notification_preferences.html">Notification Preferences</a> <a class="" href="originality_reports.html">Originality Reports</a> <a class="" href="outcome_groups.html">Outcome Groups</a> <a class="" href="outcome_imports.html">Outcome Imports</a> <a class="" href="outcome_results.html">Outcome Results</a> <a class="current" href="outcomes.html">Outcomes</a> <a class="" href="pages.html">Pages</a> <a class="" href="peer_reviews.html">Peer Reviews</a> <a class="" href="planner.html">Planner</a> <a class="" href="poll_sessions.html">Poll Sessions</a> <a class="" href="poll_choices.html">PollChoices</a> <a class="" href="polls.html">Polls</a> <a class="" href="poll_submissions.html">PollSubmissions</a> <a class="" href="proficiency_ratings.html">Proficiency Ratings</a> <a class="" href="progress.html">Progress</a> <a class="" href="public_jwk.html">Public JWK</a> <a class="" href="quiz_assignment_overrides.html">Quiz Assignment Overrides</a> <a class="" href="quiz_extensions.html">Quiz Extensions</a> <a class="" href="quiz_ip_filters.html">Quiz IP Filters</a> <a class="" href="quiz_question_groups.html">Quiz Question Groups</a> <a class="" href="quiz_questions.html">Quiz Questions</a> <a class="" href="quiz_reports.html">Quiz Reports</a> <a class="" href="quiz_statistics.html">Quiz Statistics</a> <a class="" href="quiz_submission_events.html">Quiz Submission Events</a> <a class="" href="quiz_submission_files.html">Quiz Submission Files</a> <a class="" href="quiz_submission_questions.html">Quiz Submission Questions</a> <a class="" href="quiz_submission_user_list.html">Quiz Submission User List</a> <a class="" href="quiz_submissions.html">Quiz Submissions</a> <a class="" href="quizzes.html">Quizzes</a> <a class="" href="result.html">Result</a> <a class="" href="roles.html">Roles</a> <a class="" href="rubrics.html">Rubrics</a> <a class="" href="score.html">Score</a> <a class="" href="search.html">Search</a> <a class="" href="sections.html">Sections</a> <a class="" href="services.html">Services</a> <a class="" href="shared_brand_configs.html">Shared Brand Configs</a> <a class="" href="sis_import_errors.html">SIS Import Errors</a> <a class="" href="sis_imports.html">SIS Imports</a> <a class="" href="sis_integration.html">SIS Integration</a> <a class="" href="smart_search.html">Smart Search</a> <a class="" href="submission_comments.html">Submission Comments</a> <a class="" href="submissions.html">Submissions</a> <a class="" href="tabs.html">Tabs</a> <a class="" href="temporary_enrollment_pairings.html">Temporary Enrollment Pairings</a> <a class="" href="user_observees.html">User Observees</a> <a class="" href="users.html">Users</a> <a class="" href="what_if_grades.html">What If Grades</a> </div> </div> </div> <div class="ac-container"> <input name="header" class="ac-input" id="sidebar-outcomes" type="checkbox" > <label class="ac-label" for="sidebar-outcomes">Outcomes</label> <div class="ac-text"> <div class="ac-sub"> <a href="file.outcomes_csv.html" class="">Outcomes CSV Format</a> </div> </div> </div> <div class="ac-container"> <input name="header" class="ac-input" id="sidebar-groupCategories" type="checkbox" > <label class="ac-label" for="sidebar-groupCategories">Group Categories</label> <div class="ac-text"> <div class="ac-sub"> <a href="file.group_category_csv.html" class="">Group Categories CSV Format</a> </div> </div> </div> <div class="ac-container"> <input name="header" class="ac-input" id="sidebar-sis" type="checkbox" > <label class="ac-label" for="sidebar-sis">SIS</label> <div class="ac-text"> <div class="ac-sub"> <a href="file.sis_csv.html" class="">SIS CSV Format</a> </div> </div> </div> <div class="ac-container"> <input name="header" class="ac-input" id="sidebar-externalTools" type="checkbox" > <label class="ac-label" for="sidebar-externalTools">External Tools</label> <div class="ac-text"> <div class="ac-sub"> <input name="header" class="ac-input" id="sidebar-externalTools-lti" type="checkbox" > <label class="ac-label level1-label" for="sidebar-externalTools-lti">LTI</label> <div class="ac-sub-text"> <a class="" href="file.tools_intro.html">Introduction</a><a class="" href="file.registration.html">Registration</a><a class="" href="file.lti_dev_key_config.html">Configuring</a><a class="" href="file.tools_variable_substitutions.html">Variable Substitutions</a><a class="" href="file.content_item.html">Deep Linking</a><a class="" href="file.assignment_tools.html">Grading</a><a class="" href="file.provisioning.html">Provisioning</a><a class="" href="file.lti_window_post_message.html">PostMessage</a> <div class="ac-sub"> <input name="header" class="ac-input" id="sidebar-externalTools-lti-placements" type="checkbox" > <label class="ac-label level2-label" for="sidebar-externalTools-lti-placements">Placements</label> <div class="ac-sub-text-nested"> <a class="" href="file.placements_overview.html">Placements Overview</a><a class="" href="file.navigation_tools.html">Navigation</a><a class="" href="file.homework_submission_placement.html">Homework Submission</a><a class="" href="file.editor_button_placement.html">Editor Button</a><a class="" href="file.migration_selection_placement.html">Migration Selection</a><a class="" href="file.link_selection_placement.html">Link Selection (Modules)</a><a class="" href="file.assignment_selection_placement.html">Assignment Selection</a><a class="" href="file.collaborations_placement.html">Collaborations</a> </div> </div> </div> </div> <a href="file.xapi.html" class="">xAPI</a> <a href="file.canvas_roles.html" class="">Canvas Roles</a> </div> <div class="ac-text"> <div class="ac-sub"> <input name="header" class="ac-input" id="sidebar-externalTools-plagiarism" type="checkbox" > <label class="ac-label level1-label" for="sidebar-externalTools-plagiarism">Plagiarism Detection Platform</label> <div class="ac-sub-text"> <a href="file.plagiarism_platform.html" class="">Overview</a> <a class="" href="plagiarism_detection_platform_assignments.html">Plagiarism Detection Platform Assignments</a> <a class="" href="plagiarism_detection_platform_users.html">Plagiarism Detection Platform Users</a> <a class="" href="plagiarism_detection_submissions.html">Plagiarism Detection Submissions</a> <a class="" href="webhooks_subscriptions_for_plagiarism_platform.html">Webhooks Subscriptions for Plagiarism Platform</a> <a href="file.jwt_access_tokens.html" class="">JWT Access Tokens</a> </div> </div> </div> </div> <div class="ac-container"> <input name="header" class="ac-input" id="sidebar-dataServices" type="checkbox" > <label class="ac-label" for="sidebar-dataServices">Data Services</label> <div class="ac-text"> <div class="ac-sub"> <input name="header" class="ac-input" id="sidebar-dataServices-liveEvents" type="checkbox" > <label class="ac-label level1-label" for="sidebar-dataServices-liveEvents">Live Events</label> <div class="ac-sub-text"> <div class="ac-sub"> <input name="header" class="ac-input" id="sidebar-dataServices-liveEvents-overview" type="checkbox" > <label class="ac-label level2-label" for="sidebar-dataServices-liveEvents-overview">Overview</label> <div class="ac-sub-text-nested"> <a class="" href="file.data_service_introduction.html">Introduction</a><a class="" href="file.data_service_setup.html">Setup</a><a class="" href="file.data_service_caliper_structure.html">Caliper</a><a class="" href="file.data_service_canvas_event_metadata.html">Metadata</a> </div> </div> <span class="sub-label">Event Format</span> </div> <div class="ac-sub-text"> <div class="ac-sub"> <input name="header" class="ac-input" id="sidebar-dataServices-liveEvents-eventFormat-canvas" type="checkbox" > <label class="ac-label level2-label" for="sidebar-dataServices-liveEvents-eventFormat-canvas">Canvas</label> <div class="ac-sub-text-nested"> <a class="" href="file.data_service_canvas_account.html">Account</a><a class="" href="file.data_service_canvas_asset.html">Asset</a><a class="" href="file.data_service_canvas_assignment.html">Assignment</a><a class="" href="file.data_service_canvas_attachment.html">Attachment</a><a class="" href="file.data_service_canvas_content.html">Content</a><a class="" href="file.data_service_canvas_conversation.html">Conversation</a><a class="" href="file.data_service_canvas_course.html">Course</a><a class="" href="file.data_service_canvas_discussion.html">Discussion</a><a class="" href="file.data_service_canvas_enrollment.html">Enrollment</a><a class="" href="file.data_service_canvas_grade.html">Grade</a><a class="" href="file.data_service_canvas_group.html">Group</a><a class="" href="file.data_service_canvas_learning.html">Learning</a><a class="" href="file.data_service_canvas_logged.html">Logged</a><a class="" href="file.data_service_canvas_module.html">Module</a><a class="" href="file.data_service_canvas_outcome.html">Outcome</a><a class="" href="file.data_service_canvas_plagiarism.html">Plagiarism</a><a class="" href="file.data_service_canvas_quiz.html">Quiz</a><a class="" href="file.data_service_canvas_rubric.html">Rubric</a><a class="" href="file.data_service_canvas_sis.html">Sis</a><a class="" href="file.data_service_canvas_submission.html">Submission</a><a class="" href="file.data_service_canvas_syllabus.html">Syllabus</a><a class="" href="file.data_service_canvas_user.html">User</a><a class="" href="file.data_service_canvas_wiki.html">Wiki</a> </div> </div> </div> <div class="ac-sub-text"> <div class="ac-sub"> <input name="header" class="ac-input" id="sidebar-dataServices-liveEvents-eventFormat-caliper" type="checkbox" > <label class="ac-label level2-label" for="sidebar-dataServices-liveEvents-eventFormat-caliper">Caliper IMS 1.1</label> <div class="ac-sub-text-nested"> <a class="" href="file.data_service_caliper_assessment.html">Assessment</a><a class="" href="file.data_service_caliper_basic.html">Basic</a><a class="" href="file.data_service_caliper_forum.html">Forum</a><a class="" href="file.data_service_caliper_grading.html">Grading</a><a class="" href="file.data_service_caliper_navigation_events.html">Navigation Events</a><a class="" href="file.data_service_caliper_session.html">Session</a> </div> </div> </div> </div> </div> </div> <div class="sidebar-trailing-background"></div> <script> function toggle(source) { let expandText = document.querySelector('label[for="toggle-input"]') let isChecked = document.querySelector('input[id="toggle-input"]').checked let checkboxes = document.querySelectorAll('input[name="header"]'); checkboxes.forEach(checkbox => { if (checkbox !== source) { checkbox.checked = source.checked } }); expandText.innerHTML = isChecked ? 'Collapse all' : 'Expand all' } </script> </nav> </div> <div id="content"><div class="service"> <h1>Outcomes API</h1> <table id='quicklinks'> </table> <p>API for accessing learning outcome information.</p> <div class='object_definition'> <h3><a name="Outcome">An Outcome object looks like:</a></h3> <pre class="example code prettyprint"><code class="language-js">{ // the ID of the outcome "id": 1, // the URL for fetching/updating the outcome. should be treated as opaque "url": "/api/v1/outcomes/1", // the context owning the outcome. may be null for global outcomes "context_id": 1, "context_type": "Account", // title of the outcome "title": "Outcome title", // Optional friendly name for reporting "display_name": "My Favorite Outcome", // description of the outcome. omitted in the abbreviated form. "description": "Outcome description", // A custom GUID for the learning standard. "vendor_guid": "customid9000", // maximum points possible. included only if the outcome embeds a rubric // criterion. omitted in the abbreviated form. "points_possible": 5, // points necessary to demonstrate mastery outcomes. included only if the // outcome embeds a rubric criterion. omitted in the abbreviated form. "mastery_points": 3, // the method used to calculate a students score "calculation_method": "decaying_average", // this defines the variable value used by the calculation_method. included only // if calculation_method uses it "calculation_int": 65, // possible ratings for this outcome. included only if the outcome embeds a // rubric criterion. omitted in the abbreviated form. "ratings": null, // whether the current user can update the outcome "can_edit": true, // whether the outcome can be unlinked "can_unlink": true, // whether this outcome has been used to assess a student "assessed": true, // whether updates to this outcome will propagate to unassessed rubrics that // have imported it "has_updateable_rubrics": true }</code></pre> </div> <div class='object_definition'> <h3><a name="OutcomeAlignment">An OutcomeAlignment object looks like:</a></h3> <pre class="example code prettyprint"><code class="language-js">{ // the id of the aligned learning outcome. "id": 1, // the id of the aligned assignment (null for live assessments). "assignment_id": 2, // the id of the aligned live assessment (null for assignments). "assessment_id": 3, // a string representing the different submission types of an aligned // assignment. "submission_types": "online_text_entry,online_url", // the URL for the aligned assignment. "url": "/courses/1/assignments/5", // the title of the aligned assignment. "title": "Unit 1 test" }</code></pre> </div> <div id="Services" class="method_details_list"> <div class="method_details first"> <h2 class='api_method_name' name='method.outcomes_api.show' data-subtopic='Outcomes'> <a name='method.outcomes_api.show' href='#method.outcomes_api.show'> Show an outcome </a> <span class='defined-in'><a href="https://github.com/instructure/canvas-lms/blob/master/app/controllers/outcomes_api_controller.rb">OutcomesApiController#show</a></span> </h2> <h3 class='endpoint'> GET /api/v1/outcomes/:id </h3> <div> <strong>Scope: </strong> <code class="scope">url:GET|/api/v1/outcomes/:id</code> </div> <p>Returns the details of the outcome with the given id.</p> <h4>Request Parameters:</h4> <table class="request-params"> <thead> <tr> <th class="param-name">Parameter</th> <th class="param-req"></th> <th class="param-type">Type</th> <th class="param-desc">Description</th> </tr> </thead> <tbody> <tr class="request-param "> <td>add_defaults</td> <td> </td> <td>boolean</td> <td class="param-desc"> <p>If defaults are requested, then color and mastery level defaults will be added to outcome ratings in the result. This will only take effect if the Account Level Mastery Scales FF is DISABLED</p> </td> </tr> </tbody> </table> Returns an <a href='outcomes.html#Outcome'>Outcome</a> object </div> <div class="method_details "> <h2 class='api_method_name' name='method.outcomes_api.update' data-subtopic='Outcomes'> <a name='method.outcomes_api.update' href='#method.outcomes_api.update'> Update an outcome </a> <span class='defined-in'><a href="https://github.com/instructure/canvas-lms/blob/master/app/controllers/outcomes_api_controller.rb">OutcomesApiController#update</a></span> </h2> <h3 class='endpoint'> PUT /api/v1/outcomes/:id </h3> <div> <strong>Scope: </strong> <code class="scope">url:PUT|/api/v1/outcomes/:id</code> </div> <p>Modify an existing outcome. Fields not provided are left as is; unrecognized fields are ignored.</p> <p>If any new ratings are provided, the combination of all new ratings provided completely replace any existing embedded rubric criterion; it is not possible to tweak the ratings of the embedded rubric criterion.</p> <p>A new embedded rubric criterion’s mastery_points default to the maximum points in the highest rating if not specified in the mastery_points parameter. Any new ratings lacking a description are given a default of “No description”. Any new ratings lacking a point value are given a default of 0.</p> <h4>Request Parameters:</h4> <table class="request-params"> <thead> <tr> <th class="param-name">Parameter</th> <th class="param-req"></th> <th class="param-type">Type</th> <th class="param-desc">Description</th> </tr> </thead> <tbody> <tr class="request-param "> <td>title</td> <td> </td> <td>string</td> <td class="param-desc"> <p>The new outcome title.</p> </td> </tr> <tr class="request-param "> <td>display_name</td> <td> </td> <td>string</td> <td class="param-desc"> <p>A friendly name shown in reports for outcomes with cryptic titles, such as common core standards names.</p> </td> </tr> <tr class="request-param "> <td>description</td> <td> </td> <td>string</td> <td class="param-desc"> <p>The new outcome description.</p> </td> </tr> <tr class="request-param "> <td>vendor_guid</td> <td> </td> <td>string</td> <td class="param-desc"> <p>A custom GUID for the learning standard.</p> </td> </tr> <tr class="request-param "> <td>mastery_points</td> <td> </td> <td>integer</td> <td class="param-desc"> <p>The new mastery threshold for the embedded rubric criterion.</p> </td> </tr> <tr class="request-param "> <td>ratings[][description]</td> <td> </td> <td>string</td> <td class="param-desc"> <p>The description of a new rating level for the embedded rubric criterion.</p> </td> </tr> <tr class="request-param "> <td>ratings[][points]</td> <td> </td> <td>integer</td> <td class="param-desc"> <p>The points corresponding to a new rating level for the embedded rubric criterion.</p> </td> </tr> <tr class="request-param "> <td>calculation_method</td> <td> </td> <td>string</td> <td class="param-desc"> <p>The new calculation method. If the Outcomes New Decaying Average Calculation Method FF is ENABLED then “weighted_average” can be used and it is same as previous “decaying_average” and new “decaying_average” will have improved version of calculation.</p> <p class="param-values"> <span class="allowed">Allowed values:</span> <code class=enum>weighted_average</code>, <code class=enum>decaying_average</code>, <code class=enum>n_mastery</code>, <code class=enum>latest</code>, <code class=enum>highest</code>, <code class=enum>average</code> </p> </td> </tr> <tr class="request-param "> <td>calculation_int</td> <td> </td> <td>integer</td> <td class="param-desc"> <p>The new calculation int. Only applies if the calculation_method is “decaying_average” or “n_mastery”</p> </td> </tr> <tr class="request-param "> <td>add_defaults</td> <td> </td> <td>boolean</td> <td class="param-desc"> <p>If defaults are requested, then color and mastery level defaults will be added to outcome ratings in the result. This will only take effect if the Account Level Mastery Scales FF is DISABLED</p> </td> </tr> </tbody> </table> <div class="examples"> <h4>Example Request:</h4> <h4><div class='inline'></div></h4> <pre class="example code prettyprint"><code class="language-bash">curl 'https://<canvas>/api/v1/outcomes/1.json' \ -X PUT \ -F 'title=Outcome Title' \ -F 'display_name=Title for reporting' \ -F 'description=Outcome description' \ -F 'vendor_guid=customid9001' \ -F 'mastery_points=3' \ -F 'calculation_method=decaying_average' \ -F 'calculation_int=65' \ -F 'ratings[][description]=Exceeds Expectations' \ -F 'ratings[][points]=5' \ -F 'ratings[][description]=Meets Expectations' \ -F 'ratings[][points]=3' \ -F 'ratings[][description]=Does Not Meet Expectations' \ -F 'ratings[][points]=0' \ -F 'ratings[][points]=0' \ -H "Authorization: Bearer <token>"</code></pre> <h4><div class='inline'></div></h4> <pre class="example code prettyprint"><code class="language-bash">curl 'https://<canvas>/api/v1/outcomes/1.json' \ -X PUT \ --data-binary '{ "title": "Outcome Title", "display_name": "Title for reporting", "description": "Outcome description", "vendor_guid": "customid9001", "mastery_points": 3, "ratings": [ { "description": "Exceeds Expectations", "points": 5 }, { "description": "Meets Expectations", "points": 3 }, { "description": "Does Not Meet Expectations", "points": 0 } ] }' \ -H "Content-Type: application/json" \ -H "Authorization: Bearer <token>"</code></pre> </div> Returns an <a href='outcomes.html#Outcome'>Outcome</a> object </div> <div class="method_details "> <h2 class='api_method_name' name='method.outcomes_api.outcome_alignments' data-subtopic='Outcomes'> <a name='method.outcomes_api.outcome_alignments' href='#method.outcomes_api.outcome_alignments'> Get aligned assignments for an outcome in a course for a particular student </a> <span class='defined-in'><a href="https://github.com/instructure/canvas-lms/blob/master/app/controllers/outcomes_api_controller.rb">OutcomesApiController#outcome_alignments</a></span> </h2> <h3 class='endpoint'> GET /api/v1/courses/:course_id/outcome_alignments </h3> <div> <strong>Scope: </strong> <code class="scope">url:GET|/api/v1/courses/:course_id/outcome_alignments</code> </div> </div> </div> </div> </div> <script type="text/javascript"> $('h2.api_method_name').each(function(i, el) { var subtopic = $(el).data('subtopic'); var $a = $(el).find('a'); if ($.trim($a[0].innerHTML) == '') return; var $row = $('table#quicklinks tr').filter(function() { return $(this).data('subtopic') == subtopic; }); if ($row.length == 0) { $row = $('<tr/>').appendTo($('table#quicklinks')); $row.data('subtopic', subtopic); $('<th/>').append(subtopic).appendTo($row); $('<td/>').appendTo($row); } var link = $('<a/>').attr('href', '#'+$(el).attr('name')).append($.trim($a[0].innerHTML)); $row.find('td').append(link); }); </script> <div id="footer"> © Instructure, Inc. Generated on Tue Aug 27 19:27:02 2024<br> This documentation is generated directly from the Canvas LMS source code, available <a href="https://github.com/instructure/canvas-lms">on Github</a>. </div> </body> </html>