Boards Service: Overview

The Boards service provides operations for retrieving information about various Boards in the portal, such as the Board for an app, API, or group, or a user-defined board, the Forum (Site Admin, Business Admin, or API Admin only), or the Support Board for the business.

In general, operations that take the BoardID as an input parameter are used only for user-defined boards. For other types of boards, there are corresponding operations in each service (apis, apps, groups) that offer the same functionality. Operations that take other IDs as input parameters, such as BoardItemID or CommentID, can be used with all types of boards.

For more information about Boards, see Boards in the developer portal.

URL: https://{hostname}/api/boards

Action Endpoint Description
add artifact (first) POST /api/boards/items/artifacts Adds the first artifact, such as an uploaded image or file, to be used in the markdown for a Board item that is being created.
add artifact (subsequent) POST /api/boards/items/{BoardItemID/artifacts Adds an artifact, such as an uploaded image or file, to be used in the markdown for a Board item that is being edited (subsequent artifact, after the first).
add comment artifact (first) POST /api/boards/items/comments/artifacts Adds an artifact, such as an uploaded image or file, to be used in the markdown for a comment that is being created (first artifact).
add comment artifact (subsequent) POST /api/boards/items/comments/{CommentID}/artifacts Adds an artifact, such as an uploaded image or file, to be used in the markdown for a comment that is being edited (subsequent artifact, after the first).
comment on board item POST /api/boards/items{BoardItemID :(/[^/]+?)?}/comments Adds a comment to the specified Board item.
delete artifact DELETE /api/boards/items/{BoardItemID}/artifacts/{FileName} Deletes the specified artifact for the specified BoardItemID.
delete comment artifact DELETE /api/boards/items/comments/{CommentID}/artifacts/{FileName} Deletes the specified artifact for the specified comment.
get artifact GET /api/boards/items/{BoardItemID}/artifacts/{FileName} Returns the specified artifact associated with the specified Board item.
get board GET /api/boards/{BoardID} Returns information about a user-defined board or the Support Board.
get board item comments GET /api/boards/items/{BoardItemID}/commentdetails Returns the list of comments for a specific Board item.
get board item details GET /api/boards/items/{BoardItemID}/details Returns details about a specific Board item, excluding comments. Valid for all board types.
get board items GET /api/boards/{BoardID}/board Returns Board items for the specified user-defined board, in the form of an RSS feed.
get comment artifact GET /api/boards/items/comments/{CommentID}/artifacts/{FileName} Returns the specified artifact associated with the specified comment.
get comment details GET /api/boards/items/comments/{CommentID}/details Returns details about the specified Board comment.
get followers GET /api/boards/{BoardID}/followers Returns information about the followers of the specified user-defined board, in the form of an RSS feed.
list board items GET /api/boards/{BoardID}/board Returns Board items for the specified Board, in the form of a JSON or XML object.
perform comment workflow action POST /api/boards/items/comments/{CommentID}/actions Performs a workflow action on the specified comment.

Back to top

Related Topics