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:
Global - Class:
Application - Required Privilege Level:
user - Required Rights: Group A - canMove
Description
Move a card from one position and lane to another
Request Parameters
The moveCard 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 |
|---|---|---|---|
boardId |
xs:integer |
Yes | The board Id |
cardId |
xs:integer |
Yes | The ID of the card to be moved |
laneId |
xs:integer |
Yes | The ID of lane the card has been moved too |
order |
xs:integer |
No | The position in the list this card should be inserted. Every card at this position and below will be moved down until a gap is found (if this card has been moved up this list) or to the end of the lane |
column |
xs:integer |
No | The column in the lane that the card is moved too |
Response Parameters
| Name | Type | Description |
|---|---|---|
reorder |
xs:string |
Log of the reordering |
laneChanged |
xs:boolean |
Whether the card has moved lane |
enteredOn |
xs:dateTime |
Time set for when card entered |
log |
xs:string |
Log message alerting any possible problems |
Code Examples
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.boardmanager' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.boardmanager","@method":"moveCard","params":{"boardId":1,"cardId":1,"laneId":1,"order":1,"column":1}}'
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("cardId", "xs:integer")
hornbillAPI.SetParam("laneId", "xs:integer")
hornbillAPI.SetParam("order", "xs:integer")
hornbillAPI.SetParam("column", "xs:integer")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.boardmanager", "moveCard")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.boardmanager";
const payload = {
"@service": "apps/com.hornbill.boardmanager",
"@method": "moveCard",
"params": {
"boardId": 1,
"cardId": 1,
"laneId": 1,
"order": 1,
"column": 1
}
};
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";
const payload = {
"@service": "apps/com.hornbill.boardmanager",
"@method": "moveCard",
"params": {
"boardId": 1,
"cardId": 1,
"laneId": 1,
"order": 1,
"column": 1
}
};
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";
$payload = (object) [
'@service' => 'apps/com.hornbill.boardmanager',
'@method' => 'moveCard',
'params' => (object) [
'boardId' => 'xs:integer',
'cardId' => 'xs:integer',
'laneId' => 'xs:integer',
'order' => 'xs:integer',
'column' => 'xs:integer',
]
];
$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"
$Body = @{
"@service" = "apps/com.hornbill.boardmanager"
"@method" = "moveCard"
params = @{
boardId = "xs:integer"
cardId = "xs:integer"
laneId = "xs:integer"
order = "xs:integer"
column = "xs:integer"
}
}
$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"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.boardmanager",
"@method":"moveCard",
"params":{
"boardId":"xs:integer",
"cardId":"xs:integer",
"laneId":"xs:integer",
"order":"xs:integer",
"column":"xs:integer",
},
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document