Brightspace APIs expose functionality to allow users to migrate Legacy 1.1 links to Advantage 1.3. This API migrates one link at a time which is most useful for org level links that are shared to multiple courses.
LTI 1.1 organization level links are made at the instance home page. Navigate to Admin Tools (the cog icon) > External Learning Tools > Manage Tool Links (Legacy)
Figure: Navigate to Manage Tool Links (Legacy) to begin the migration process.
Org Level links shared with courses are found within the course. Navigate to Course Admin > External Learning Tools > Manage Tool Links (Legacy). These appear in the Title column as non-interactable UI elements.
Figure: You can view Org Level links in the table. These appear in the Title column.
To migrate the link, you require the DeploymentID, LinkID and optionally the tool provider ID. This information can be found in data sets, and the following APIs:
This GET API returns a list of all LTI 1.1 links belonging to an org unit:
- GET /d2l/api/le/(version)/lti/link/(orgUnitId)/
Copy the LtiLinkId for the link you need to migrate.
Figure: Select and copy the value of the LtiLinkId.
Use this GET API to get the DeploymentID of the LTI 1.3 Advantage deployment where you want to migrate this 1.1 link:
- GET /d2l/api/le/(version)/ltiadvantage/deployment/
Figure: Select and copy the DeploymentID and Name of the LTI 1.3 Advantage deployment.
Now you can start the migration process. Use this API:
https://docs.valence.desire2learn.com/res/ltiadvantage.html#post--d2l-api-le-(version)-ltiadvantage-migration-links-(linkId)
- POST /d2l/api/le/(version)/ltiadvantage/migration/links/(linkId)
The body of this API should have the following information:
{
"DeploymentId": "GUID from deployment",
"ToolProviderId": null
}
To verify this API was successful, run the get Links API again, the migrated link should not appear on this list. This migrated link now appears in the UI; this can be found by navigating to Admin Tools (the cog icon) > External Learning Tools > LTI Advantage Deployment, then select your deployment, and click View Links.
It is important to verify that the migrated link works after migration. Place this link in content and perform a launch of that link. This requires knowledge of how the tool works to ensure the launch was successful.
