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!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Operation Information
- Application Reference:
com.hornbill.boardmanager - Scope:
Entity - Board - Class:
Entity - Required Privilege Level:
user - Required Rights: Group A - canView
Description
Check the permissions on the board for the specified user. The flowcode will throw an exception if an input permission is not allowed.
Request Parameters
The checkPermissions API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.
| Name | Type | Required | Description |
|---|---|---|---|
boardId |
xs:string |
No | Board Id to check Permissions for |
cardId |
xs:string |
No | The card Id (used to get board Id if the board Id isn't supplied) |
canView |
xs:boolean |
No | Can view the board |
canMove |
xs:boolean |
No | can Move cards on Board |
canUpdate |
xs:boolean |
No | Can Update Cards |
canAdd |
xs:boolean |
No | can Add and remove cards |
canShare |
xs:boolean |
No | can Share and set permissions |
canDesign |
xs:boolean |
No | Can create and remove columns and change column configuration |
Response Parameters
| Name | Type | Description |
|---|---|---|
mask |
xs:string |
permissions mask |
canView |
xs:boolean |
True if the user can view this board |
canMove |
xs:string |
True if the user can move cards |
canUpdate |
xs:string |
True if the user can update card |
canAdd |
xs:string |
True if the user can Add or Remove cards |
canShare |
xs:string |
True if the user can share the board |
canDesign |
xs:string |
True if the user can design the board |
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":"checkPermissions","params":{"boardId":"xs:string","cardId":"xs:string","canView":false,"canMove":false,"canUpdate":false,"canAdd":false,"canShare":false,"canDesign":false}}'
package main
import (
"fmt"
apiLib "github.com/hornbill/goApiLib"
)
func main() {
hornbillAPI := apiLib.NewXmlmcInstance("yourinstanceid")
hornbillAPI.SetAPIKey("yourHornbillAPIKey")
hornbillAPI.SetJSONResponse(true)
hornbillAPI.SetParam("boardId", "xs:string")
hornbillAPI.SetParam("cardId", "xs:string")
hornbillAPI.SetParam("canView", "xs:boolean")
hornbillAPI.SetParam("canMove", "xs:boolean")
hornbillAPI.SetParam("canUpdate", "xs:boolean")
hornbillAPI.SetParam("canAdd", "xs:boolean")
hornbillAPI.SetParam("canShare", "xs:boolean")
hornbillAPI.SetParam("canDesign", "xs:boolean")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.boardmanager/Board", "checkPermissions")
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": "checkPermissions",
"params": {
"boardId": "xs:string",
"cardId": "xs:string",
"canView": false,
"canMove": false,
"canUpdate": false,
"canAdd": false,
"canShare": false,
"canDesign": false
}
};
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": "checkPermissions",
"params": {
"boardId": "xs:string",
"cardId": "xs:string",
"canView": false,
"canMove": false,
"canUpdate": false,
"canAdd": false,
"canShare": false,
"canDesign": false
}
};
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' => 'checkPermissions',
'params' => (object) [
'boardId' => 'xs:string',
'cardId' => 'xs:string',
'canView' => 'xs:boolean',
'canMove' => 'xs:boolean',
'canUpdate' => 'xs:boolean',
'canAdd' => 'xs:boolean',
'canShare' => 'xs:boolean',
'canDesign' => 'xs:boolean',
]
];
$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" = "checkPermissions"
params = @{
boardId = "xs:string"
cardId = "xs:string"
canView = "xs:boolean"
canMove = "xs:boolean"
canUpdate = "xs:boolean"
canAdd = "xs:boolean"
canShare = "xs:boolean"
canDesign = "xs:boolean"
}
}
$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":"checkPermissions",
"params":{
"boardId":"xs:string",
"cardId":"xs:string",
"canView":"xs:boolean",
"canMove":"xs:boolean",
"canUpdate":"xs:boolean",
"canAdd":"xs:boolean",
"canShare":"xs:boolean",
"canDesign":"xs:boolean",
},
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document