Assignment EventsΒΆ
Assignment events are posted when a user performs any action pertaining to assignments. The actor is the user who performs the action, and the object is the assignment involved. The event object has the following form:
{
"id": "<EventUUID>",
"timestamp": "<UTCDateTimeString>",
"actor": {
"account": {
"homePage": "https://<TenantUUID>.lms.d2l.com/",
"name": "urn:uuid:<UserUUID>"
}
},
"verb": {
"id": "https://api.brightspace.com/xapi/verbs/<AssignmentVerbString>"
},
"object": {
"objectType": "Activity",
"id": "urn:uuid:<AssignmentFolderUUID>",
"definition": {
"type": "https://api.brightspace.com/xapi/activities/tools/assignment/folder"
}
},
"context": {
"contextActivities": {
"category": [
{
"id": "https://api.brightspace.com/xapi/profiles/brightspace-activity-v1p0.jsonld"
}
]
},
"registration": "<OrgUnitUUID>",
"extensions": {
"https://api.brightspace.com/xapi/extension_keys/context/actor": {
"userId": "<BrightspaceUserIdNumber>",
"imsRoleIds": [ <IMSRoles> ],
"impersonatingUserId": "<BrightspaceImpersonatingUserIdNumber>",
"roleId": "BrightspaceRoleIdNumber>"
},
"https://api.brightspace.com/xapi/extension_keys/context/object": {
"id": "<BrightspaceFolderIdNumber>"
},
"https://api.brightspace.com/xapi/extension_keys/context/context": {
"tenantId": "<TenantUUID>",
"originalEventId": "<InternalEventUUID>",
"orgUnitType": "<BrightspaceOrgUnitTypeString>",
"orgUnitId": "<BrightspaceOrgUnitIdNumber>"
}
}
}
}
Notes:
- <AssignmentVerbString>
may be one of
created updated deleted restored
- <AssignmentFolderUUID>
a unique identifier for the assignment folder. This UUID is created by an algorithm whose input is the TenantID, OrgUnitID, and assignment folder information. This UUID will be used whenever this folder is referenced by any BDS event.
- <OrgUnitUUID>
a unique identifier for the OrgUnit.
- impersonatingUserID
only present if the user is being impersonated by a different user. If this field is present, then the Actor information refers to the person being impersonated, not the impersonator.
- originalEventId
only provided for use by D2L personnel if needed for troubleshooting.
See Fundamental xAPI Concepts for information on other fields.