2024-11-25
▼ ▲ classroom.courses.courseWork.updateRubric
Path : v1/courses/{courseId}/courseWork/{courseWorkId}/rubric
Flat Path : v1/courses/{courseId}/courseWork/{courseWorkId}/rubric
HTTP Method : PATCH
Parameters :
courseId
Description : Required. Identifier of the course.
Location : path
Required : Yes
Type : string
courseWorkId
Description : Required. Identifier of the course work.
Location : path
Required : Yes
Type : string
id
Description : Optional. Identifier of the rubric.
Location : query
Type : string
updateMask
Description : Optional. Mask that identifies which fields on the rubric to update. This field is required to do an update. The update fails if invalid fields are specified. There are multiple options to define the criteria of a rubric: the `source_spreadsheet_id` and the `criteria` list. Only one of these can be used at a time to define a rubric. The rubric `criteria` list is fully replaced by the rubric criteria specified in the update request. For example, if a criterion or level is missing from the request, it is deleted. New criteria and levels are added and an ID is assigned. Existing criteria and levels retain the previously assigned ID if the ID is specified in the request. The following fields can be specified by teachers: * `criteria` * `source_spreadsheet_id`
Location : query
Type : string
Format : google-fieldmask
Parameter Order :
Scopes : https://www.googleapis.com/auth/classroom.coursework.students
Description : Updates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are [limited](/classroom/rubrics/limitations) once grading has started. This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding course work, if the user isn't permitted to make the requested modification to the rubric, or for access errors. This error code is also returned if grading has already started on the rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work. * `INTERNAL` if grading has already started on the rubric.
▼ ▲ classroom.courses.courseWork.rubrics.patch
Path : v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Flat Path : v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
HTTP Method : PATCH
Parameters :
courseId
Description : Required. Identifier of the course.
Location : path
Required : Yes
Type : string
courseWorkId
Description : Required. Identifier of the course work.
Location : path
Required : Yes
Type : string
id
Description : Optional. Identifier of the rubric.
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Mask that identifies which fields on the rubric to update. This field is required to do an update. The update fails if invalid fields are specified. There are multiple options to define the criteria of a rubric: the `source_spreadsheet_id` and the `criteria` list. Only one of these can be used at a time to define a rubric. The rubric `criteria` list is fully replaced by the rubric criteria specified in the update request. For example, if a criterion or level is missing from the request, it is deleted. New criteria and levels are added and an ID is assigned. Existing criteria and levels retain the previously assigned ID if the ID is specified in the request. The following fields can be specified by teachers: * `criteria` * `source_spreadsheet_id`
Location : query
Type : string
Format : google-fieldmask
Parameter Order :
Scopes : https://www.googleapis.com/auth/classroom.coursework.students
Description : Updates a rubric. See google.classroom.v1.Rubric for details of which fields can be updated. Rubric update capabilities are [limited](/classroom/rubrics/limitations) once grading has started. This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding course work, if the user isn't permitted to make the requested modification to the rubric, or for access errors. This error code is also returned if grading has already started on the rubric. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work. * `INTERNAL` if grading has already started on the rubric.
▼ ▲ classroom.courses.courseWork.rubrics.create
Path : v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Flat Path : v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
HTTP Method : POST
Parameters :
courseId
Description : Required. Identifier of the course.
Location : path
Required : Yes
Type : string
courseWorkId
Description : Required. Identifier of the course work.
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/classroom.coursework.students
Description : Creates a rubric. This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the parent course work item. For further details, see [Rubrics structure and known limitations](/classroom/rubrics/limitations). This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user isn't permitted to create rubrics for course work in the requested course. * `INTERNAL` if the request has insufficient OAuth scopes. * `INVALID_ARGUMENT` if the request is malformed and for the following request error: * `RubricCriteriaInvalidFormat` * `NOT_FOUND` if the requested course or course work don't exist or the user doesn't have access to the course or course work. * `FAILED_PRECONDITION` for the following request error: * `AttachmentNotVisible`
▼ ▲ classroom.courses.courseWork.rubrics.get
Path : v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Flat Path : v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
HTTP Method : GET
Parameters :
courseId
Description : Required. Identifier of the course.
Location : path
Required : Yes
Type : string
courseWorkId
Description : Required. Identifier of the course work.
Location : path
Required : Yes
Type : string
id
Description : Required. Identifier of the rubric.
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes :
Description : Returns a rubric. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or rubric doesn't exist or if the user doesn't have access to the corresponding course work.
▼ ▲ classroom.courses.courseWork.rubrics.list
Path : v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Flat Path : v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
HTTP Method : GET
Parameters :
courseId
Description : Required. Identifier of the course.
Location : path
Required : Yes
Type : string
courseWorkId
Description : Required. Identifier of the course work.
Location : path
Required : Yes
Type : string
pageSize
Description : The maximum number of rubrics to return. If unspecified, at most 1 rubric is returned. The maximum value is 1; values above 1 are coerced to 1.
Location : query
Type : integer
Format : int32
pageToken
Description : nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
Location : query
Type : string
Parameter Order :
Scopes :
Description : Returns a list of rubrics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work doesn't exist or if the user doesn't have access to the corresponding course work.
▼ ▲ classroom.courses.courseWork.rubrics.delete
Path : v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Flat Path : v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
HTTP Method : DELETE
Parameters :
courseId
Description : Required. Identifier of the course.
Location : path
Required : Yes
Type : string
courseWorkId
Description : Required. Identifier of the course work.
Location : path
Required : Yes
Type : string
id
Description : Required. Identifier of the rubric.
Location : path
Required : Yes
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/classroom.coursework.students
Description : Deletes a rubric. This request must be made by the Google Cloud console of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding rubric. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project didn't create the corresponding rubric, or if the requesting user isn't permitted to delete the requested rubric. * `NOT_FOUND` if no rubric exists with the requested ID or the user does not have access to the course, course work, or rubric. * `INVALID_ARGUMENT` if grading has already started on the rubric.