GOgoogle
courses

POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments

Changed on

Creates an add-on attachment under a post. Requires the add-on to 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.

Request

  • Base URL
    https://classroom.googleapis.com
  • URL
    https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/classroom.addons.teacher
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/classroom.addons.teacher

Path parameters

courseIdstring required

Required. Identifier of the course.

itemIdstring required

Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.

Query parameters

addOnTokenstring

Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. This authorization token is required for in-Classroom attachment creation but optional for partner-first attachment creation. Returns an error if not provided for partner-first attachment creation and the developer projects that created the attachment and its parent stream item do not match.

postIdstring

Optional. Deprecated, use item_id instead.

Request body

courseIdstring

Immutable. Identifier of the course.

gradeSyncEnabledboolean

Output only. Whether changes to pointsEarned values on this attachment's student submissions will be copied to the pointsEarned field on the students' CourseWork submissions. This field can be true for at most one add-on attachment per stream item.

idstring

Immutable. Classroom-assigned identifier for this attachment, unique per post.

itemIdstring

Immutable. Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. Unique per course.

maxPointsnumber double

Maximum grade for this attachment. Can only be set if studentWorkReviewUri is set. Set to a non-zero value to indicate that the attachment supports grade passback. If set, this must be a non-negative integer value. When set to zero, the attachment will not support grade passback.

postIdstring

Immutable. Deprecated, use item_id instead.

titlestring

Required. Title of this attachment. The title must be between 1 and 1000 characters.

Response

Successful response

courseIdstring

Immutable. Identifier of the course.

gradeSyncEnabledboolean

Output only. Whether changes to pointsEarned values on this attachment's student submissions will be copied to the pointsEarned field on the students' CourseWork submissions. This field can be true for at most one add-on attachment per stream item.

idstring

Immutable. Classroom-assigned identifier for this attachment, unique per post.

itemIdstring

Immutable. Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. Unique per course.

maxPointsnumber double

Maximum grade for this attachment. Can only be set if studentWorkReviewUri is set. Set to a non-zero value to indicate that the attachment supports grade passback. If set, this must be a non-negative integer value. When set to zero, the attachment will not support grade passback.

postIdstring

Immutable. Deprecated, use item_id instead.

titlestring

Required. Title of this attachment. The title must be between 1 and 1000 characters.

Changes

  • 476192916dddRevision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status