Connect an AI assistant
Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.
The catalog did not load. Refresh the page to try again.
Loading…
{{server.name}}
{{server.summary}}
{{server.documentCount.toLocaleString()}} pages Not published to this site
- Name
-
{{server.name}} - URL
-
{{mcpServerUrl(server.path)}}
| Tool | What it does |
|---|---|
{{tool.name}} |
{{part.text}}{{part.text}} |
How can we help?
{{docApp.searchError}}
{{product.name}}
Searching in {{docApp.searchFilterBySpecificBookTitle}}
Searching for:
{{docApp.searchResultFilteredItems.length}} results for:
{{docApp.currentResultsSearchText}}
in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown.
Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.
You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
-
{{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Entity API / schedule
- Article
- 3 minutes to read
Operation Information
- Application Reference:
com.hornbill.servicemanager - Scope:
Entity - Releases - Class:
Entity - Required Privilege Level:
user - Required Rights: Group C - updateReleases
Description
Schedule a Release
Request Parameters
The schedule 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 |
|---|---|---|---|
requestId |
xs:string |
Yes | The ID of the request |
taskFromDate |
xs:dateTime |
Yes | Schedule date from |
taskToDate |
xs:dateTime |
Yes | Schedule date to |
updateText |
xs:string |
No | Text to appear in the timeline |
activityType |
xs:string |
No | The activity type to appear in the timeline |
source |
xs:string |
No | The source of the update |
postType |
xs:string |
No | The type of the post |
visibility |
xs:string |
No | The visibility level |
extra |
xs:string |
No | The extra info passed to the activity stream |
Response Parameters
| Name | Type | Description |
|---|---|---|
exceptionName |
xs:string |
The name / code of any exception thrown during the schedule of the change request. |
exceptionDescription |
xs:string |
A description of any exception thrown during the schedule of the change request. |
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":"schedule","params":{"requestId":"xs:string","taskFromDate":"xs:dateTime","taskToDate":"xs:dateTime","updateText":"xs:string","activityType":"xs:string","source":"xs:string","postType":"xs:string","visibility":"xs:string","extra":"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("taskFromDate", "xs:dateTime")
hornbillAPI.SetParam("taskToDate", "xs:dateTime")
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")
hornbillAPI.SetParam("extra", "xs:string")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.servicemanager/Releases", "schedule")
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": "schedule",
"params": {
"requestId": "xs:string",
"taskFromDate": "xs:dateTime",
"taskToDate": "xs:dateTime",
"updateText": "xs:string",
"activityType": "xs:string",
"source": "xs:string",
"postType": "xs:string",
"visibility": "xs:string",
"extra": "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": "schedule",
"params": {
"requestId": "xs:string",
"taskFromDate": "xs:dateTime",
"taskToDate": "xs:dateTime",
"updateText": "xs:string",
"activityType": "xs:string",
"source": "xs:string",
"postType": "xs:string",
"visibility": "xs:string",
"extra": "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' => 'schedule',
'params' => (object) [
'requestId' => 'xs:string',
'taskFromDate' => 'xs:dateTime',
'taskToDate' => 'xs:dateTime',
'updateText' => 'xs:string',
'activityType' => 'xs:string',
'source' => 'xs:string',
'postType' => 'xs:string',
'visibility' => 'xs:string',
'extra' => '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" = "schedule"
params = @{
requestId = "xs:string"
taskFromDate = "xs:dateTime"
taskToDate = "xs:dateTime"
updateText = "xs:string"
activityType = "xs:string"
source = "xs:string"
postType = "xs:string"
visibility = "xs:string"
extra = "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":"schedule",
"params":{
"requestId":"xs:string",
"taskFromDate":"xs:dateTime",
"taskToDate":"xs:dateTime",
"updateText":"xs:string",
"activityType":"xs:string",
"source":"xs:string",
"postType":"xs:string",
"visibility":"xs:string",
"extra":"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