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.servicemanager - Scope:
Entity - Releases - Class:
Entity - Required Privilege Level:
user - Required Rights: Group C - updateReleases
Description
Operation to unschedule the Release
Request Parameters
The unSchedule 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 |
|---|---|---|---|
requestId |
xs:string |
Yes | The ID of the request |
updateText |
xs:string |
No | The update text to appear in the timeline |
activityType |
xs:string |
No | The activity type for the activity stream |
source |
xs:string |
No | The source |
postType |
xs:string |
No | The post type |
visibility |
xs:string |
No | The visibility level |
Response Parameters
No response parameters are returned.
Code Examples
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/Releases' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.servicemanager/Releases","@method":"unSchedule","params":{"requestId":"xs:string","updateText":"xs:string","activityType":"xs:string","source":"xs:string","postType":"xs:string","visibility":"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("requestId", "xs:string")
hornbillAPI.SetParam("updateText", "xs:string")
hornbillAPI.SetParam("activityType", "xs:string")
hornbillAPI.SetParam("source", "xs:string")
hornbillAPI.SetParam("postType", "xs:string")
hornbillAPI.SetParam("visibility", "xs:string")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.servicemanager/Releases", "unSchedule")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/Releases";
const payload = {
"@service": "apps/com.hornbill.servicemanager/Releases",
"@method": "unSchedule",
"params": {
"requestId": "xs:string",
"updateText": "xs:string",
"activityType": "xs:string",
"source": "xs:string",
"postType": "xs:string",
"visibility": "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.servicemanager/Releases";
const payload = {
"@service": "apps/com.hornbill.servicemanager/Releases",
"@method": "unSchedule",
"params": {
"requestId": "xs:string",
"updateText": "xs:string",
"activityType": "xs:string",
"source": "xs:string",
"postType": "xs:string",
"visibility": "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.servicemanager/Releases";
$payload = (object) [
'@service' => 'apps/com.hornbill.servicemanager/Releases',
'@method' => 'unSchedule',
'params' => (object) [
'requestId' => 'xs:string',
'updateText' => 'xs:string',
'activityType' => 'xs:string',
'source' => 'xs:string',
'postType' => 'xs:string',
'visibility' => '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.servicemanager/Releases"
$Body = @{
"@service" = "apps/com.hornbill.servicemanager/Releases"
"@method" = "unSchedule"
params = @{
requestId = "xs:string"
updateText = "xs:string"
activityType = "xs:string"
source = "xs:string"
postType = "xs:string"
visibility = "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.servicemanager/Releases"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.servicemanager/Releases",
"@method":"unSchedule",
"params":{
"requestId":"xs:string",
"updateText":"xs:string",
"activityType":"xs:string",
"source":"xs:string",
"postType":"xs:string",
"visibility":"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