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 - canCreate
Description
Create a board from template and set its activitystream
Request Parameters
The createBoardFromTemplate 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 |
|---|---|---|---|
name |
xs:string |
Yes | Name of the board |
description |
xs:string |
No | The description of the board |
application |
xs:string |
No | Application that the board belongs too |
templateId |
xs:string |
No | The id of the template |
allowedType |
xs:string |
No | Comma seperated list of allowed types (if none then all types allowed) |
config |
xs:string |
No | JSON containing extra config for the board |
automations |
xs:string |
No | JSON containing extra automations for the board |
urn |
xs:string |
No | URN to filter the board by |
bpm |
xs:string |
No | BPM Name for this Board |
Response Parameters
| Name | Type | Description |
|---|---|---|
BoardData |
xs:string |
Data of the board created |
LaneData |
xs:string |
Data of the lanes of the board |
ShareData |
xs:string |
Data of the shares of the board |
TagsData |
xs:string |
Data of the tags of 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":"createBoardFromTemplate","params":{"name":"xs:string","description":"xs:string","application":"xs:string","templateId":"xs:string","allowedType":"xs:string","config":"xs:string","automations":"xs:string","urn":"xs:string","bpm":"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("name", "xs:string")
hornbillAPI.SetParam("description", "xs:string")
hornbillAPI.SetParam("application", "xs:string")
hornbillAPI.SetParam("templateId", "xs:string")
hornbillAPI.SetParam("allowedType", "xs:string")
hornbillAPI.SetParam("config", "xs:string")
hornbillAPI.SetParam("automations", "xs:string")
hornbillAPI.SetParam("urn", "xs:string")
hornbillAPI.SetParam("bpm", "xs:string")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.boardmanager/Board", "createBoardFromTemplate")
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": "createBoardFromTemplate",
"params": {
"name": "xs:string",
"description": "xs:string",
"application": "xs:string",
"templateId": "xs:string",
"allowedType": "xs:string",
"config": "xs:string",
"automations": "xs:string",
"urn": "xs:string",
"bpm": "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": "createBoardFromTemplate",
"params": {
"name": "xs:string",
"description": "xs:string",
"application": "xs:string",
"templateId": "xs:string",
"allowedType": "xs:string",
"config": "xs:string",
"automations": "xs:string",
"urn": "xs:string",
"bpm": "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' => 'createBoardFromTemplate',
'params' => (object) [
'name' => 'xs:string',
'description' => 'xs:string',
'application' => 'xs:string',
'templateId' => 'xs:string',
'allowedType' => 'xs:string',
'config' => 'xs:string',
'automations' => 'xs:string',
'urn' => 'xs:string',
'bpm' => '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" = "createBoardFromTemplate"
params = @{
name = "xs:string"
description = "xs:string"
application = "xs:string"
templateId = "xs:string"
allowedType = "xs:string"
config = "xs:string"
automations = "xs:string"
urn = "xs:string"
bpm = "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":"createBoardFromTemplate",
"params":{
"name":"xs:string",
"description":"xs:string",
"application":"xs:string",
"templateId":"xs:string",
"allowedType":"xs:string",
"config":"xs:string",
"automations":"xs:string",
"urn":"xs:string",
"bpm":"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