Brightspace Data Sets for Org Units

Brightspace Data Sets for Org Units include:

These data sets do not depend on specific tools being turned on.

Entity Relationship Diagram

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

Entity Relationship Diagram for Org Units

 

Brightspace Data Set: Organizational Unit Ancestors

About

Returns a list of all the org units and the corresponding ancestors for an org unit. An ancestor is defined as a parent of an org unit.

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

1.0

AncestorOrgUnitId

Parent org unit identifier

Integer

4

PK

FK

 

Brightspace Data Set: Organizational Unit Descendants

About

Returns a list of all the org units and the corresponding descendants for an org unit. A descendant is defined as the child of an org unit.

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

1.0

DescendantOrgUnitId

Child org unit identifier

Integer

4

PK

FK

 

Brightspace Data Set: Organizational Unit Recent Access

About

Returns a list of users, corresponding org units, and the time stamp when they most recently accessed the org unit.

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

1.0

UserID

User ID of the user that accessed the org unit

Integer

4

PK

FK

1.0

LastAccessedDate

Date the org was last accessed (UTC).

DateTime

8

 

 

Brightspace Data Set: Organizational Units

About

Returns details about all org units within your 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

1.0

OrgUnitId

Unique org unit identifier

Integer

4

PK

1.0

Organization

Organization name

String

100

 

3.2 - Update to description

Type

Org unit type. If the type is a group which is a section, it is displayed as Section.

String

100

 

4.8/5.2 - Update to description

Name

Org unit name. Field can be null.

nvarchar

256

 

4.8/5.2 - Update to description & column size

Code

Org unit code. Field can be null.

nvarchar

50

 

1.0

StartDate

Availability start date (UTC). Field can be null.

DateTime

8

 

1.0

EndDate

Availability end date (UTC). Field can be null.

DateTime

8

 

1.0

IsActive

Is the org unit active

Boolean

1

 

1.0

CreatedDate

Org unit create date

DateTime

8

 

1.9 - Added IsDeleted

Is the org unit soft deleted or recycled.

Soft delete - the org unit has been soft deleted from the application, but is still present in the database.

Recycled - the org unit remains in the recycle bin until removed, at which point it is deleted.

The OrgName for recycled or soft deleted org units is SYSTEM.

Backfill of historical IsDeleted, DeletedDate, and RecycledDate values is determined by the date/time values in the OrgUnit audit log.

Boolean 1  
1.9 - Added DeletedDate Date the org unit was soft deleted. Field can be null. DateTime 8  
1.9 - Added RecycledDate Date the org unit was recycled. Field can be null. DateTime 8  
3.1 - Added row Version Indicates the version of the content in the row. Timestamp 8  
4.8 / 5.2 - Added OrgUnitTypeId Identifier for the org unit type. Integer 4  

 

Brightspace Data Set: Organizational Unit Parents

About

Returns the direct parent of each org unit in order to build out the initial org unit structure.

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

2.3

OrgUnitId

Unique org unit identifier

Integer

4

PK

FK

2.3

ParentOrgUnitId

Parent org unit identifier

Integer

4

PK

FK

2.3 RowVersion

Indicates the version of the row. This information is used to determine which table row occurred first, similar to the way time stamps function in other data sets.

Integer 4