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:
user - Required Rights: none
Description
This operation returns the details of a Request and , optionally, the related entities
Request Parameters
The getRequestRecord 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 | This parameter must contain the Id of a Request. |
formatValues |
xs:boolean |
No | Boolean value: see API data::entityGetRecord for details |
returnRawValues |
xs:boolean |
No | Boolean value: see API data::entityGetRecord for details |
returnMeta |
xs:boolean |
No | Boolean value: see API data::entityGetRecord for details |
returnRelatedData |
xs:boolean |
No | Boolean value: see API data::entityGetRecord for details |
returnOneToManyData |
xs:boolean |
No | Boolean value: see API data::entityGetRecord for details |
returnActivityStreamAccessToken |
xs:boolean |
No | Boolean value: see API data::entityGetRecord for details |
Response Parameters
| Name | Type | Description |
|---|---|---|
primaryEntityData |
xs:string |
This output parameter returns the primary entity data for the request. |
relatedEntityData |
xs:string |
This output parameter returns the related entity data for the request. |
visibilityLevel |
xs:string |
This output parameter returns the visibility level the current user has |
accessToken |
xs:string |
This output parameter returns the access token for the request. |
exceptionName |
xs:string |
This output parameter captures validation errors. The options are("notAllowedToView"). |
exceptionDescription |
xs:string |
The description of the exception, if any exception occurs |
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":"getRequestRecord","params":{"requestId":"xs:string","formatValues":false,"returnRawValues":false,"returnMeta":false,"returnRelatedData":false,"returnOneToManyData":false,"returnActivityStreamAccessToken":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("formatValues", "xs:boolean")
hornbillAPI.SetParam("returnRawValues", "xs:boolean")
hornbillAPI.SetParam("returnMeta", "xs:boolean")
hornbillAPI.SetParam("returnRelatedData", "xs:boolean")
hornbillAPI.SetParam("returnOneToManyData", "xs:boolean")
hornbillAPI.SetParam("returnActivityStreamAccessToken", "xs:boolean")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.servicemanager/Requests", "getRequestRecord")
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": "getRequestRecord",
"params": {
"requestId": "xs:string",
"formatValues": false,
"returnRawValues": false,
"returnMeta": false,
"returnRelatedData": false,
"returnOneToManyData": false,
"returnActivityStreamAccessToken": 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": "getRequestRecord",
"params": {
"requestId": "xs:string",
"formatValues": false,
"returnRawValues": false,
"returnMeta": false,
"returnRelatedData": false,
"returnOneToManyData": false,
"returnActivityStreamAccessToken": 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' => 'getRequestRecord',
'params' => (object) [
'requestId' => 'xs:string',
'formatValues' => 'xs:boolean',
'returnRawValues' => 'xs:boolean',
'returnMeta' => 'xs:boolean',
'returnRelatedData' => 'xs:boolean',
'returnOneToManyData' => 'xs:boolean',
'returnActivityStreamAccessToken' => '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" = "getRequestRecord"
params = @{
requestId = "xs:string"
formatValues = "xs:boolean"
returnRawValues = "xs:boolean"
returnMeta = "xs:boolean"
returnRelatedData = "xs:boolean"
returnOneToManyData = "xs:boolean"
returnActivityStreamAccessToken = "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":"getRequestRecord",
"params":{
"requestId":"xs:string",
"formatValues":"xs:boolean",
"returnRawValues":"xs:boolean",
"returnMeta":"xs:boolean",
"returnRelatedData":"xs:boolean",
"returnOneToManyData":"xs:boolean",
"returnActivityStreamAccessToken":"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