Discussion Object
Includes information about a discussion.
This object is used by the following operations:
- POST /api/discussions
- GET /api/discussions/{DiscussionID}
- Operations that reference the Discussions object
- Operations that reference the DiscussionDetails object
The parameters included in the Discussion object are listed below.
| Property | Type | Description |
|---|---|---|
| DiscussionID | string | The unique ID for a specific discussion. |
| DiscussionSubjectID | string | The unique ID for the specific resource that a discussion relates to; for example, the AppVersionID, APIVersionID, GroupID, or a custom BoardID. |
| Discussion Type | string | The type of discussion. Deprecated. Might be returned in a response object. |
| Topic | string | The topic of the discussion, as specified by the user starting the discussion. |
| Content | string | The content of the discussion. |
| UserID | string | The unique ID for a specific user. |
| UserName | string | The username of the author of the discussion. |
| Created | dateTime | The date/time stamp when the resource was first created. Used only in response messages. |
| Comments | integer | The number of comments on the resource, such as on a discussion, ticket, or alert. |
| Marks | integer | The number of marks on the discussion. |
| IsMarked | boolean | Indicates whether there are any marks on the discussion or not. |
| Tag | string[ ] | One or more user-defined tags assigned to the discussion. |
| Visibility | string | The visibility setting for this resource. For a list of valid values, see Visibility Settings. |
| pubDate | dateTime | The publication date for the discussion, formatted in Coordinated Universal Time (UTC). |
| CommentsPreview | CommentsPreview | A preview of the comments added to the resource (the last two comments plus total count). |
| Action | Action[ ] |
An extensibility element for a workflow action event that possibly could be taken on a specific resource. Used to call a JavaScript action. A list of actions available on the resource. |
| Link | string | A link for the resource, if applicable. |
| AuthoringUser | AuthoringUser |
Contains information about the author of a resource. The author who started the discussion. |
| TargetResources | TargetResources | Contains information about one or more resources associated with the current resource. Used only in response messages. |
| Image | Image | Contains information about an avatar associated with a resource. |
| Published | boolean | Indicates whether the discussion is published. |
| DescriptionMediaType | string | Indicates the media type for the description of an artifact associated with a Board item. Valid values: text/markdown (the default if platform settings support markdown) or text/plain (the default if markdown is not supported). |
| BoardItemArtifacts | BoardItemArtifacts | Contains information about the images and/or other artifacts associated with a Board item. |