BoardItem Object
Contains information about a board item.
This object is used by the following operations:
- Operations that reference the BoardItems object
The properties included in the BoardItem object are listed below.
| Property | Type | Description |
|---|---|---|
| BoardItemID | string | The unique ID for a specific Board item. For example, if it is an API board, it is the APIID. For information about how to find a BoardItemID, see Board Item ID. |
| Title | string | The title of the board item. |
| Description | string | The description of the board item. |
| Author | string | The author of the board item. |
| Path | anyURI | A URL to the board item. |
| pubDate | dateTime | The publication date for the board item, formatted in Coordinated Universal Time (UTC). |
| CreatedDts | dateTime | The date the board item was created. |
| Archivable | boolean | Indicates whether the Board item can be archived. |
| ResourceID | string[ ] |
The unique ID for a specific resource; for example, the ScopeID or the APIVersionID. One or more. |
| Type | string | The board item type; for example, Discussion or Ticket. For valid values, see Board Item Types. |
| MarkCount | integer | The number of marks on the resource. |
| IsMarked | boolean | Indicates whether there are any marks on the resource or not. |
| Mark | ItemMark[ ] |
Contains information about a mark on a board item. One or more. |
| CommentCount | integer | The total number of comments on the resource. |
| Comment | Comment[ ] |
Contains information about a comment on a Board item such as a ticket, discussion, or alert. One or more. |
| Tag | string[ ] | One or more user-defined tags assigned to the board item. |
| Visibility | string | The visibility setting for this resource. For a list of valid values, see Visibility Settings. |
| VisibleToID | string[ ] | A unique ID identifying the visibility of a Board item. |
| Rating | integer | A numeric rating value (1-5, with 1 being the worst rating and 5 the best). |
| CommentsAllowed | boolean | Indicates whether comments are allowed on the board item. |
| State | string | The state of the resource. |
| TicketLabel | string | A label assigned to a ticket. |
| Environment | string | The environment that the board item relates to (Sandbox or Production). |
| WorkflowState | string | The workflow state that the resource is currently in, if it is governed by a workflow. |
| Priority | string | The priority setting for the board item. |
| AuthoringUser | AuthoringUser |
Contains information about the author of a resource. The author of the board item. |
| TargetResources | TargetResources | Contains information about one or more resources associated with the current resource. Used only in response messages. |
| 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. |
| Published | boolean | Indicates whether the resource 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 an image or other artifact associated with a Board item. Applicable only if the DescriptionMediaType for the Board item is text/markdown. |
