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 / assign
- Article
- 3 minutes to read
Operation Information
- Application Reference:
com.hornbill.servicemanager - Scope:
Entity - Requests - Class:
Entity - Required Privilege Level:
guest - Required Rights: none
Description
This operation assigns a Request to a team or a team member.
Request Parameters
The assign 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 |
|---|---|---|---|
inReference |
xs:string |
Yes | The request that is being assigned |
inAssignToId |
xs:string |
No | The analyst id of who the request is being assigned to |
inAssignToGroupId |
xs:string |
Yes | The Group the request is being assigned to |
returnAfterAssignment |
xs:string |
No | This param is used when we want the flowcode to return after the assignment operation (i.e. skip resumong the BPM, updateing the timeline and send notifications). This param is false by default. It is used when we invoke this flowcode from a BPM process: in this case, we don't need to resume any BPM, and the flowcode related to the BPM process will write his own message on the timeline and post notifications. |
updateTimelineInputs |
xs:string |
No | A JSON formatted string, containing information that will be used to update the Request Timeline. This includes activityType, updateText, source, postType and visibility. |
accessToken |
xs:string |
No | System use only. |
Response Parameters
| Name | Type | Description |
|---|---|---|
assignToSameOwner |
xs:string |
Populated if the request is assigned to the same owner. |
requestId |
xs:string |
The request that is being assigned |
assignError |
xs:string |
Populated with an error if the intended Owner or Team does not exist |
teamName |
xs:string |
The name of the team the request has been assigned to |
ownerName |
xs:string |
The name of the user the request has been assigned to |
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":"assign","params":{"inReference":"xs:string","inAssignToId":"xs:string","inAssignToGroupId":"xs:string","returnAfterAssignment":"xs:string","updateTimelineInputs":"xs:string","accessToken":"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("inReference", "xs:string")
hornbillAPI.SetParam("inAssignToId", "xs:string")
hornbillAPI.SetParam("inAssignToGroupId", "xs:string")
hornbillAPI.SetParam("returnAfterAssignment", "xs:string")
hornbillAPI.SetParam("updateTimelineInputs", "xs:string")
hornbillAPI.SetParam("accessToken", "xs:string")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.servicemanager/Requests", "assign")
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": "assign",
"params": {
"inReference": "xs:string",
"inAssignToId": "xs:string",
"inAssignToGroupId": "xs:string",
"returnAfterAssignment": "xs:string",
"updateTimelineInputs": "xs:string",
"accessToken": "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": "assign",
"params": {
"inReference": "xs:string",
"inAssignToId": "xs:string",
"inAssignToGroupId": "xs:string",
"returnAfterAssignment": "xs:string",
"updateTimelineInputs": "xs:string",
"accessToken": "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' => 'assign',
'params' => (object) [
'inReference' => 'xs:string',
'inAssignToId' => 'xs:string',
'inAssignToGroupId' => 'xs:string',
'returnAfterAssignment' => 'xs:string',
'updateTimelineInputs' => 'xs:string',
'accessToken' => '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" = "assign"
params = @{
inReference = "xs:string"
inAssignToId = "xs:string"
inAssignToGroupId = "xs:string"
returnAfterAssignment = "xs:string"
updateTimelineInputs = "xs:string"
accessToken = "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":"assign",
"params":{
"inReference":"xs:string",
"inAssignToId":"xs:string",
"inAssignToGroupId":"xs:string",
"returnAfterAssignment":"xs:string",
"updateTimelineInputs":"xs:string",
"accessToken":"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