Connect an AI assistant
Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.
The catalog did not load. Refresh the page to try again.
Loading…
{{server.name}}
{{server.summary}}
{{server.documentCount.toLocaleString()}} pages Not published to this site
- Name
-
{{server.name}} - URL
-
{{mcpServerUrl(server.path)}}
| Tool | What it does |
|---|---|
{{tool.name}} |
{{part.text}}{{part.text}} |
How can we help?
{{docApp.searchError}}
{{product.name}}
Keep typing - a search needs at least two characters
Searching in {{docApp.searchFilterBySpecificBookTitle}}
Searching for:
{{docApp.searchResultFilteredItems.length}} results for:
{{docApp.currentResultsSearchText}}
in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown.
Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.
You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
-
{{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Entity API / getBoardsList
- Article
- 4 minutes to read
Operation Information
- Application Reference:
com.hornbill.boardmanager - Scope:
Entity - Board - Class:
Entity - Required Privilege Level:
user - Required Rights: Group A - canView
Description
Returns the boards the calling user can see, as the getBoardsList stored query resolves them. An operation rather than a direct stored-query call so that a client can ask for the list over the JSON API: data::queryExec is not available there, and a stored query invoked through it is rejected on some platform builds and tolerated on others.
Request Parameters
The getBoardsList 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 |
|---|---|---|---|
application |
xs:string |
No | Only return boards belonging to this application. |
urn |
xs:string |
No | Only return boards associated with this URN. |
type |
xs:string |
No | Only return boards that accept this card type. The value is matched with LIKE, so it should start and end with %. |
groupRole |
xs:string |
No | Return the board list for this group or role. |
nameFilter |
xs:string |
No | Only return boards whose name matches this filter. |
favorites |
xs:boolean |
No | Only return boards the caller has starred. The stored query spells the equivalent filter in British English; this operation uses the platform spelling and maps between the two. |
all |
xs:boolean |
No | Return every board on the instance. Honored only for a caller holding the Board Super User role; ignored otherwise. |
rowstart |
xs:integer |
No | Row to start at, for paging. Applied only when limit is also supplied. |
limit |
xs:integer |
No | Maximum rows to return, for paging. Applied only when rowstart is also supplied. |
includeArchived |
xs:boolean |
No | Return archived boards INSTEAD OF live ones. The stored query treats this as a switch between the two rather than as an addition, and the name is kept as it is for compatibility with existing callers. |
iown |
xs:boolean |
No | Only return boards owned by the caller. |
permissions |
xs:string |
No | Only return boards on which the caller holds at least one of the permissions in this bitmask: canmovecard=2, canupdatecard=4, canaddcard=8, canadmin=16, candesign=32. Filtering here is done in SQL, so a caller wanting only the boards it may add a card to should pass 8 rather than fetching every board and sifting them. |
Response Parameters
| Name | Type | Description |
|---|---|---|
boards |
JSONDataType |
The matching boards, exactly as the getBoardsList stored query returns them - see query/getBoardsList.xml for the columns it selects, which include the caller's combined permission bitmask in h_permissions. Always an array, including when a single board matches. |
Code Examples
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.boardmanager/Board' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.boardmanager/Board","@method":"getBoardsList","params":{"application":"xs:string","urn":"xs:string","type":"xs:string","groupRole":"xs:string","nameFilter":"xs:string","favorites":false,"all":false,"rowstart":1,"limit":1,"includeArchived":false,"iown":false,"permissions":"xs:string"}}'
package main
import (
"fmt"
apiLib "github.com/hornbill/goApiLib"
)
func main() {
hornbillAPI := apiLib.NewXmlmcInstance("yourinstanceid")
hornbillAPI.SetAPIKey("yourHornbillAPIKey")
hornbillAPI.SetJSONResponse(true)
hornbillAPI.SetParam("application", "xs:string")
hornbillAPI.SetParam("urn", "xs:string")
hornbillAPI.SetParam("type", "xs:string")
hornbillAPI.SetParam("groupRole", "xs:string")
hornbillAPI.SetParam("nameFilter", "xs:string")
hornbillAPI.SetParam("favorites", "xs:boolean")
hornbillAPI.SetParam("all", "xs:boolean")
hornbillAPI.SetParam("rowstart", "xs:integer")
hornbillAPI.SetParam("limit", "xs:integer")
hornbillAPI.SetParam("includeArchived", "xs:boolean")
hornbillAPI.SetParam("iown", "xs:boolean")
hornbillAPI.SetParam("permissions", "xs:string")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.boardmanager/Board", "getBoardsList")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.boardmanager/Board";
const payload = {
"@service": "apps/com.hornbill.boardmanager/Board",
"@method": "getBoardsList",
"params": {
"application": "xs:string",
"urn": "xs:string",
"type": "xs:string",
"groupRole": "xs:string",
"nameFilter": "xs:string",
"favorites": false,
"all": false,
"rowstart": 1,
"limit": 1,
"includeArchived": false,
"iown": false,
"permissions": "xs:string"
}
};
fetch(endpoint, {
method: 'POST',
headers: {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
},
body: JSON.stringify(payload)
}).then(res => res.json())
.then(res => console.log(res));
const axios = require('axios');
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.boardmanager/Board";
const payload = {
"@service": "apps/com.hornbill.boardmanager/Board",
"@method": "getBoardsList",
"params": {
"application": "xs:string",
"urn": "xs:string",
"type": "xs:string",
"groupRole": "xs:string",
"nameFilter": "xs:string",
"favorites": false,
"all": false,
"rowstart": 1,
"limit": 1,
"includeArchived": false,
"iown": false,
"permissions": "xs:string"
}
};
const axiosConfig = {
headers: {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
};
axios.post(endpoint, payload, axiosConfig)
.then((res) => {
console.log("RESPONSE RECEIVED: ", res);
})
.catch((err) => {
console.log("AXIOS ERROR: ", err);
})
$endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.boardmanager/Board";
$payload = (object) [
'@service' => 'apps/com.hornbill.boardmanager/Board',
'@method' => 'getBoardsList',
'params' => (object) [
'application' => 'xs:string',
'urn' => 'xs:string',
'type' => 'xs:string',
'groupRole' => 'xs:string',
'nameFilter' => 'xs:string',
'favorites' => 'xs:boolean',
'all' => 'xs:boolean',
'rowstart' => 'xs:integer',
'limit' => 'xs:integer',
'includeArchived' => 'xs:boolean',
'iown' => 'xs:boolean',
'permissions' => 'xs:string',
]
];
$headers = [
'Authorization: ESP-APIKEY yourHornbillAPIKey',
'Content-Type: application/json'
];
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $endpoint);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$resp = curl_exec($curl);
curl_close($curl);
echo $resp;
$Endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.boardmanager/Board"
$Body = @{
"@service" = "apps/com.hornbill.boardmanager/Board"
"@method" = "getBoardsList"
params = @{
application = "xs:string"
urn = "xs:string"
type = "xs:string"
groupRole = "xs:string"
nameFilter = "xs:string"
favorites = "xs:boolean"
all = "xs:boolean"
rowstart = "xs:integer"
limit = "xs:integer"
includeArchived = "xs:boolean"
iown = "xs:boolean"
permissions = "xs:string"
}
}
$Header = @{
"Authorization" = "ESP-APIKEY yourHornbillAPIKey"
}
$Parameters = @{
Method = "POST"
Uri = $Endpoint
Headers = $Header
Body = ($Body | ConvertTo-Json)
ContentType = "application/json"
}
Invoke-RestMethod @Parameters
import requests
import json
endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.boardmanager/Board"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.boardmanager/Board",
"@method":"getBoardsList",
"params":{
"application":"xs:string",
"urn":"xs:string",
"type":"xs:string",
"groupRole":"xs:string",
"nameFilter":"xs:string",
"favorites":"xs:boolean",
"all":"xs:boolean",
"rowstart":"xs:integer",
"limit":"xs:integer",
"includeArchived":"xs:boolean",
"iown":"xs:boolean",
"permissions":"xs:string",
},
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document