Method: courses.courseWork.addOnAttachments.list

Returns all attachments created by an add-on under the post.

Requires the add-on to have active attachments on the post or have permission to create new attachments on the post.

This method returns the following error codes:

  • PERMISSION_DENIED for access errors.
  • INVALID_ARGUMENT if the request is malformed.
  • NOT_FOUND if one of the identified resources does not exist.

HTTP request

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
courseId

string

Required. Identifier of the course.
itemId

string

Identifier of the Announcement, CourseWork, or CourseWorkMaterial whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from postId.

Query parameters

Parameters
postId
(deprecated)

string

Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use itemId instead.
pageSize

integer

The maximum number of attachments to return. The service may return fewer than this value. If unspecified, at most 20 attachments will be returned. The maximum value is 20; values above 20 will be coerced to 20.
pageToken

string

A page token, received from a previous addOnAttachments.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to addOnAttachments.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListAddOnAttachmentsResponse.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/classroom.addons.student
  • https://www.googleapis.com/auth/classroom.addons.teacher

For more information, see the Authorization guide.