Developer Platform (April 2026)

Learning Outcomes

«  Demographics (data types, fields, users and org units)   ·  [   home  ·   reference  ·   community   |   search  ·   index   ·  routing table   ·  scopes table   ]   ·  Lockers  »

Attributes

ALIGNEDACTIVITYTYPE_T

We categorize the types of activities, and use the term ALIGNEDACTIVITYTYPE_T to stand in for an appropriate string name.

Activity Types

ContentObject

DiscussionTopic

Assignment

LtiLink

Quiz

Survey

Checklist

SelfAssessment

QuizQuestion

RubricCriterion
Outcomes.Outcome

An outcome set contains outcomes in a tree structure. The following JSON block describes an outcome node:

{
    "OutcomeId": <string:GUID>,
    "SourceType": <string>,
    "SourceId": <string>,
    "SourceOrgUnitId": <number:D2LID>|null,
    "ShortCode": <string>,
    "Description": <string>,
    "Children": [  // Array of Outcome blocks
         { <composite:Outcomes.Outcome> },
         { <composite:Outcomes.Outcome> }, ...
    ]
}
OutcomeId

A unique identifier for a specific outcome instance.

SourceType

The source where this outcome was defined. Currently supported values are asn for outcomes defined in the Achievement Standards Network and lores for outcomes authored within Brightspace.

SourceId

A unique identifier for the outcome within its source. For ASN outcomes, this is the ASN URI. For authored outcomes (lores), this is the same as the OutcomeId.

SourceOrgUnitId

The org unit where this outcome instance was defined, or null for outcomes defined in an organization level outcome set.

Note

An outcome defined in one org unit may appear in another org unit’s outcome set via a course copy. Outcomes imported from an organization level outcome set will always have a null SourceOrgUnitId.

ShortCode

An optional short code to identify the outcome.

Description

The main outcome display text.

Children

An array of child outcomes.

Outcomes.OutcomeSet

When the service sends you information about an outcome set, it will send back a JSON structure like this:

{
    "OutcomeSetId": <number:D2LID>|0,
    "Name": <string>|null,
    "Outcomes": [  // Array of Outcome blocks
         { <composite:Outcomes.Outcome> },
         { <composite:Outcomes.Outcome> }, ...
    ]
}
OutcomeSetId

An identifier for the outcome set. This identifier is unique for organization level outcome sets. Any imported org unit level outcome sets share an identifier with the organization level outcome set they were imported from. The primary “My Learning Outcomes” org unit level outcome set always uses the special identifier value of 0.

Name

The display name of the outcome set. This value is null for the primary “My Learning Outcomes” outcome set in an org unit.

Outcomes

An array of outcomes. The array contains only the root outcomes, each of which contains its own child outcomes, thus forming a tree structure.

Outcomes.OutcomeSetUpdateNode

When updating the outcome tree in an outcome set, each node in the tree must be one of the following three types (with it’s own JSON structure):

  • Reference to an existing outcome

  • External outcome to import

  • Newly created outcome

Reference existing. When an outcome already exists in the outcome set and should be preserved, or if an outcome defined in another outcome set should be imported, the JSON block should look like this:

{
    "OutcomeId": <string:GUID>,
    "Children": [  // Array of OutcomeSetUpdateNode blocks
         { <composite:Outcomes.OutcomeSetUpdateNode> },
         { <composite:Outcomes.OutcomeSetUpdateNode> }, ...
    ]
}
OutcomeId

Identifier for an existing outcome to reference.

Children

An array of child outcomes. The order of outcomes provided does not matter; the service will reorder the outcomes alphabetically.

Import external. When a new outcome should be added by importing from ASN, the JSON block should look like this:

{
    "Import": {
        "Source": "asn",
        "Uri": <string>
    },
    "Children": [  // Array of OutcomeSetUpdateNode blocks
         { <composite:Outcomes.OutcomeSetUpdateNode> },
         { <composite:Outcomes.OutcomeSetUpdateNode> }, ...
    ]
}
Uri

URI for the ASN outcome to import.

Children

An array of child outcomes. The order of outcomes provided does not matter; the service will reorder the outcomes alphabetically.

Create new. When an outcome should be added by creating a new authored outcome, the JSON block should look like this:

{
    "Create": {
        "Description": <string>,
        "ShortCode": <string>  // Optional
    },
    "Children": [  // Array of OutcomeSetUpdateNode blocks
         { <composite:Outcomes.OutcomeSetUpdateNode> },
         { <composite:Outcomes.OutcomeSetUpdateNode> }, ...
    ]
}
Description

The main outcome text. Maximum of 1024 characters.

ShortCode

An optional short code to identify the outcome. Maximum of 128 characters. If this field is missing or null, an empty string will be used.

Children

An array of child outcomes. The order of outcomes provided does not matter; the service will reorder the outcomes alphabetically. All children must be either a Create new block or a Reference existing block that refers to an authored outcome that is already present in this outcome set and is not used in any other outcome set.

Outcomes.OutcomeSetUpdate

When updating an outcome set, use a structure like this:

{
    "Name": <string>|null, // Optional
    "Outcomes": null|[  // Optional
         { <composite:Outcomes.OutcomeSetUpdateNode> },
         { <composite:Outcomes.OutcomeSetUpdateNode> }, ...
    ]
}
Name

The display name of the outcome set. Maximum of 256 characters. If this field is missing or null, the outcome set will not be renamed.

Outcomes

An array of outcomes. The array contains only the root outcomes, each of which contains its own child outcomes, thus forming a tree structure. The order of outcomes does not matter; the service will reorder the outcomes alphabetically.

If this field is missing or null, the outcomes in the outcome set will not be modified. To remove all outcomes from an outcome set, use an empty array.

Outcomes.OutcomeSetCreate

When creating an organization level outcome set, use a structure like this:

{
    "Name": <string>
}
Name

The display name to assign to the created outcome set. Maximum of 256 characters.

Outcomes.ImportExportOutcome

The import/export format of an outcome tree node is one of the following two JSON structures depending on the outcome source:

ASN. An ASN outcome being imported or exported is represented with the following JSON block:

{
    "Source": "asn",
    "Uri": <string>,
    "Children": [  // Array of ImportExportOutcome blocks
         { <composite:Outcomes.ImportExportOutcome> },
         { <composite:Outcomes.ImportExportOutcome> }, ...
    ]
}
Uri

URI for the ASN standard (outcome).

Authored. An authored outcome being imported or exported is represented with the following JSON block:

{
    "Source": "lores",
    "ShortCode": <string>, // Optional when importing
    "Description": <string>,
    "Children": [  // Array of ImportExportOutcome blocks
         { <composite:Outcomes.ImportExportOutcome> },
         { <composite:Outcomes.ImportExportOutcome> }, ...
    ]
}
ShortCode

An optional short code identifying the outcome. Maximum of 128 characters. If this field is missing or null, an empty string will be used.

Description

The main outcome text. Maximum of 1024 characters.

Outcomes.ImportExportOutcomeSet

The import/export format of an outcome set is a JSON structure like this:

{
    "Name": <string>|null,
    "ImportId": <string>,
    "Outcomes": [  // Array of ImportExportOutcome blocks
         { <composite:Outcomes.ImportExportOutcome> },
         { <composite:Outcomes.ImportExportOutcome> }, ...
    ]
}
Name

The display name of the outcome set. Maximum of 256 characters.

ImportId

An arbitrary string serving as a globally unique identifier for the outcome set. Maximum of 256 characters.

Outcomes

An array of child outcomes. The order of outcomes provided on import does not matter; the service will reorder the outcomes alphabetically.

Outcomes.OutcomeAlignment

The format of the org units with alignments to a given outcome is a JSON structure like this:

{
    "OutcomeId": <string:GUID>,
    "AlignedOrgUnits": [ <number:D2LID>, ... ]
}
OutcomeId

Identifier for the outcome.

AlignedOrgUnits

An array of all org unit IDs of the org units that contain alignments to the given outcome.

Outcomes.BulkAlignment

The format of the alignments in an org unit to a given outcome is a JSON structure like this:

{
    "OutcomeSetId": <number:D2LID>|0,
    "OutcomeId": <string:GUID>,
    "Activities": [  // Array of activity blocks
         { <composite:Outcomes.AlignedActivity> },
         { <composite:Outcomes.AlignedActivity> }, ...
    ]
}
OutcomeSetId

Identifier for the outcome set. The primary “My Learning Outcomes” org unit level outcome set always uses the special identifier value of 0.

Activities

An array of activity objects aligned to the outcome.

Outcomes.AlignedActivity

Properties for an aligned activity used in bulk alignment operations; the properties and values vary depending on the type of underlying activity.

All activities share these basic properties:

{
   "ActivityType": <string:ALIGNEDACTIVITYTYPE_T>,
   "ObjectId": <number>,
   "RubricId": <number>|null
}
ObjectId

Identifier for the aligned activity object.

RubricId

Identifier for the aligned rubric, if applicable; otherwise null.

Quiz, QuizQuestion. Quiz and quiz question activity types add a new QuestionID property to the basic structure:

{
   "ActivityType": <string:ALIGNEDACTIVITYTYPE_T>,
   "ObjectId": <number>,
   "RubricId": <number>|null,
   "QuestionID": <number>|null
}
QuestionId

If the activity is of type QuizQuestion, then this is an identifier for the quiz question; otherwise, if the activity is of type Quiz, this property will have a null value.

Outcomes.Alignment

The format of the outcomes aligned to an activity is a JSON structure like this:

{
     "OutcomeSetId": <number:D2LID>|0,
     "OutcomeId": <string:GUID>,
     "Direct": <boolean>
}
OutcomeSetId

Identifier for the outcome set. The primary “My Learning Outcomes” org unit level outcome set always uses the special identifier value of 0.

OutcomeId

Identifier for the outcome.

Direct

True if the alignment is direct.

Outcomes.UpdateAlignment

The format of the action to update an alignment is a JSON structure like this:

{
     "Action": "add|remove|replace",
     "OutcomeIds": [ <string:GUID>, ... ]
}
Action

How to modify the alignment:

  • add. Outcomes are aligned to the activity.

  • remove. Outcomes are unaligned from the activity.

  • replace. Outcomes are aligned to the activity and any existing alignments on the activity not included OutcomeIds become unaligned.

OutcomeIds

List of identifiers for the relevant outcomes.

Actions

Organization Level Outcome Sets

DELETE /d2l/api/le/(version)/lo/outcomeSets/(outcomeSetId)

Delete a particular organization level outcome set.

Parameters:

  • version (D2LVERSION) – API version.

  • outcomeSetId (D2LID) – Outcome set ID for the specific outcome set.

Oauth2 Scopes:

outcomes:sets:manage

Status Codes:
API Versions:

  • 1.92+ – Route first appears in LMS v20.26.2.

GET /d2l/api/le/(version)/lo/outcomeSets/

Retrieve all organization level outcome sets.

Parameters:
Oauth2 Scopes:

outcomes:sets:read

Status Codes:
API Versions:

  • 1.92+ – Route first appears in LMS v20.26.2.

Return. This action retrieves a JSON array of OutcomeSet structures that fully enumerates all of the organization level outcome sets.

GET /d2l/api/le/(version)/lo/outcomeSets/(outcomeSetId)

Retrieve a specific organization level outcome set.

Parameters:

  • version (D2LVERSION) – API version.

  • outcomeSetId (D2LID) – Outcome set ID for the specific outcome set.

Oauth2 Scopes:

outcomes:sets:read

Status Codes:
API Versions:

  • 1.92+ – Route first appears in LMS v20.26.2.

Return. This action returns a OutcomeSet JSON block.

POST /d2l/api/le/(version)/lo/outcomeSets/

Create a new organization level outcome set.

Parameters:
Oauth2 Scopes:

outcomes:sets:manage

Status Codes:
API Versions:

  • 1.92+ – Route first appears in LMS v20.26.2.

Input. The action’s body should be an OutcomeSetCreate JSON data block.

Return. This action returns a OutcomeSet JSON block.

PUT /d2l/api/le/(version)/lo/outcomeSets/(outcomeSetId)

Update a particular organization level outcome set.

Parameters:

  • version (D2LVERSION) – API version.

  • outcomeSetId (D2LID) – Outcome set ID for the specific outcome set.

Oauth2 Scopes:

outcomes:sets:manage

Status Codes:
API Versions:

  • 1.92+ – Route first appears in LMS v20.26.2.

Input. The action’s body should be an OutcomeSetUpdate JSON data block.

If an Outcomes property is present, the entire outcome tree is replaced with the new updated tree.

To preserve the integrity of outcomes instances that appear in multiple outcome sets, the following integrity rules are imposed on all updates to organization level outcome sets:

  • An outcome instance that is used in another outcome set may not be removed or reparented.

  • An outcome instance that is defined in another outcome set may not be added.

Return. This action returns a OutcomeSet JSON block.

Org Unit Level Outcome Sets

GET /d2l/api/le/(version)/(orgUnitId)/lo/outcomeSets/

Retrieve all outcome sets in an org unit.

Parameters:
Oauth2 Scopes:

outcomes:sets:read

Status Codes:
API Versions:

  • 1.92+ – Route first appears in LMS v20.26.2.

Return. This action retrieves a JSON array of OutcomeSet structures that fully enumerates all of the outcome sets in the org unit.

GET /d2l/api/le/(version)/(orgUnitId)/lo/outcomeSets/(outcomeSetId)

Retrieve a specific outcome set from an org unit.

Parameters:

  • version (D2LVERSION) – API version.

  • orgUnitId (D2LID) – Org unit ID.

  • outcomeSetId (D2LID | 0) – Identifier for the specific outcome set (or 0 for the primary “My Learning Outcomes” outcome set).

Oauth2 Scopes:

outcomes:sets:read

Status Codes:
API Versions:

  • 1.92+ – Route first appears in LMS v20.26.2.

Return. This action returns a OutcomeSet JSON block.

PUT /d2l/api/le/(version)/(orgUnitId)/lo/outcomeSets/(outcomeSetId)

Update a specific outcome set from an org unit.

Parameters:

  • version (D2LVERSION) – API version.

  • orgUnitId (D2LID) – Org unit ID.

  • outcomeSetId (D2LID | 0) – Identifier for the specific outcome set (or 0 for the primary “My Learning Outcomes” outcome set).

Oauth2 Scopes:

outcomes:sets:manage

Status Codes:
API Versions:

  • 1.92+ – Route first appears in LMS v20.26.2.

Input. The action’s body should be an OutcomeSetUpdate JSON data block. This update must include a non-null value for the Outcomes property, and the Name property should be null or omitted.

If an Outcomes property is present, the entire outcome tree is replaced with the new updated tree.

To preserve the integrity of outcomes instances that appear in multiple outcome sets, the following integrity rules are imposed on all updates to org unit level outcome sets:

  • An outcome instance that is used in another outcome set may not be reparented.

  • An outcome instance that is defined in another outcome set may only be added to this outcome set if both outcome sets have the same ID. In other words, they must either both be defined in the same organization level outcome set or they must both be defined in a primary (ID 0) org unit level outcome set.

Return. This action returns a OutcomeSet JSON block.

Import and Export

POST /d2l/api/le/(version)/lo/bulkExport

Retrieve organization level outcome sets in export format.

Parameters:
Query Parameters:

  • outcomeSetIds (CSV) – Optional. If true, filters to only the outcome sets with the given IDs.

Oauth2 Scopes:

outcomes:sets:export

Status Codes:
API Versions:

  • 1.92+ – Route first appears in LMS v20.26.2.

Return. This action retrieves a JSON array of ImportExportOutcomeSet structures.

The response body returned from this API call may be used as the request body for an import API call.

POST /d2l/api/le/(version)/lo/bulkImport

Imports organization level outcome sets.

Parameters:
Oauth2 Scopes:

outcomes:sets:import

Status Codes:
API Versions:

  • 1.92+ – Route first appears in LMS v20.26.2.

Input. The action’s body should be a JSON array of ImportExportOutcomeSet blocks with non-null ImportId values.

The import will perform a merge if the outcome set already exists. An import will never remove or alter existing outcomes in an outcome set.

If an organization level outcome set with a given ImportId does not already exist, it will be created and named using the Name property in the import JSON data. If an organization level outcome set with a given ImportId does already exist, the Name property in the import JSON data will be ignored (existing outcome sets will not be renamed).

Note

Authored outcomes are considered to be equivalent to each other, and thus will not be duplicated, if they have the same short code, description, and parent outcome.

Return. This action retrieves a JSON array of ImportExportOutcomeSet structures.

POST /d2l/api/le/(version)/(orgUnitId)/lo/bulkExport

Retrieve org unit level outcome sets in export format.

Parameters:
Query Parameters:

  • outcomeSetIds (CSV) – Optional. If true, filters to only the outcome sets with the given IDs.

Oauth2 Scopes:

outcomes:sets:export

Status Codes:
API Versions:

  • 1.92+ – Route first appears in LMS v20.26.2.

Return. This action retrieves a JSON array of ImportExportOutcomeSet structures.

The response body returned from this API call may be used as the request body for an import API call.

POST /d2l/api/le/(version)/(orgUnitId)/lo/bulkImport

Imports outcome sets into the org unit.

Parameters:
Oauth2 Scopes:

outcomes:sets:import

Status Codes:
API Versions:

  • 1.92+ – Route first appears in LMS v20.26.2.

Input. The action’s body should be a JSON array of ImportExportOutcomeSet blocks with non-null ImportId values.

At most one provided outcome set may have a null Name and ImportId, which will result in the outcomes being imported to the org unit’s primary “My Learning Outcomes” outcome set (outcome set ID 0). For imported outcome sets where an ImportId is provided, the outcomes will first be imported into an organization level outcome set with the same behaviour as the organization level import API (unless they already exist). The outcomes will then be imported into the org unit.

Note

Authored outcomes are considered to be equivalent to each other, and thus will not be duplicated, if they have the same short code, description, and parent outcome.

Return. This action retrieves a JSON array of ImportExportOutcomeSet structures.

Alignments

GET /d2l/api/le/(version)/lo/alignments/outcomeSet/(outcomeSetId)

Retrieve the org units that contain alignments to a given outcome set.

Parameters:

  • version (D2LVERSION) – API version.

  • outcomeSetId (D2LID) – Identifier for the specific outcome set.

Query Parameters:

  • assessableOnly (boolean) – Optional, default to false. If true, the response only includes alignments with assessable activities.

  • activeOnly (boolean) – Optional, default to false. If true, the response only includes org units that are active.

Oauth2 Scopes:

outcomes:alignments:read

Status Codes:
API Versions:

  • 1.93+ – Route first appears in LMS v20.26.4.

Return. This action retrieves a JSON array of OutcomeAlignment structures.

GET /d2l/api/le/(version)/lo/alignments/outcome/(outcomeId)

Retrieve the org units that contain alignments to a given outcome.

Parameters:

  • version (D2LVERSION) – API version.

  • outcomeId (GUID) – Outcome ID.

Query Parameters:

  • assessableOnly (boolean) – Optional, default to false. If true, the response only includes alignments with assessable activities.

  • activeOnly (boolean) – Optional, default to false. If true, the response only includes org units that are active.

Oauth2 Scopes:

outcomes:alignments:read

Status Codes:
API Versions:

  • 1.93+ – Route first appears in LMS v20.26.4.

Return. This action retrieves a JSON array of OutcomeAlignment structures.

GET /d2l/api/le/(version)/(orgUnitId)/lo/alignments

Retrieve all the alignments in an org unit.

Parameters:
Query Parameters:

  • assessableOnly (boolean) – Optional. If true, the response only includes alignments with assessable activities.

Oauth2 Scopes:

outcomes:alignments:read

Status Codes:

  • 200 OK – Action successful.

  • 403 Forbidden – No permission to view alignments.

  • 404 Not Found – The referenced org unit ID does not exist or belongs to different org.

API Versions:

  • 1.93+ – Route first appears in LMS v20.26.4.

Return. This action retrieves a JSON array of BulkAlignment structures.

GET /d2l/api/le/(version)/(orgUnitId)/lo/alignments/outcomeSet/(outcomeSetId)

Retrieve all the alignments to outcomes in an outcome set in an org unit.

Parameters:

  • version (D2LVERSION) – API version.

  • orgUnitId (D2LID) – Org unit ID.

  • outcomeSetId (D2LID | 0) – Identifier for the specific outcome set (or 0 for the primary “My Learning Outcomes” outcome set).

Query Parameters:

  • assessableOnly (boolean) – Optional. If true, the response only includes alignments with assessable activities.

Oauth2 Scopes:

outcomes:alignments:read

Status Codes:

  • 200 OK – Action successful.

  • 403 Forbidden – No permission to view alignments.

  • 404 Not Found – The referenced org unit ID does not exist or belongs to different org.

API Versions:

  • 1.93+ – Route first appears in LMS v20.26.4.

Return. This action retrieves a JSON array of BulkAlignment structures.

GET /d2l/api/le/(version)/(orgUnitId)/lo/alignments/outcome/(outcomeId)

Retrieve all the alignments to a given outcome in an org unit.

Parameters:

  • version (D2LVERSION) – API version.

  • orgUnitId (D2LID) – Org unit ID.

  • outcomeId (GUID) – Outcome ID.

Query Parameters:

  • assessableOnly (boolean) – Optional. If true, the response only includes alignments with assessable activities.

Oauth2 Scopes:

outcomes:alignments:read

Status Codes:

  • 200 OK – Action successful.

  • 403 Forbidden – No permission to view alignments.

  • 404 Not Found – The referenced org unit ID does not exist or belongs to different org.

API Versions:

  • 1.93+ – Route first appears in LMS v20.26.4.

Return. This action retrieves a JSON array of BulkAlignment structures.

GET /d2l/api/le/(version)/(orgUnitId)/lo/alignments/activity/(activityType)/(objectId)

Retrieve all the alignments to a given activity.

Parameters:
Query Parameters:

  • directOnly (boolean) – Optional. If true, the response only returns direct alignments.

Oauth2 Scopes:

outcomes:alignments:read

Status Codes:
API Versions:

  • 1.93+ – Route first appears in LMS v20.26.4.

Input. The objectId parameter is in most cases a D2LID, except for when the activity is a rubric criterion. In the rubric criterion case, the objectId is a string made up of the rubricId and criterionId, structured like this: {rubricId}_R_{criterionId}.

Return. This action retrieves a JSON array of Alignment structures.

POST /d2l/api/le/(version)/(orgUnitId)/lo/alignments/activity/(activityType)/(objectId)

Modify the alignments to a given activity.

Parameters:

  • version (D2LVERSION) – API version.

  • orgUnitId (D2LID) – Org unit ID.

  • activityType (ALIGNEDACTIVITYTYPE_T) – The type of activity.

  • objectId (string) – The id of the activity.

JSON Parameters:
Oauth2 Scopes:

outcomes:alignments:manage

Status Codes:

  • 200 OK – Action successful.

  • 400 Bad Request – Bad Request (no such activity type, empty or invalid request body, invalid action).

  • 403 Forbidden – Outcomes not enabled, no permission to manage alignments, or a rubric is locked.

API Versions:

  • 1.93+ – Route first appears in LMS v20.26.4.

Input. You can use this action to add or remove direct alignments for an activity. The path objectId parameter will in most cases be a D2LID value, except when you want to update the alignments for a rubric criterion.

When using this action to update the alignments for a rubric criterion, the path ojbectId parameter has a special form, which specifies the rubric identifier and the criterion identifier in this way:

{rubricId}_R_{criterionId}

Note

You cannot use this action to modify the alignments of a locked rubric activity.

Return. Returns the new state of alignments on the activity as a JSON array of Alignment structures.

«  Demographics (data types, fields, users and org units)   ·  [   home  ·   reference  ·   community   |   search  ·   index   ·  routing table   ·  scopes table   ]   ·  Lockers  »