Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1310484273.7 KB
courses

Updates one or more fields of a topic. This method returns the following error codes: * PERMISSION_DENIED if the requesting developer project did not create the corresponding topic or for access errors. * INVALID_ARGUMENT if the request is malformed. * FAILED_PRECONDITION if there exists a topic in the course with the same name. * NOT_FOUND if the requested course or topic does not exist

patch/v1/courses/{courseId}/topics/{id}

Path parameters

courseIdstring required

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

idstring required

Identifier of the topic.

Query parameters

updateMaskstring

Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an INVALID_ARGUMENT error is returned. The following fields may be specified: * name

Request body

courseIdstring

Identifier of the course. Read-only.

updateTimestring google-datetime

The time the topic was last updated by the system. Read-only.

topicIdstring

Unique identifier for the topic. Read-only.

namestring

The name of the topic, generated by the user. Leading and trailing whitespaces, if any, are trimmed. Also, multiple consecutive whitespaces are collapsed into one inside the name. The result must be a non-empty string. Topic names are case sensitive, and must be no longer than 100 characters.

Response

Successful response