Brightspace Data Streams (July 2023)

Content Completion Events

«  ContentTopic_View Event   ·  [   home  ·   community   |   search  ·   index   ·  next   ·  previous   ]   ·  Content Service Events  »

Content Completion EventsΒΆ

Content Completion Events occur when a content topic is completed. The actor is the user who completed the content topic, and the object is the content topic that was completed. 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/completed"
     },
     "object": {
         "objectType": "Activity",
         "id": "urn:uuid:<ContentTopicUUID>",
         "definition": {
             "type": "https://api.brightspace.com/xapi/activities/tools/content/topic"
         }
     },
     "context": {
         "contextActivities": {
         "category": [
                 {
                     "id": "https://api.brightspace.com/xapi/profiles/brightspace-activity-v1p0.jsonld"
                 }
             ]
         },
         "registration": "<ContextUUID>",
         "extensions": {
             "https://api.brightspace.com/xapi/extension_keys/context/actor": {
                 "userId": "<BrightspaceUserIdNumber>",
                 "imsRoleIds": [ <IMSRoles> ],
                 "roleId": "<BrightspaceRoleIdNumber>"
             },
             "https://api.brightspace.com/xapi/extension_keys/context/object": {
                 "id": "<BrightspaceObjectIdNumber>"
             },
             "https://api.brightspace.com/xapi/extension_keys/context/context": {
                 "tenantId": "<TenantUUID>",
                 "originalEventId": "<InternalEventUUID>",
                 "orgUnitType": "<BrightspaceOrgUnitTypeString>",
                 "orgUnitId": "<BrightspaceOrgUnitIdNumber>"
             }
         }
     }
 }

Notes:

<ContentTopicUUID>

a unique identifier for the content topic. This UUID is created by an algorithm whose input is the TenantID and content topic ID. This UUID will be used whenever this topic is referenced by any BDS event.

<ContextUUID>

a unique identifier created by an algorithm that uses the OrgUnitID, TenantID and ContextID as input.

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.

«  ContentTopic_View Event   ·  [   home  ·   community   |   search  ·   index   ·  next   ·  previous   ]   ·  Content Service Events  »