Sign in

v1

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

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.

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

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

titlestring

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

courseIdstring

Immutable. Identifier of the course.

idstring

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

postIdstring

Immutable. Deprecated, use item_id instead.

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.

Response

Successful response