Brightspace Data Sets for Awards have a dependency on Awards. If you turn the Awards tool on and off during the data set query period, there may be unexpected or missing content in your data sets.
Entity Relationship Diagram
The following diagram shows the relationships between entities used to create Brightspace Data Sets for Awards. To enlarge the diagram, right-click on the image and select Open image in a new tab.
Award Objects
The Award Objects Brightspace Data Set returns details on all awards that were created anywhere in the organization.
Version
History
|
Field
|
Description
|
Type
|
Size
|
Key
|
|---|
| 3.4 |
AwardId
|
Unique award identifier
|
bigint
|
8
|
PK
|
| 5.7 / 6.0 - Changed Column Size |
Name |
Award name |
nvarchar |
256 |
|
| 3.4 |
AwardTypeId
|
Award type identifier
|
int
|
4
|
|
|
5.7 / 6.0 - Changed Column Size
|
Type
|
Award type (Certificate or Badge)
|
nvarchar
|
128
|
|
| 7.7 - Changed Description |
Description |
Description of the award.
|
nvarchar |
512 |
|
| 5.7 / 6.0 - Changed Column Size |
ExpiryCalculationType |
Calculation type for expiry of award |
nvarchar |
128 |
|
| 5.7 / 6.0 - Changed Column Size |
ExpiryNotificationType
|
Time unit for expiry notification (such as days)
|
nvarchar
|
128
|
|
| 8.7 - Updated description |
ExpiryDate |
Date when the award is scheduled to expire.
Can be NULL if the award never expires or has a relative expiry date.
|
datetime2
|
8
|
|
| 5.7 / 6.0 - Changed Column Size |
ImagePath |
Indicates the location where the award image is stored.
Field can be null.
|
varchar |
1000 |
|
| 5.7 / 6.0 - Field |
CreatedByUserId
|
User who created the award
|
bigint
|
8
|
|
| 3.4 |
LastModified
|
Date award was last changed (UTC).
|
datetime2
|
8
|
|
| 3.4 |
IsDeleted |
Indicates whether the award is deleted |
bit |
1 |
|
| 8.7 |
Criteria |
Indicates the criteria necessary to issue the award.
Field can be null.
|
nvarchar |
1000 |
|
Awards Issued
The Awards Issued Brightspace Data Set returns a list of all the awards that have been issued for your org units.
The only available data for the LastModifiedDate field is from August 2023 onwards.
Version
History
|
Field
|
Description
|
Type
|
Size
|
Key
|
|---|
| 2.5 / 3.0 - Added FK |
AwardId
|
Unique award identifier
|
bigint
|
8
|
FK
|
| 5.7 / 6.0 - Changed Column Size |
OrgUnitId
|
Unique org unit identifier
|
bigint
|
8
|
FK
|
| 1.4 - Removed PK |
UserId
|
Unique user identifier
|
bigint
|
8
|
FK
|
| 1.0 |
IssuedBy
|
Issued by user ID
|
int
|
4
|
FK
|
| 1.0 |
IssueDate
|
Award issue date (UTC).
|
datetime2
|
8
|
|
| 1.0 |
ExpiryDate
|
Award expiry date (UTC).
Field can be null.
|
datetime2
|
8
|
|
| 1.4 |
IssuedId |
Unique issued identifier |
bigint |
8 |
PK |
| 9.0 - Changed Description |
Criteria |
Indicates the criteria necessary to issue the award.
|
nvarchar |
1000 |
|
| 9.0 - Changed Description |
Evidence |
Provides proof that the user has met the criteria for the award.
|
nvarchar |
1000 |
|
| 9.0 |
RevokedDate |
Award revocation date (UTC).
Field can be null.
|
datetime2 |
8 |
|
| 9.0 |
RevokedReason |
Reason for revoking issued award.
Field can be null.
|
nvarchar |
1000 |
|
| 9.0 |
RevokedBy |
User who revoked the award.
Field can be null.
|
bigint |
8 |
FK |
| 9.0 |
LastModifiedBy |
User who last modified the issued award object. |
bigint |
8 |
FK |
| 9.5 - Updated Description |
LastModifiedDate |
Date the issued award object was last modified (UTC). Only captures data from August 2023 onwards.
Field can be null.
|
datetime2 |
8 |
|
| 9.0 |
Version |
Version number of this issued award. |
bigint |
8 |
|
Course Awards
The Course Awards Brightspace Data Set returns a list of all the awards that exist in each course for all your org units.
Version
History
|
Field
|
Description
|
Type
|
Size
|
Key
|
|---|
| 1.4 |
AssociationId |
Unique association identifier |
bigint |
8 |
PK |
| 1.0 |
AwardId
|
Unique award identifier
|
bigint
|
8
|
FK
|
| 1.0 |
OrgUnitId
|
Unique org unit identifier
|
bigint
|
8
|
FK
|
| 1.0 |
DateCreated |
Date when the award was created (UTC). |
datetime2
|
8
|
|
| 4.0 |
HiddenAward |
Award is hidden from learner view |
bit |
1 |
|
| 4.0 |
ConditionSetId |
Identifier for the conditions that need to be met in order to issue this award.
Field can be null.
|
bigint |
8 |
|
| 8.12 / 9.1 |
LastModified |
Date when the award was last changed (UTC).
Field can be null.
|
datetime2 |
8 |
|
| 8.12 / 9.1 |
Credits |
Indicates if the award has credits, and how many.
Field can be null.
|
decimal |
9, 2 |
|
| 8.12 / 9.1 |
IsAssociated |
Indicates whether the award is associated to the course. |
bit |
1 |
|
| 8.12 / 9.1 |
Version |
Version number for the course award. |
bigint |
8 |
|