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:
user - Required Rights: Group A - canAddTo
Description
Remove card from board (This will not remove the card history)
Request Parameters
The removeCard 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 |
|---|---|---|---|
h_card_id |
xs:integer |
Yes | Id of card to remove |
h_lane_id |
xs:integer |
No | The final lane of the card before being removed |
fromBoard |
xs:boolean |
No | Is this added from the board |
hardDelete |
xs:boolean |
No | Will remove the card completely |
Response Parameters
No response parameters are returned.
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":"removeCard","params":{"h_card_id":1,"h_lane_id":1,"fromBoard":false,"hardDelete":false}}'
package main
import (
"fmt"
apiLib "github.com/hornbill/goApiLib"
)
func main() {
hornbillAPI := apiLib.NewXmlmcInstance("yourinstanceid")
hornbillAPI.SetAPIKey("yourHornbillAPIKey")
hornbillAPI.SetJSONResponse(true)
hornbillAPI.SetParam("h_card_id", "xs:integer")
hornbillAPI.SetParam("h_lane_id", "xs:integer")
hornbillAPI.SetParam("fromBoard", "xs:boolean")
hornbillAPI.SetParam("hardDelete", "xs:boolean")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.boardmanager/Card", "removeCard")
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": "removeCard",
"params": {
"h_card_id": 1,
"h_lane_id": 1,
"fromBoard": false,
"hardDelete": false
}
};
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": "removeCard",
"params": {
"h_card_id": 1,
"h_lane_id": 1,
"fromBoard": false,
"hardDelete": false
}
};
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' => 'removeCard',
'params' => (object) [
'h_card_id' => 'xs:integer',
'h_lane_id' => 'xs:integer',
'fromBoard' => 'xs:boolean',
'hardDelete' => 'xs:boolean',
]
];
$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" = "removeCard"
params = @{
h_card_id = "xs:integer"
h_lane_id = "xs:integer"
fromBoard = "xs:boolean"
hardDelete = "xs:boolean"
}
}
$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":"removeCard",
"params":{
"h_card_id":"xs:integer",
"h_lane_id":"xs:integer",
"fromBoard":"xs:boolean",
"hardDelete":"xs:boolean",
},
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document