limitinteger
The maximum number of results to be returned. There may be less if the query returned less than the maximum.
fieldsstring
A comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
offsetinteger
The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
columnIdObligatoriostring
The grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword "finalGrade", which indicates that the course"s final grade column is specified. | ID type | Example | |------------|---------------------------…
courseIdObligatoriostring
The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 |…
changeIndexinteger
Retrieve only items modified after the given change index. **Since**: 3300.4.0
lastRelevantDatestring
Set the search criteria to the search value of the lastRelevantDate. **Since**: 3900.78.0
firstRelevantDatestring
Set the search criteria to the search value of the firstRelevantDate. **Since**: 3900.78.0
includeUnpostedGradesboolean
If true, calculated columns exposed in the response will be processed such that any unposted grades are included in their calculations. If false, only posted grades will be included in calculations. Entitlements course.gradebook-grades.VIEW, course.gradebook.MODIFY and course.gr…
lastRelevantDateComparestring
Assign the compare value to the search criteria, and it works along with the lastRelevantDate. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3900.78.0 | Type | Description | --------- | --------- | | lessThan | | | greaterO…
firstRelevantDateComparestring
Assign the compare value to the search criteria, and it works along with the firstRelevantDate. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3900.78.0 | Type | Description | --------- | --------- | | lessThan | | | greater…
includeDisabledMembershipsboolean
If false, only active course memberships will be exposed in the response. By default, the value is false. If true, users with disabled access to the course will also be included in the response. Entitlements course.gradebook-grades.VIEW, course.gradebook.MODIFY and course.gradeb…
