Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Entity API / removeBoard

Operation Information

  • Application Reference: com.hornbill.boardmanager
  • Scope: Entity - Board
  • Class: Entity
  • Required Privilege Level: user
  • Required Rights: Group A - canCreate

Description

Archive or permantely delete the board

Request Parameters

The removeBoard API takes the following input parameters.

Note

When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.

Name Type Required Description
boardId xs:integer Yes The Id of the board to delete
hardDelete xs:string No This board and all cards histroy etc will be permanently (this action cannot be undone)

Response Parameters

No response parameters are returned.

Code Examples

In This Document