Brightspace Data Sets for Grades

Brightspace Data Sets for Grades include:

These data sets have a dependency on Grades. If you turn this tool on and off during the data set query period, there may be unexpected or missing content in your data sets.

Entity Relationship Diagram

To show the relationships between entities used to create Brightspace Data Sets for Grades, click the following thumbnail image:

Entity Relationship Diagram for Grades

 

Brightspace Data Set: Grade Objects

About

Returns a list of the grade objects created for your org units.

Data Set Availability

This data set is available as:

  • Full CSV, produced on a weekly basis, containing all of the data.
  • Differential CSV, produced on a daily basis or hourly basis as a paid add-on, containing the differences (diffs) of the data that was updated or inserted since the last successful differential which is typically the previous day or hour, respectively.

 

Grade Objects Data set is returning NULL grade scheme value when grade item is set to use default scheme. This is intended. When the value is NULL it means that it is using the default scheme.

 

Returned Fields

 

Version History

Field

Description

Type

Column Size

Key

1.0

GradeObjectId

Unique grade object identifier

Integer

4

PK

1.0

OrgUnitId

Unique org unit identifier

Integer

4

FK

1.0

ParentGradeObjectId

Parent grade object identifier. Field can be null.

Integer

4

FK

1.0

Name

Grade object name

nvarchar

256

 

1.0

TypeName

Grade object type name

varchar

50

 

1.0

CategoryName

Grade object category name. Field can be null.

nvarchar

256

 

1.0

StartDate

Start date for the grade object (UTC). Field can be null.

DateTime

8

 

1.0

EndDate

End date for the grade object (UTC). Field can be null.

DateTime

8

 

1.0

IsAutoPointed

Indicates if the object is automatically pointed. If this contains a value, the object automatically has points assigned; if it is set to 0, then the grade object must manually have points assigned.

Boolean

1

 

1.0

IsFormula

Is a formula associated with the grade object

Boolean

1

 

1.0

IsBonus

Is bonus grade

Boolean

1

 

4.8 / 5.2 - Updated column size

MaxPoints

Maximum points achievable in this grade

numeric

19, 9

 

1.0

CanExceedMaxGrade

Can user get more than maximum points

Boolean

1

 

1.0

ExcludeFromFinalGradeCalc

Is grade excluded from final grade calculation

Boolean

1

 

3.2 - Updated description

GradeSchemeId

Unique grade scheme identifier. This column returns a NULL result when the grade item is set to use default scheme. This is intended.

BigInteger

8

 

4.8 / 5.2 - Updated column size

Weight

Weight associated with the grade. Field can be null.

numeric

19, 9

 

1.0

NumLowestGradesToDrop

Drop number of lowest grades from the calculated grade

Integer

4

 

1.0

NumHighestGradesToDrop

Drop number of highest grades from the calculated grade

Integer

4

 

1.0

WeightDistributionType

Grade weight distribution within category. Field can be null.

String

10

 

1.0 CreatedDate Date the grade was created (UTC). Field can be null. DateTime 8  
1.0

ToolName

Tool associated with the object. Field can be null.

nvarchar

100

 

1.0

AssociatedToolItemId

Unique activity ID associated with the grade object: Dropbox ID, Quiz ID, Discussion ID. Field can be null.

BigInteger

8

 

1.1 - Added LastModified Last time the grade was modified (UTC). DateTime 8  
1.1 - Added ShortName The item or category short name as per the corresponding field in Brightspace Learning Environment. nvarchar 256  
1.1 - Added GradeObjectTypeId ID of the grade object Integer 4  
1.1 - Added SortOrder Specified sort order of grade objects Integer 4  
1.10 - Added IsDeleted Indicates if the grade object is deleted Boolean 1  
1.10 - Added DeletedDate Date the grade object was soft deleted. Field can be null. DateTime 8  
1.10 - Added DeletedByUserId ID of the user who deleted the grade object. Field can be NULL. BigInteger 8 FK
5.5 - Added ResultId Unique release condition result identifier. Field can be null. Integer 4 FK

 

Brightspace Data Set: Grade Objects Log

About

Returns a log of all changes to grades for each applicable user in the organization.

Data Set Availability

This data set is available as:

  • Full CSV, produced on a weekly basis, containing all of the data.
  • Differential CSV, produced on a daily basis or hourly basis as a paid add-on, containing the differences (diffs) of the data that was updated or inserted since the last successful differential which is typically the previous day or hour, respectively.

 

Returned Fields

 

Version History

Field

Description

Type

Column Size

Key

3.7 / 4.2

LogId

Unique grade object log identifier.

Integer

4

PK

3.7 / 4.2

Name

Name of the action.

nvarchar

256

 

3.7 / 4.2

GradeObjectId

Grade object identifier. Field can be null.

Integer

4

FK

3.7 / 4.2 UserId Unique identifier of the user who completed the action. Integer 4

FK

3.7 / 4.2

GradeSymbolString

Value of the grade. Field can be null.

nvarchar

256

 

4.8 / 5.2 - Updated column size

PointsDenominator Total number of points possible. Field can be null.

Numeric

19, 9

 

4.8 / 5.2 - Updated column size

PointsNumerator Number of points received by user. Field can be null.

Numeric

19, 9

 

4.8 / 5.2 - Updated column size

WeightedDenominator Total number of points possible after weight is applied. Field can be null.

Numeric

19, 9

 

4.8 / 5.2 - Updated column size

WeightedNumerator Number of points received after weight is applied. Field can be null. Numeric 19, 9  
3.7 / 4.2 Modified Date and time the action was made. DateTime 8  
3.7 / 4.2 ModifiedBy User who modified the grade object. Field can be null if done automatically. Integer 4  

Brightspace Data Set: Grade Results

About

Returns data from the newest grade objects first.

Data Set Availability

This data set is available as:

  • Full CSV, produced on a weekly basis, containing all of the data.
  • Differential CSV, produced on a daily basis or hourly basis as a paid add-on, containing the differences (diffs) of the data that was updated or inserted since the last successful differential which is typically the previous day or hour, respectively.

Returned Fields

 

Version History

Field

Description

Type

Column Size

Key
1.0

GradeObjectId

Unique grade object identifier

Integer

4

PK

FK

1.0

OrgUnitId

Unique org unit identifier

Integer

4

PK

FK

1.0

UserId

Unique user identifier

Integer

4

PK

FK

4.8 / 5.2 - Updated column size

PointsNumerator

Number of points received by user. Field can be null.

Numeric

19, 9

 

4.8 / 5.2 - Updated column size

PointsDenominator

Total number of points possible. Field can be null.

Numeric

19, 9

 

4.8 / 5.2 - Updated column size

WeightedNumerator

Number of points received after weight is applied. Field can be null.

Numeric

19, 9

 

4.8 / 5.2 - Updated column size

WeightedDenominator

Total number of points possible after weight is applied. Field can be null.

Numeric

19, 9

 

1.0

IsReleased

Is grade released. Field can be null.

Boolean

1

 

1.0

IsDropped

Is score dropped from final grade

Boolean

1

 

1.0

LastModified

Last time score was modified (UTC). Field can be null.

DateTime

8

 

2.5/3.0 - Added FK, changed type

LastModifiedBy

User ID of user who last modified the grade object. Field can be null.

BigInteger

8

FK

1.0

Comments.

Comments. Field can be null.

nvarchar

Truncated to 1000 characters. To change the default value, contact D2L.

 

1.0

PrivateComments

Private comments. Field can be null.

nvarchar

Truncated to 1000 characters. To change the default value, contact D2L.

 

1.1 - Added IsExempt Is exempt Boolean 1  
1.6 - Added GradeText Can be null nvarchar 100  
3.2 - Added GradeReleasedDate Date when the grade was released to the learner. (UTC) Field can be null.

DateTime

8

 
3.2 - Added Version Indicates the version of the grade result.

DateTime

8  

 

Brightspace Data Set: Grade Schemes

About

Returns data about created grade schemes. The data set calculates the range given the percent start in the database by looking at the next range. For example, if the data returned is 0, 50, 75, the resulting output in the data set is 0-50, 50-75, 75-100. The reason for the exclusive range is to include fractions that would occur between ranges. For example, if one range ended at 49 and the next started at 50, there would be a gap for fractions between 49 and 50. To be in the correct range, the business logic users should follow is this exclusive range:

RangeStart<=x<RangeEnd: Exception for 100 (base case)

Data Set Availability

This data set is available as:

  • Full CSV, produced on a weekly basis, containing all of the data.
  • Differential CSV, produced on a daily basis or hourly basis as a paid add-on, containing the differences (diffs) of the data that was updated or inserted since the last successful differential which is typically the previous day or hour, respectively.

Returned Fields

 

Version History

Field

Description

Type

Column Size

Key
1.4 - Added Primary Key designation GradeSchemeId Unique grade scheme identifier BigInteger 8 PK
1.0 OrgUnitId Unique org unit identifier Integer 4 FK
1.0 SchemeName Grade scheme name nvarchar 256  
1.0 SymbolString Range name nvarchar 100  

4.8 / 5.2 - Updated column size

RangeStart Range starting value Numeric 19, 9  
4.8 / 5.2 - Updated column size RangeEnd Range ending value

Numeric

19, 9  
1.4 - Added GradeSchemeRangeId Unique grade scheme range identifier BigInteger 8 PK

4.8 / 5.2 - Updated column size

AssignedValue Value assigned to the grade scheme Numeric 19, 9  
1.10 - Added IsDeleted Indicates that the grade scheme is deleted Boolean 1  
1.10 - Added DeletedDate Date when the scheme was deleted (UTC). Field can be NULL. DateTime 8  

 

Brightspace Data Set: Grade Book Settings

About

Returns all the grade book settings for your org units.

Data Set Availability

This data set is available as:

  • Full CSV, produced on a weekly basis, containing all of the data.
  • Differential CSV, produced on a daily basis or hourly basis as a paid add-on, containing the differences (diffs) of the data that was updated or inserted since the last successful differential which is typically the previous day or hour, respectively.

Returned Fields

Version History

Field

Description

Type

Column Size

Key

1.0

OrgUnitId

Unique org unit identifier

Integer

4

PK,

FK

2.5 / 3.0 - Removed FK

GradeSchemeId

Unique grade scheme identifier

BigInteger

8

PK

1.0

GradingSystem

Type of grading system setup for the course

String

10

 

1.0

UngradedItems

Drop ungraded items/Treat them as 0

String

27

 

1.0

IsAdjustedFinalGradeReleased

Is final adjusted grade released to user

Boolean

1

 

1.0

IsCalculatedFinalGradeReleased

Is calculated adjusted grade released to user

Boolean

1