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 resolves a Request.
Request Parameters
The resolveRequest 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 contain Id of a Request. |
resolutionText |
xs:string |
Yes | This parameter must contain the resolution text for a Request. |
resolutionLanguage |
xs:string |
No | This parameter contains the resolution language of a Request. |
closureCategoryId |
xs:string |
No | This parameter can contain Id of a Closure Category. |
closureCategoryName |
xs:string |
No | This parameter can contain the display name of a Closure Category. You no longer need to supply this param. |
updateTimelineInputs |
xs:string |
No | This parameter can contain the options that will be used to post an update in the Timeline. This must be supplied as a JSON Object in form of a String. Properties includeactivityType, updateText, source, postType and visibility. |
Response Parameters
| Name | Type | Description |
|---|---|---|
activityId |
xs:string |
This parameter captures activity Id for the post to the Timeline. |
exceptionName |
xs:string |
This parameter returns validation error code. The options are "notAllowedToResolveRequest", "requestAlreadyResolved", "failedToGetTask", "requestHasTasks" and "failedToGetTask". |
exceptionDescription |
xs:string |
This parameter returns validation error description. |
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":"resolveRequest","params":{"requestId":"xs:string","resolutionText":"xs:string","resolutionLanguage":"xs:string","closureCategoryId":"xs:string","closureCategoryName":"xs:string","updateTimelineInputs":"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("resolutionText", "xs:string")
hornbillAPI.SetParam("resolutionLanguage", "xs:string")
hornbillAPI.SetParam("closureCategoryId", "xs:string")
hornbillAPI.SetParam("closureCategoryName", "xs:string")
hornbillAPI.SetParam("updateTimelineInputs", "xs:string")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.servicemanager/Requests", "resolveRequest")
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": "resolveRequest",
"params": {
"requestId": "xs:string",
"resolutionText": "xs:string",
"resolutionLanguage": "xs:string",
"closureCategoryId": "xs:string",
"closureCategoryName": "xs:string",
"updateTimelineInputs": "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/Requests";
const payload = {
"@service": "apps/com.hornbill.servicemanager/Requests",
"@method": "resolveRequest",
"params": {
"requestId": "xs:string",
"resolutionText": "xs:string",
"resolutionLanguage": "xs:string",
"closureCategoryId": "xs:string",
"closureCategoryName": "xs:string",
"updateTimelineInputs": "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/Requests";
$payload = (object) [
'@service' => 'apps/com.hornbill.servicemanager/Requests',
'@method' => 'resolveRequest',
'params' => (object) [
'requestId' => 'xs:string',
'resolutionText' => 'xs:string',
'resolutionLanguage' => 'xs:string',
'closureCategoryId' => 'xs:string',
'closureCategoryName' => 'xs:string',
'updateTimelineInputs' => '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/Requests"
$Body = @{
"@service" = "apps/com.hornbill.servicemanager/Requests"
"@method" = "resolveRequest"
params = @{
requestId = "xs:string"
resolutionText = "xs:string"
resolutionLanguage = "xs:string"
closureCategoryId = "xs:string"
closureCategoryName = "xs:string"
updateTimelineInputs = "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/Requests"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.servicemanager/Requests",
"@method":"resolveRequest",
"params":{
"requestId":"xs:string",
"resolutionText":"xs:string",
"resolutionLanguage":"xs:string",
"closureCategoryId":"xs:string",
"closureCategoryName":"xs:string",
"updateTimelineInputs":"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