openapi: 3.0.3
info:
  title: D2L Brightspace Valence Learning Framework Assignments API
  description: 'The Valence Learning Framework API is the public REST API for the D2L Brightspace learning management system (LMS). It is served from an institution''s own Brightspace host under https://{host}/d2l/api/ and is divided into two product components: "lp" (Learning Platform - users, roles, enrollments, org units, and Data Hub) and "le" (Learning Environment - content, grades, assignments/dropbox, quizzes, discussions, calendar, news, and learning outcomes). Each component is independently versioned; the version segment in a route (for example lp/1.53 or le/1.92) varies by installed Brightspace product version, and clients should confirm supported versions via GET /d2l/api/versions/ before hard-coding a value. Requests are authenticated with OAuth 2 bearer tokens issued by the D2L auth service (https://auth.brightspace.com/core/connect/token) using the authorization code grant; the older ID-Key (app-id/user-id signed URL) scheme is deprecated. Scopes take the form group:resource:action, for example users:userdata:read. The version values baked into the paths below are illustrative of a recent release and must be adjusted to the target instance. "Valence" is the historical name of the API framework; "D2L" is the vendor and "Brightspace" the product.'
  version: '1.0'
  contact:
    name: D2L Developer Platform
    url: https://docs.valence.desire2learn.com
  license:
    name: D2L Developer Terms
    url: https://www.d2l.com/legal/
servers:
- url: https://{host}/d2l/api
  description: An institution's Brightspace instance
  variables:
    host:
      default: myschool.brightspace.com
      description: Your Brightspace instance hostname.
security:
- oauth2: []
tags:
- name: Assignments
  description: Assignment (Dropbox) folders, submissions, and feedback.
paths:
  /le/1.92/{orgUnitId}/dropbox/folders/:
    get:
      operationId: listDropboxFolders
      tags:
      - Assignments
      summary: List assignment folders
      description: Retrieves all the assignment (dropbox) folders in a course offering.
      parameters:
      - $ref: '#/components/parameters/OrgUnitId'
      responses:
        '200':
          description: A list of assignment folders.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DropboxFolder'
    post:
      operationId: createDropboxFolder
      tags:
      - Assignments
      summary: Create an assignment folder
      description: Creates a new assignment (dropbox) folder in a course offering.
      parameters:
      - $ref: '#/components/parameters/OrgUnitId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DropboxFolder'
      responses:
        '200':
          description: The created assignment folder.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DropboxFolder'
  /le/1.92/{orgUnitId}/dropbox/folders/{folderId}/submissions/:
    get:
      operationId: listDropboxSubmissions
      tags:
      - Assignments
      summary: List submissions for an assignment folder
      description: Retrieves the submissions made to an assignment (dropbox) folder.
      parameters:
      - $ref: '#/components/parameters/OrgUnitId'
      - $ref: '#/components/parameters/FolderId'
      responses:
        '200':
          description: A list of submissions.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EntityDropbox'
  /le/1.92/{orgUnitId}/dropbox/folders/{folderId}/feedback/{entityType}/{entityId}:
    parameters:
    - $ref: '#/components/parameters/OrgUnitId'
    - $ref: '#/components/parameters/FolderId'
    - name: entityType
      in: path
      required: true
      schema:
        type: integer
    - name: entityId
      in: path
      required: true
      schema:
        type: integer
    post:
      operationId: setDropboxFeedback
      tags:
      - Assignments
      summary: Post feedback on a submission
      description: Sets instructor feedback (score, text, published state) for a submission entity.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DropboxFeedback'
      responses:
        '200':
          description: The feedback was set.
components:
  parameters:
    FolderId:
      name: folderId
      in: path
      required: true
      schema:
        type: integer
        format: int64
    OrgUnitId:
      name: orgUnitId
      in: path
      required: true
      schema:
        type: integer
        format: int64
  schemas:
    DropboxFeedback:
      type: object
      properties:
        Score:
          type: number
        Feedback:
          type: object
          properties:
            Content:
              type: string
            Type:
              type: string
        IsGraded:
          type: boolean
    DropboxFolder:
      type: object
      properties:
        Id:
          type: integer
          format: int64
        Name:
          type: string
        CategoryId:
          type: integer
        TotalFiles:
          type: integer
        DueDate:
          type: string
          format: date-time
    EntityDropbox:
      type: object
      properties:
        Entity:
          type: object
          properties:
            EntityId:
              type: integer
            EntityType:
              type: string
        Submissions:
          type: array
          items:
            type: object
            properties:
              Id:
                type: integer
              SubmittedBy:
                type: object
              Comment:
                type: object
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2 authorization code grant. Tokens are issued by the D2L auth service. Scopes take the form group:resource:action (for example users:userdata:read).
      flows:
        authorizationCode:
          authorizationUrl: https://auth.brightspace.com/oauth2/auth
          tokenUrl: https://auth.brightspace.com/core/connect/token
          scopes:
            core:*:*: Full access consistent with the registered application
            users:userdata:read: Read user data
            enrollment:orgunit:read: Read enrollments
            datahub:dataexports:read: Read Data Hub exports