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 - Card - Class:
Entity - Required Privilege Level:
none - Required Rights: Group A - canView
Description
Flowcode to write board timeline entries
Request Parameters
The timelineEntry 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 |
|---|---|---|---|
messageType |
xs:string |
Yes | The id for the message to add to the timeline one of:* cardAdded* cardRemoved* cardMoved* cardUpdated* memberAdded* memberRemoved |
cardId |
xs:integer |
Yes | Card id (generate the link to replace in %C) |
cardTitle |
xs:string |
No | The title of the card (replaces %C in string) |
boardId |
xs:integer |
No | Id of the board (%B) |
laneId |
xs:integer |
No | Id of the lane (%L) |
columnId |
xs:integer |
No | Column Id |
userId |
xs:string |
No | userId (%U link) |
userName |
xs:string |
No | User name (%U) |
position |
xs:string |
No | Position of card |
filename |
xs:string |
No | attached filename |
imageUrl |
xs:string |
No | image to be attached to the post |
Response Parameters
| Name | Type | Description |
|---|---|---|
boardId |
xs:integer |
Id of the board |
activityUrn |
xs:string |
The URN of the activity |
Code Examples
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.boardmanager/Card' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.boardmanager/Card","@method":"timelineEntry","params":{"messageType":"xs:string","cardId":1,"cardTitle":"xs:string","boardId":1,"laneId":1,"columnId":1,"userId":"xs:string","userName":"xs:string","position":"xs:string","filename":"xs:string","imageUrl":"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("messageType", "xs:string")
hornbillAPI.SetParam("cardId", "xs:integer")
hornbillAPI.SetParam("cardTitle", "xs:string")
hornbillAPI.SetParam("boardId", "xs:integer")
hornbillAPI.SetParam("laneId", "xs:integer")
hornbillAPI.SetParam("columnId", "xs:integer")
hornbillAPI.SetParam("userId", "xs:string")
hornbillAPI.SetParam("userName", "xs:string")
hornbillAPI.SetParam("position", "xs:string")
hornbillAPI.SetParam("filename", "xs:string")
hornbillAPI.SetParam("imageUrl", "xs:string")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.boardmanager/Card", "timelineEntry")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.boardmanager/Card";
const payload = {
"@service": "apps/com.hornbill.boardmanager/Card",
"@method": "timelineEntry",
"params": {
"messageType": "xs:string",
"cardId": 1,
"cardTitle": "xs:string",
"boardId": 1,
"laneId": 1,
"columnId": 1,
"userId": "xs:string",
"userName": "xs:string",
"position": "xs:string",
"filename": "xs:string",
"imageUrl": "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/Card";
const payload = {
"@service": "apps/com.hornbill.boardmanager/Card",
"@method": "timelineEntry",
"params": {
"messageType": "xs:string",
"cardId": 1,
"cardTitle": "xs:string",
"boardId": 1,
"laneId": 1,
"columnId": 1,
"userId": "xs:string",
"userName": "xs:string",
"position": "xs:string",
"filename": "xs:string",
"imageUrl": "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/Card";
$payload = (object) [
'@service' => 'apps/com.hornbill.boardmanager/Card',
'@method' => 'timelineEntry',
'params' => (object) [
'messageType' => 'xs:string',
'cardId' => 'xs:integer',
'cardTitle' => 'xs:string',
'boardId' => 'xs:integer',
'laneId' => 'xs:integer',
'columnId' => 'xs:integer',
'userId' => 'xs:string',
'userName' => 'xs:string',
'position' => 'xs:string',
'filename' => 'xs:string',
'imageUrl' => '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/Card"
$Body = @{
"@service" = "apps/com.hornbill.boardmanager/Card"
"@method" = "timelineEntry"
params = @{
messageType = "xs:string"
cardId = "xs:integer"
cardTitle = "xs:string"
boardId = "xs:integer"
laneId = "xs:integer"
columnId = "xs:integer"
userId = "xs:string"
userName = "xs:string"
position = "xs:string"
filename = "xs:string"
imageUrl = "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/Card"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.boardmanager/Card",
"@method":"timelineEntry",
"params":{
"messageType":"xs:string",
"cardId":"xs:integer",
"cardTitle":"xs:string",
"boardId":"xs:integer",
"laneId":"xs:integer",
"columnId":"xs:integer",
"userId":"xs:string",
"userName":"xs:string",
"position":"xs:string",
"filename":"xs:string",
"imageUrl":"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