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:
none - Required Rights: Group A - canView
Description
Update the Board
Request Parameters
The updateBoard 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 |
Yes | Id of board |
name |
xs:string |
No | Board name |
description |
xs:string |
No | Description of board |
allowedTypes |
xs:string |
No | Allowed Types on board |
application |
xs:string |
No | Designate this is an application board for the specified |
urn |
xs:string |
No | Designate that this board is for the object with this URN |
archived |
xs:integer |
No | Set the archive flag |
config |
xs:string |
No | JSON containing extra config for the board |
Response Parameters
| Name | Type | Description |
|---|---|---|
data |
xs:string |
data |
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":"updateBoard","params":{"boardId":"xs:string","name":"xs:string","description":"xs:string","allowedTypes":"xs:string","application":"xs:string","urn":"xs:string","archived":1,"config":"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:string")
hornbillAPI.SetParam("name", "xs:string")
hornbillAPI.SetParam("description", "xs:string")
hornbillAPI.SetParam("allowedTypes", "xs:string")
hornbillAPI.SetParam("application", "xs:string")
hornbillAPI.SetParam("urn", "xs:string")
hornbillAPI.SetParam("archived", "xs:integer")
hornbillAPI.SetParam("config", "xs:string")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.boardmanager/Board", "updateBoard")
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": "updateBoard",
"params": {
"boardId": "xs:string",
"name": "xs:string",
"description": "xs:string",
"allowedTypes": "xs:string",
"application": "xs:string",
"urn": "xs:string",
"archived": 1,
"config": "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": "updateBoard",
"params": {
"boardId": "xs:string",
"name": "xs:string",
"description": "xs:string",
"allowedTypes": "xs:string",
"application": "xs:string",
"urn": "xs:string",
"archived": 1,
"config": "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' => 'updateBoard',
'params' => (object) [
'boardId' => 'xs:string',
'name' => 'xs:string',
'description' => 'xs:string',
'allowedTypes' => 'xs:string',
'application' => 'xs:string',
'urn' => 'xs:string',
'archived' => 'xs:integer',
'config' => '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" = "updateBoard"
params = @{
boardId = "xs:string"
name = "xs:string"
description = "xs:string"
allowedTypes = "xs:string"
application = "xs:string"
urn = "xs:string"
archived = "xs:integer"
config = "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":"updateBoard",
"params":{
"boardId":"xs:string",
"name":"xs:string",
"description":"xs:string",
"allowedTypes":"xs:string",
"application":"xs:string",
"urn":"xs:string",
"archived":"xs:integer",
"config":"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