ClassAssignmentUpdate.md

ClassAssignmentUpdate

Properties

Name	Type	Description	Notes
type	AssignmentType		[optional]
title	str	Title of the assignment	[optional]
description	str	Student instructions and content of the assignment (plain text)	[optional]
description_html	str	HTML version of student instructions. Pasted images may be sent as inline base64 `data:` URIs; they are uploaded to storage and rewritten to hosted URLs on save. The final HTML is limited to 100000 characters. When provided, the plain text version will be automatically extracted for compatibility.	[optional]
teacher_instructions	str	Teacher-only instructions (plain text)	[optional]
teacher_instructions_html	str	HTML version of teacher-only instructions. Pasted images may be sent as inline base64 `data:` URIs; they are uploaded to storage and rewritten to hosted URLs on save. The final HTML is limited to 100000 characters. When provided, the plain text version will be automatically extracted for compatibility.	[optional]
attachments	List[ClassAttachmentCreation]	The complete attachment list. Omitting this property on an update leaves the existing attachments alone; sending it replaces them. Dropping a dedicated score from the list deletes the students' copies of it, so send the full set you want to keep rather than only the additions. Duplicates, judged by `url`, `score`, `worksheet` or `googleDriveFileId`, are discarded silently, and exceeding the per-assignment limit fails with `ASSIGNMENT_ATTACHMENTS_LIMIT`.	[optional]
nb_playback_authorized	float	The number of playbacks authorized on the scores of the assignment.	[optional]
restrict_play_note	bool	Restrict the ability to get an audio feedback every time a student adds or selects a note.	[optional]
restrict_to_audio_tracks	bool	Restrict the audio source to provided audio tracks on a score. Students won't be able to use the editor playback.	[optional]
toolset	str	The id of the toolset to apply to this assignment. The toolset will be copied to the assignment as a dedicated object to prevent unexpected changes when making modifications to the template toolset. This property can be set to null to delete the linked toolset and switch back to all the tools available for this assignment.	[optional]
cover_file	str	The id of the cover to display	[optional]
cover	str	The URL of the cover to display	[optional]
max_points	float	If set, the grading will be enabled for the assignment with this value as the maximum of points	[optional]
release_grades	str	For worksheets, how grading will work for the assignment: - If set to `auto`, the grades will be automatically released when the student submits the submissions - If set to `manual`, the grades will only be set as `draftGrade` and will be released when the teacher returns the submissions	[optional]
shuffle_exercises	bool	Shuffle the worksheet exercises for each student	[optional]
submission_students_mode	AssignmentSubmissionStudentsMode		[optional]
recording_type	str	For performance assignments: recording type that will be either 'audio' or 'video'. * `audio`: Only audio will be required during the recording. * `video`: Camera will be required during the recording. Only set when type is 'performance'.	[optional]
allow_metronome	bool	For performance assignments: Enable students to use the metronome while they are recording, helping them stay in time. Only set when type is 'performance'.	[optional]
allow_backing_track	bool	For performance assignments: Enable students to listen to the accompaniment without their instrument part while they are playing. Only set when type is 'performance'.	[optional]
allow_speed_change	bool	For performance assignments: whether students can adjust the playback speed of the score during recording. * `true`: Students can change the tempo/speed during practice and recording * `false`: Tempo is fixed to the original score tempo Only set when type is 'performance'.	[optional]
free_record	bool	For performance assignments: "Free Record" mode. When `true`, no score is attached to the assignment. Students freely record a varied repertoire or an ensemble performance without being constrained by a single score's structure or duration, and all score-dependent options (playback, metronome, backtracking, speed control) are hidden. Only set when type is 'performance'.	[optional]
state	str	State of the assignment	[optional]
due_date	datetime	The due date of this assignment, late submissions will be marked as past due. If not set, the assignment won't have a due date.	[optional]
scheduled_date	datetime	The publication (scheduled) date of the assignment. If this one is specified, the assignment will only be listed to the teachers of the class.	[optional]
google_classroom	ClassAssignmentUpdateAllOfGoogleClassroom		[optional]
microsoft_graph	ClassAssignmentUpdateAllOfMicrosoftGraph		[optional]
assignee_mode	str	Possible modes of assigning assignments	[optional]
assigned_students	List[str]	Identifiers for the students that have access to the assignment	[optional]
class_group_ids	List[str]	Optional list of specific class group IDs to apply to the assignment. When transitioning to active state with group submission mode: - If provided: Only these specific groups will be applied - If not provided: All class groups will be applied, or randomized groups created if none exist	[optional]

Example

from flat_api.models.class_assignment_update import ClassAssignmentUpdate

# TODO update the JSON string below
json = "{}"
# create an instance of ClassAssignmentUpdate from a JSON string
class_assignment_update_instance = ClassAssignmentUpdate.from_json(json)
# print the JSON string representation of the object
print(ClassAssignmentUpdate.to_json())

# convert the object into a dict
class_assignment_update_dict = class_assignment_update_instance.to_dict()
# create an instance of ClassAssignmentUpdate from a dict
class_assignment_update_from_dict = ClassAssignmentUpdate.from_dict(class_assignment_update_dict)

[Back to Model list] [Back to API list] [Back to README]