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
Share the board with a user group or role
Request Parameters
The shareBoard 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:integer |
No | Board to share |
shareId |
xs:integer |
No | Id of share record (if blank will add new share) |
permissions |
xs:integer |
No | permissions bitmask* canview = 1,* canmovecard = 2,* canupdatecard = 4,* canaddcard = 8,* canadmin = 16,* candesign = 32 |
urn |
xs:string |
No | URN of share |
name |
xs:string |
No | Name of share |
icon |
xs:string |
No | icon for share |
setOwner |
xs:string |
No | New Owner Id |
Response Parameters
No response parameters are returned.
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":"shareBoard","params":{"boardId":1,"shareId":1,"permissions":1,"urn":"xs:string","name":"xs:string","icon":"xs:string","setOwner":"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("boardId", "xs:integer")
hornbillAPI.SetParam("shareId", "xs:integer")
hornbillAPI.SetParam("permissions", "xs:integer")
hornbillAPI.SetParam("urn", "xs:string")
hornbillAPI.SetParam("name", "xs:string")
hornbillAPI.SetParam("icon", "xs:string")
hornbillAPI.SetParam("setOwner", "xs:string")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.boardmanager/Board", "shareBoard")
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": "shareBoard",
"params": {
"boardId": 1,
"shareId": 1,
"permissions": 1,
"urn": "xs:string",
"name": "xs:string",
"icon": "xs:string",
"setOwner": "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": "shareBoard",
"params": {
"boardId": 1,
"shareId": 1,
"permissions": 1,
"urn": "xs:string",
"name": "xs:string",
"icon": "xs:string",
"setOwner": "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' => 'shareBoard',
'params' => (object) [
'boardId' => 'xs:integer',
'shareId' => 'xs:integer',
'permissions' => 'xs:integer',
'urn' => 'xs:string',
'name' => 'xs:string',
'icon' => 'xs:string',
'setOwner' => '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" = "shareBoard"
params = @{
boardId = "xs:integer"
shareId = "xs:integer"
permissions = "xs:integer"
urn = "xs:string"
name = "xs:string"
icon = "xs:string"
setOwner = "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":"shareBoard",
"params":{
"boardId":"xs:integer",
"shareId":"xs:integer",
"permissions":"xs:integer",
"urn":"xs:string",
"name":"xs:string",
"icon":"xs:string",
"setOwner":"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