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}}

Application API / loadBoard

Operation Information

  • Application Reference: com.hornbill.boardmanager
  • Scope: Global
  • Class: Application
  • Required Privilege Level: user
  • Required Rights: Group A - canView

Description

load a board and data

Request Parameters

The loadBoard 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:string Yes The Id of the board to load
type xs:string No List of types that could be on this board
tagFilter xs:integer No Tags to filter board by

Response Parameters

Name Type Description
board JSONDataType Metadata describing the board including title, description etc
cards JSONDataType Array of cards
lanes JSONDataType Array of lanes
tags JSONDataType Tag data
shares JSONDataType Array of users, groups and roles to use in the user filter
view JSONDataType Custom view data for this board and user

Code Examples

In This Document