Instructure Developer Documentation Portal
Community
  • Introduction
  • Services
    • Elevate Standards Alignment - AB Connect API
      • Introduction
        • Authentication
        • Addressing Object Properties
        • Requesting Additional Properties in the Response
        • Filtering Using ODATA Like Statements
        • Sorting
        • Facets
        • Paging Data
        • Call Throttling
        • Working with Related Object
        • Error Responses
        • Character Set Support
        • How To Articles, Recommendations and Suggestions
        • Examples
        • Using AB Connect's Embeddable Widgets
      • Reference
        • Standards
        • Standard Collections
        • Events
        • Topics
        • Concepts
        • Assets
        • Asset Definitions
        • Asset Collections
        • Managing and Predicting Relationships
        • Providers
    • Canvas LMS
      • Basics
        • GraphQL
        • API Change Log
        • SIS IDs
        • Pagination
        • Throttling
        • Compound Documents
        • File Uploads
        • API Endpoint Attributes
        • Masquerading
      • OAuth2
        • OAuth2 Overview
        • OAuth2 Endpoints
        • Developer Keys
      • Resources
        • Access Tokens
        • Account Calendars
        • Account Domain Lookups
        • Account Notifications
        • Account Reports
        • Accounts
        • Accounts (LTI)
        • Admins
        • Analytics
        • Announcement External Feeds
        • Announcements
        • API Token Scopes
        • Appointment Groups
        • Assignment Extensions
        • Assignment Groups
        • Assignments
        • Authentication Providers
        • Authentications Log
        • Blackout Dates
        • BlockEditorTemplate
        • Blueprint Courses
        • Bookmarks
        • Brand Configs
        • Calendar Events
        • Collaborations
        • CommMessages
        • Communication Channels
        • Conferences
        • Content Exports
        • Content Migrations
        • Content Security Policy Settings
        • Content Shares
        • Conversations
        • Course Audit log
        • Course Pace
        • Course Quiz Extensions
        • Course Reports
        • Courses
        • Custom Gradebook Columns
        • Developer Key Account Bindings
        • Developer Keys
        • Discussion Topics
        • Enrollment Terms
        • Enrollments
        • ePortfolios
        • ePub Exports
        • Error Reports
        • External Tools
        • Favorites
        • Feature Flags
        • Files
        • Grade Change Log
        • Gradebook History
        • Grading Period Sets
        • Grading Periods
        • Grading Standards
        • Group Categories
        • Groups
        • History
        • InstAccess tokens
        • JWTs
        • Late Policy
        • Learning Object Dates
        • Line Items
        • LiveAssessments
        • Logins
        • LTI Launch Definitions
        • LTI Registrations
        • LTI Resource Links
        • Media Objects
        • Moderated Grading
        • Modules
        • Names and Role
        • New Quiz Items
        • New Quizzes
        • New Quizzes Accommodations
        • New Quizzes Reports
        • Notification Preferences
        • Originality Reports
        • Outcome Groups
        • Outcome Imports
        • Outcome Results
        • Outcomes
        • Pages
        • Peer Reviews
        • Planner
        • Poll Sessions
        • PollChoices
        • Polls
        • PollSubmissions
        • Proficiency Ratings
        • Progress
        • Public JWK
        • Quiz Assignment Overrides
        • Quiz Extensions
        • Quiz IP Filters
        • Quiz Question Groups
        • Quiz Questions
        • Quiz Reports
        • Quiz Statistics
        • Quiz Submission Events
        • Quiz Submission Files
        • Quiz Submission Questions
        • Quiz Submission User List
        • Quiz Submissions
        • Quizzes
        • Result
        • Roles
        • Rubrics
        • Sandboxes
        • Score
        • Search
        • Sections
        • Services
        • Shared Brand Configs
        • SIS Import Errors
        • SIS Imports
        • SIS Integration
        • Smart Search
        • Submission Comments
        • Submissions
        • Tabs
        • Temporary Enrollment Pairings
        • User Observees
        • Users
        • What If Grades
      • Outcomes
        • Outcomes CSV Format
      • Group Categories
        • Group Categories CSV Format
      • SIS
        • SIS CSV Format
      • External Tools
        • LTI
          • Introduction
          • Registration
          • Launch Overview
          • Configuring
          • Variable Substitutions
          • Deep Linking
          • Grading
          • Provisioning
          • PostMessage
          • Platform Notification Service
          • Placements
            • Placements Overview
            • Navigation
            • Homework Submission
            • Editor Button
            • Migration Selection
            • Link Selection (Modules)
            • Assignment Selection
            • Collaborations
        • xAPI
        • Canvas Roles
        • Plagiarism Detection Platform
          • Overview
          • Plagiarism Detection Platform Assignments
          • Plagiarism Detection Platform Users
          • Plagiarism Detection Submissions
          • Webhooks Subscriptions for Plagiarism Platform
          • JWT Access Tokens
      • Data Services
        • Live Events
          • Overview
            • Introduction
            • Setup
            • Caliper
            • Metadata
          • Event Format
            • Canvas
              • Account
              • Asset
              • Assignment
              • Attachment
              • Content
              • Conversation
              • Course
              • Discussion
              • Enrollment
              • Grade
              • Group
              • Learning
              • Logged
              • Module
              • Outcome
              • Outcomes
              • Plagiarism
              • Quiz
              • Rubric
              • Sis
              • Submission
              • Syllabus
              • User
              • Wiki
            • Caliper IMS 1.1
              • Assessment
              • Basic
              • Forum
              • Grading
              • Navigation Events
              • Session
    • Catalog
      • APIs
        • Analytics
        • Bulk Enrollments
        • Catalogs
        • Certificates
        • Completed Certificates
        • Courses
        • Email Domain Set
        • Enrollments
        • Orders
        • Programs
        • Progresses
        • Tags
        • User Registrations
        • Users
        • Waitlist Applicants
    • Credentials
      • Getting Started
      • Authentication
        • Password-Based Authentication
        • Authorization Code-Based Authentication
      • Pagination
      • APIs
        • Assertions
        • Backpack
        • Badgeclasses
        • Issuers
        • Organizations
        • Users
      • Release Notes
    • Data Access Platform
      • Key Concepts
      • Data Formats
      • Rate Limits & Policies
      • Datasets
        • Namespaces
          • canvas
            • canvas types
          • canvas_logs
          • catalog
        • Additional Notes
        • Entity Relationship Diagram
      • Query API
        • Authentication
        • Reference
      • Command Line (DAP CLI)
        • Getting Started
        • Secure Connection
        • Reference
          • dap snapshot
          • dap incremental
          • dap list
          • dap schema
          • dap initdb
          • dap syncdb
          • dap dropdb
      • Client Library
        • Examples
        • Reference
      • Release Notes
      • Status
    • DataSync
      • Interop API
      • Interop Data API
      • Grades Exchange API
      • OneRoster API
      • Platform API
    • Instructure Media
      • API Reference
        • Captions
        • Collection
        • Courses
        • Group
        • Insights
        • Media
        • Media Upload
        • Ping
        • Professional Captioning
        • Tags
        • Transfer Media
        • User
    • Quizzes
      • Quiz API
Powered by GitBook

Copyright © 2008-2024 Instructure, Inc. All rights reserved. Various trademarks held by their respective owners.

On this page

Was this helpful?

  1. Services
  2. DataSync

Grades Exchange API

PreviousInterop Data APINextOneRoster API

Last updated 1 year ago

Was this helpful?

Find a Grades Exchange by id

get

Get an Exchange

Authorizations
Path parameters
idstring · uuidRequired

id of the Exchange to find

Responses
200
Exchanges response
application/json
Responseall of
404
Exchange not found
get
GET /v2/grades/exchanges/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Accept: */*
{
  "data": {
    "query": {
      "type": "assignment_scores",
      "conditions": [
        {
          "scope": "course",
          "scope_by": "id",
          "scope_id": {
            "$sys": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "source_id": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "app_id": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "created_at": "2025-05-25T20:49:06.910Z",
              "updated_at": "2025-05-25T20:49:06.910Z"
            }
          },
          "graded_after": "2025-05-25T20:49:06.910Z",
          "summary_type": "final"
        }
      ]
    },
    "state": "created",
    "max_data_content_length": 1,
    "error_count": 1,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-05-25T20:49:06.910Z",
    "updated_at": "2025-05-25T20:49:06.910Z"
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

List Grades Exchange Errors

get

Get a list of Grades Exchange Errors

Authorizations
Path parameters
idstring · uuidRequired

id of the Exchange to list Errors

Query parameters
pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses
200
Exchange Errors response
application/json
Responseall of
404
Exchange not found
get
GET /v2/grades/exchanges/{id}/errors HTTP/1.1
Host: api.us2.kimonocloud.com
Accept: */*
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-05-25T20:49:06.910Z",
      "updated_at": "2025-05-25T20:49:06.910Z",
      "code": "query_type_not_supported",
      "message": "text",
      "details": "text"
    }
  ],
  "paging": {
    "next": "text"
  }
}
  • GETList Grades Exchanges
  • POSTCreate a Grades Exchange
  • GETFind a Grades Exchange by id
  • GETList Grades Exchange Errors
  • POSTCreate Grades Exchange Errors
  • POSTCreate Grades Exchange Data

List Grades Exchanges

get

Get a list of Grades Exchanges

Authorizations
Query parameters
pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses
200
Exchanges response
application/json
Responseall of
get
GET /v2/grades/exchanges HTTP/1.1
Host: api.us2.kimonocloud.com
Accept: */*
200

Exchanges response

{
  "data": [
    {
      "query": {
        "type": "assignment_scores",
        "conditions": [
          {
            "scope": "course",
            "scope_by": "id",
            "scope_id": {
              "$sys": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "source_id": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "app_id": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "created_at": "2025-05-25T20:49:06.910Z",
                "updated_at": "2025-05-25T20:49:06.910Z"
              }
            },
            "graded_after": "2025-05-25T20:49:06.910Z",
            "summary_type": "final"
          }
        ]
      },
      "state": "created",
      "max_data_content_length": 1,
      "error_count": 1,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-05-25T20:49:06.910Z",
      "updated_at": "2025-05-25T20:49:06.910Z"
    }
  ],
  "paging": {
    "next": "text"
  }
}

Create a Grades Exchange

post

Create a Grades Exchange

Authorizations
Body
Responses
200
Exchanges response
application/json
Responseall of
400
Bad Request
application/json
post
POST /v2/grades/exchanges HTTP/1.1
Host: api.us2.kimonocloud.com
Content-Type: application/json
Accept: */*
Content-Length: 310

{
  "query": {
    "type": "assignment_scores",
    "conditions": [
      {
        "scope": "course",
        "scope_by": "id",
        "scope_id": {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "source_id": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "app_id": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        },
        "graded_after": "2025-05-25T20:49:06.910Z",
        "summary_type": "final"
      }
    ]
  }
}
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-05-25T20:49:06.910Z",
    "updated_at": "2025-05-25T20:49:06.910Z"
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Create Grades Exchange Errors

post

Create a list of Grades Exchange Errors

Authorizations
Path parameters
idstring · uuidRequired

id of the Exchange to create Errors

Body
idstring · uuidRead-onlyOptional
created_atstring · date-timeRead-onlyOptional
updated_atstring · date-timeRead-onlyOptional
codestring · enumOptionalPossible values:
messagestringRead-onlyOptional
detailsstringOptional
Responses
200
Exchange Errors response
application/json
Responseall of
400
Bad Request
application/json
404
Exchange not found
post
POST /v2/grades/exchanges/{id}/errors HTTP/1.1
Host: api.us2.kimonocloud.com
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "code": "query_type_not_supported",
  "details": "text"
}
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-05-25T20:49:06.910Z",
    "updated_at": "2025-05-25T20:49:06.910Z",
    "code": "query_type_not_supported",
    "message": "text",
    "details": "text"
  },
  "paging": {
    "next": "text"
  }
}

Create Grades Exchange Data

post

Create Grades data for an Exchange

Authorizations
Path parameters
idstring · uuidRequired

id of the Exchange to create Data

Body
finalbooleanOptional
Responses
200
Exchanges response
application/json
Responseall of
400
Bad Request
application/json
404
Exchange not found
post
POST /v2/grades/exchanges/{id}/data HTTP/1.1
Host: api.us2.kimonocloud.com
Content-Type: application/json
Accept: */*
Content-Length: 2055

{
  "assignments": [
    {
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "source_id": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "app_id": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "created_at": "2025-05-25T20:49:06.910Z",
        "updated_at": "2025-05-25T20:49:06.910Z"
      },
      "$section": {
        "$sys": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "source_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "app_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      },
      "$category": {
        "name": "text",
        "$sys": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "source_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "app_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      },
      "$term": {
        "$sys": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "source_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "app_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      },
      "name": "text",
      "description": "text",
      "points_possible": 1,
      "due_at": "2025-05-25T20:49:06.910Z",
      "available_at": "2025-05-25T20:49:06.910Z",
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "scores": [
        {
          "$person": {
            "$sys": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "source_id": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "app_id": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              }
            }
          },
          "$grader": {
            "$sys": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "source_id": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "app_id": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              }
            }
          },
          "score": 1,
          "grade": "text",
          "late": true,
          "excused": true,
          "submitted_at": "2025-05-25T20:49:06.910Z",
          "preview_url": "text",
          "$ext": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      ]
    }
  ],
  "summaries": [
    {
      "$section": {
        "$sys": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "source_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "app_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      },
      "$person": {
        "$sys": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "source_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "app_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      },
      "$grader": {
        "$sys": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "source_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "app_id": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      },
      "summary_type": "midterm",
      "score_type": "raw",
      "score": 1,
      "grade": "text",
      "last_activity": "2025-05-25T20:49:06.910Z",
      "comments": [
        "text"
      ],
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "final": true
}
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-05-25T20:49:06.910Z",
    "updated_at": "2025-05-25T20:49:06.910Z"
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}