Attributes¶

DataExport.DataSetFilter¶

This composite contains information about a filter definition for a data set.

{
    "Name": <string>,
    "Type": <int:EXPORTFILTERTYPE_T>,
    "Description": <string>,  // Added as of LMS v20.21.3
    "DefaultValue": <string>  // Added as of LMS v20.21.3
}

DefaultValue

Filter default value converted to a string.

EXPORTFILTERTYPE_T¶

Data set filter types are listed in the table below:

Filter type	Description
1	DateTime
2	OrgUnit
3	Role
4	User
5 ^	Boolean

^ Boolean export filter type added as of LMS v20.21.3

DataExport.DataSetData¶

This composite contains information about all of the built-in data sets available for you to use for your data export.

{
    "DataSetId": <string:GUID>,
    "Name": <string>,
    "Description": <string>,
    "Category": <string>,
    "Filters": [ { <composite:DataExport.DataSetFilter> }, ... ]
}

DataSetId

The GUID for an available data set on the back-end service.

Category

The category of the data set on the back-end service (e.g. Insights).

DataExport.ExportJobFilter¶

This composite contains information about a filter to apply to a data export.

{
    "Name": <string>,
    "Value": <string>
}

Here are the filters you can use, along with sample value formats:

Filter name	Example values
startDate, endDate ^	2016-02-24 2016-01-28T19:39:19.7687Z
parentOrgUnitId	6808
roles	578 578,901
userId	10283 “” - Empty string

^ Filters support only UTC date-time values

DataExport.CreateExportJobData¶

This composite contains information about the built-in data set you want to use for your data export.

{
    "DataSetId": <string:GUID>,
    "Filters": [ { <composite:DataExport.ExportJobFilter> }, ... ]
}

DataSetId

The GUID for an available data set on the back-end service.

DataExport.ExportJobData¶

This composite contains information about a data export job.

{
    "ExportJobId": <string:GUID>,
    "DataSetId": <string:GUID>,
    "Name": <string>,
    "SubmitDate": <string:UTCDateTime>,
    "Status": <int:EXPORTJOBSTATUS_T>,
    "Category": <string>
}

ExportJobId

The GUID for a given export of a particular data set.

DataSetId

The GUID representing a specific data set type.

Category

The category of the data set on the back-end service (e.g. Insights).

DataExport.DataSetsVersionInfo¶

This composite contains information about the current Data Sets versions in the Organization.

{
    "BdsVersion": <string>
}

BdsVersion

The current version for Brightspace Data Sets in the Organization.

EXPORTJOBSTATUS_T¶

Data set export jobs will have one of several distinct statuses, depending on where they are in the export process. The table below describes the statuses:

Job status	Description
0	Queued: Export job has been received for processing.
1	Processing: Currently in process of exporting data set.
2	Complete: Export completed successfully.
3	Error: An error occurred when processing the export.
4	Deleted: File associated with the completed export was deleted from the file system.

Actions¶

GET /d2l/api/lp/(version)/dataExport/list¶

Lists all available data sets.

Parameters

• version (D2LVERSION) – API version.

Oauth2 Scopes

reporting:dataset:list

Status Codes

• 200 OK – Action succeeded.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions

• 1.26+ – Route first appears in LMS v20.20.3.

• 1.22-1.25 – Deprecated as of LMS v20.21.1.

• 1.21- – Obsolete as of LMS v20.21.1.

Return. This action retrieves a JSON array of DataSetData blocks.

GET /d2l/api/lp/(version)/dataExport/list/(dataSetId)¶

Retrieve a data set.

Parameters

• version (D2LVERSION) – API version.

• dataSetId (GUID) – Data set identifier.

Oauth2 Scopes

reporting:dataset:fetch

Status Codes

• 200 OK – Action succeeded.

• 403 Forbidden – No permission to view the specified data set.

• 404 Not Found – Invalid data set id provided.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions

• 1.26+ – Route first appears in LMS v20.20.3.

• 1.22-1.25 – Deprecated as of LMS v20.21.1.

• 1.21- – Obsolete as of LMS v20.21.1.

Return. This action retrieves a DataSetData JSON block containing the information for the requested data set.

POST /d2l/api/lp/(version)/dataExport/create¶

Create an export job for the requested data set.

Parameters

• version (D2LVERSION) – API version.

JSON Parameters

• CreateExportJobData (DataExport.CreateExportJobData) – Properties of the export job request

Oauth2 Scopes

reporting:job:create

Status Codes

• 200 OK – Action succeeded.

• 202 Accepted – Job request accepted, but not yet ready.

• 400 Bad Request – Invalid data set data provided, or could not create job for data set.

• 403 Forbidden – No permission to manage the specified data set.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions

• 1.26+ – Route first appears in LMS v20.20.3.

• 1.22-1.25 – Deprecated as of LMS v20.21.1.

• 1.21- – Obsolete as of LMS v20.21.1.

Return. This action retrieves a ExportJobData JSON block containing the information for the requested export job.

GET /d2l/api/lp/(version)/dataExport/jobs¶

Lists all available export jobs that you have previously submitted.

Parameters

• version (D2LVERSION) – API version.

Query Parameters

• page (integer) – Optional. Page number to retrieve (page size is 100 records).

Oauth2 Scopes

reporting:job:list

Status Codes

• 200 OK – Action succeeded.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions

• 1.26+ – Route first appears in LMS v20.20.3.

• 1.22-1.25 – Deprecated as of LMS v20.21.1.

• 1.21- – Obsolete as of LMS v20.21.1.

Return. This action retrieves a JSON array of ExportJobData blocks, sorted by most recent SubmitDate. By default, only the first 100 records are retrieved. Additional records can be retrieved by specifying the optional page query string parameter.

GET /d2l/api/lp/(version)/dataExport/jobs/(exportJobId)¶

Retrieves information about a data export job that you have previously submitted.

Parameters

• version (D2LVERSION) – API version.

• exportJobId (GUID) – Export job identifier.

Oauth2 Scopes

reporting:job:fetch

Status Codes

• 200 OK – Action succeeded.

• 403 Forbidden – No permission to view the specified data set.

• 404 Not Found – Invalid export job id provided.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions

• 1.26+ – Route first appears in LMS v20.20.3.

• 1.22-1.25 – Deprecated as of LMS v20.21.1.

• 1.21- – Obsolete as of LMS v20.21.1.

Return. This action retrieves a ExportJobData JSON block with the export job’s information.

GET /d2l/api/lp/(version)/dataExport/download/(exportJobId)¶

Retrieves a ZIP file containing a CSV file with the data of the requested export job that you previously submitted.

Parameters

• version (D2LVERSION) – API version.

• exportJobId (GUID) – Export job identifier.

Oauth2 Scopes

reporting:job:download

Status Codes

• 200 OK – Action succeeded.

• 403 Forbidden – No permission to view the specified data set.

• 404 Not Found – Invalid export job id provided, or job not available for download.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions

• 1.26+ – Route first appears in LMS v20.20.3.

• 1.22-1.25 – Deprecated as of LMS v20.21.1.

• 1.21- – Obsolete as of LMS v20.21.1.

Return. This action retrieves a ZIP file containing a CSV file that contains the data of the export job that you requested.

GET /d2l/api/lp/(version)/dataExport/version¶

Retrieves information about the Data Sets versions.

Parameters

• version (D2LVERSION) – API version.

Status Codes

• 200 OK – Action succeeded.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions

• 1.30+ – Route first appears in LMS v20.20.11.

Return. This action retrieves a DataSetsVersionInfo with information about the data sets versions.

Note

You can make this call anonymously.

If you’re using ID-Key Authentication, you do not need to include the x_b and x_d query parameter values for this call. If you do provide user ID and user signature query parameter values with this call, you should ensure they are validly formed user tokens. This has the advantage of identifying the application making the call to this route.

If you’re using OAuth2, you do not need to provide an Authorization header (containing a bearer token) with your call.