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 - Requests - Class:
Entity - Required Privilege Level:
guest - Required Rights: none
Description
This operation posts an update to a Request's Timeline.
Request Parameters
The updateReqTimeline 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 | This parameter must be set with the Id of a Request. |
action |
xs:string |
No | This parameter is deprecated. |
source |
xs:string |
No | This parameter is deprecated. |
content |
xs:string |
Yes | This parameter must be set with the content of the Timeline entry. |
extra |
xs:string |
No | A JSON structure representing additional content for the Timeline entry. |
visibility |
xs:string |
No | This parameter must be set with the visibility of the Timeline entry. The options are public, trustedGuest, colleague, manager and owner. |
imageUrl |
xs:string |
No | This parameter can be set with the URL of an image that is associated to the Timeline entry. |
activityType |
xs:string |
No | This parameter can be set with activity type that is associated to the Timeline entry. For example, "System" is used for generic updates. |
skipBpm |
xs:boolean |
No | This parameter determines whether the Request's process is resumed following the Timeline update. By default, this parameter is set to "false". |
Response Parameters
| Name | Type | Description |
|---|---|---|
outcome |
xs:string |
This parameter is set with the outcome of the operation. The options are "success" and "failure". |
activityId |
xs:string |
This parameter is set with the activity Id that is generated after posting a new Timeline entry. |
exceptionName |
xs:string |
This parameter captures any validation errors. The options are "failedTimelinePost" and "failedTimelineImagePost". |
exceptionDescription |
xs:string |
This parameter will be set with an exception's description, thrown by an API. |
Code Examples
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/Requests' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.servicemanager/Requests","@method":"updateReqTimeline","params":{"requestId":"xs:string","action":"xs:string","source":"xs:string","content":"xs:string","extra":"xs:string","visibility":"xs:string","imageUrl":"xs:string","activityType":"xs:string","skipBpm":false}}'
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("action", "xs:string")
hornbillAPI.SetParam("source", "xs:string")
hornbillAPI.SetParam("content", "xs:string")
hornbillAPI.SetParam("extra", "xs:string")
hornbillAPI.SetParam("visibility", "xs:string")
hornbillAPI.SetParam("imageUrl", "xs:string")
hornbillAPI.SetParam("activityType", "xs:string")
hornbillAPI.SetParam("skipBpm", "xs:boolean")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.servicemanager/Requests", "updateReqTimeline")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/Requests";
const payload = {
"@service": "apps/com.hornbill.servicemanager/Requests",
"@method": "updateReqTimeline",
"params": {
"requestId": "xs:string",
"action": "xs:string",
"source": "xs:string",
"content": "xs:string",
"extra": "xs:string",
"visibility": "xs:string",
"imageUrl": "xs:string",
"activityType": "xs:string",
"skipBpm": 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.servicemanager/Requests";
const payload = {
"@service": "apps/com.hornbill.servicemanager/Requests",
"@method": "updateReqTimeline",
"params": {
"requestId": "xs:string",
"action": "xs:string",
"source": "xs:string",
"content": "xs:string",
"extra": "xs:string",
"visibility": "xs:string",
"imageUrl": "xs:string",
"activityType": "xs:string",
"skipBpm": 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.servicemanager/Requests";
$payload = (object) [
'@service' => 'apps/com.hornbill.servicemanager/Requests',
'@method' => 'updateReqTimeline',
'params' => (object) [
'requestId' => 'xs:string',
'action' => 'xs:string',
'source' => 'xs:string',
'content' => 'xs:string',
'extra' => 'xs:string',
'visibility' => 'xs:string',
'imageUrl' => 'xs:string',
'activityType' => 'xs:string',
'skipBpm' => '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.servicemanager/Requests"
$Body = @{
"@service" = "apps/com.hornbill.servicemanager/Requests"
"@method" = "updateReqTimeline"
params = @{
requestId = "xs:string"
action = "xs:string"
source = "xs:string"
content = "xs:string"
extra = "xs:string"
visibility = "xs:string"
imageUrl = "xs:string"
activityType = "xs:string"
skipBpm = "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.servicemanager/Requests"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.servicemanager/Requests",
"@method":"updateReqTimeline",
"params":{
"requestId":"xs:string",
"action":"xs:string",
"source":"xs:string",
"content":"xs:string",
"extra":"xs:string",
"visibility":"xs:string",
"imageUrl":"xs:string",
"activityType":"xs:string",
"skipBpm":"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