...
| Field | Description | Initializable by | Editable by |
|---|---|---|---|
| id | String. The identifier string of the thread. | None | None |
| course_id | String. The identifier string of the thread's course. | Any role | None |
| topic_id | String. The identifier of the thread's topic. | Any role | Author or privileged role |
| group_id | Integer. The numeric identifier of the thread's group (i.e. cohort) or null if not in a group. | Privileged role | Privileged role |
| group_name | String. The display name of the thread's group (i.e. cohort) or null if not in a group. | None | None |
| author | String. The username of the thread's author. Null if and only if the thread is anonymous or the thread is anonymous to students and the user does not have a privileged role. Can vary by user. | None | None |
| author_label | String. A string value to indicate that the author has a privileged role. Currently, this will be either "Staff" for Administrators and Moderators or "Community TA" for Community TAs. It is up to the client to decide how to display this information to the user. | None | None |
| created_at | ISO 8601 String. The timestamp of the thread's creation. | None | None |
| updated_at | ISO 8601 String. The timestamp of the thread's last modification. Note that this can include certain operations that are not visible to the present user, such as the thread being flagged by another user. | None | None |
| type | String. The type of post (either "question" or "discussion"). | Any role | Author or privileged role |
| title | String. The title of the thread. | Any role | Author or privileged role |
| raw_body | String. The raw content of the thread. This may contain Markdown, HTML, and MathJax markup. | Any role | Author or privileged role |
| rendered_body | String. The content of the thread, rendered in HTML (Markdown rendering and HTML stripping applied). | None | None |
| has_endorsed | Boolean. Whether the thread has any endorsed comments. | None | None |
| pinned | Boolean. Whether the thread is pinned (to appear at the beginning of a thread list regardless of sort). | Privileged role | Privileged role |
| closed | Boolean. Whether new edits and responses are allowed. | Privileged role | Privileged role |
| following | Boolean. Whether the user is following the thread. Can vary by user. | Any role | Any role |
| abuse_flagged | Boolean. Whether the user has flagged the thread as abusive. Can vary by user. | None | Any role |
| voted | Boolean. Whether the user has voted for the thread. Can vary by user. | None | Any role |
| vote_count | Integer. The total number of votes for the thread. | None | None |
| read | Boolean. Whether the user has read the thread. Can vary by user. | None | None |
| comment_count | Integer. The total count of contributions (post + responses + comments) for the thread. | None | None |
| unread_comment_count | Integer. The total count of unread contributions (post + responses + comments) for the thread. Can vary by user. | None | None |
| comment_list_url | String. The URL of the comment list for the thread. In Q4 implementation, this will be null for question threads. | None | None |
| endorsed_comment_list_url | String. The URL of the endorsed comment list for the thread. In Q4 implementation, this will be null for discussion threads. | None | None |
| non_endorsed_comment_list_url | String. The URL of the non-endorsed comment list for the thread. In Q4 implementation, this will be null for discussion threads. | None | None |
| editable_fields | List of Strings. The names of fields that can be edited by the user. | None | None |
...
| Field | Description | Initializable by | Editable by |
|---|---|---|---|
| id | String. The identifier string of the comment. | None | None |
| parent_id | String. The identifier string of the comment's parent comment (null for first-level thread responses). | Any role | None |
| thread_id | String. The identifier string of the comment's thread. | Any role | None |
| author | String. The username of the thread's author. If and only if anonymous is true or anonymous_to_students is true and the user does not have a privileged role and is not the author, this will be null. Can vary by user. | None | None |
| author_label | String. A string value to indicate that the author has a privileged role. Currently, this will be either "Staff" for Administrators and Moderators or "Community TA" for Community TAs. It is up to the client to decide how to display this information to the user. | None | None |
| created_at | ISO 8601 String. The timestamp of the comment's creation. | None | None |
| updated_at | ISO 8601 String. The timestamp of the comment's last modification. Note that this can include certain operations that are not visible to the present user, such as the thread being flagged by another user. | None | None |
| raw_body | String. The raw content of the comment. This may contain Markdown, HTML, and MathJax markup. | Any role | Author or privileged role |
| rendered_body | String. The content of the comment, rendered in HTML (Markdown rendering and HTML stripping applied). | None | None |
| endorsed | Boolean. Whether the comment has been endorsed by a privileged user or accepted as a correct answer by the thread author or a privileged user. | Thread author (if thread is a question) or privileged role | Thread author (if thread is a question) or privileged role |
| endorsed_by | String. The username of the user who endorsed the comment. Can be null if the information is unavailable or to avoid revealing the identity of the author of an anonymous thread (i.e. when a non-staff author of an anonymous thread endorses a response). | None | None |
| endorsed_by_label | String. A string value to indicate that the endorser has a privileged role. Currently, this will be either "Staff" for Administrators and Moderators or "Community TA" for Community TAs. It is up to the client to decide how to display this information to the user. | None | None |
| endorsed_at | ISO 8601 String. The timestamp of the endorsement or acceptance as a correct answer. Can be null if the information is unavailable. | None | None |
| abuse_flagged | Boolean. Whether the user has flagged the comment as abusive. Can vary by user. | None | Any role |
| voted | Boolean. Whether the user has voted for the comment. Can vary by user. | None | Any role |
| vote_count | Integer. The total number of votes for the comment. | None | None |
| children | List of Comments. The children of this comment. | None | None |
| editable_fields | List of Strings. The names of fields that can be edited by the user. | None | None |
...