How can we help?
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
Retrieves information about a request in Hornbill Service Manager.
This is a Free Tier Integration.
Authentication
This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Hornbill Authentication.
To create a key of this type:
- In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
- Click on the + Create New Key button;
- On the resulting Create New Key form, choose Hornbill Authentication in the Type pick list;
- Give the Hornbill Authentication KeySafe key a Title (this is the name / identifier for the Hornbill Authentication account as you will see it when using the cloud automation node in your workflows);
- Optionally populate the Description field;
- Populate the following fields accordingly, then click the Create Key button to create your new key:
Name | Type | Description |
---|---|---|
Instance ID or URL | string |
Hornbill Instance ID or API Endpoint URL |
ApiKey | string |
Authentication Key |
Tip
Please read the Hornbill API Keys documentation to learn how to create and manage API Keys on the Hornbill platform.
Revoking Access
If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.
Warning
This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Hornbill Authentication account, so you will need to manage these workflows accordingly.
Input Parameters
Display Name | ID | Type | Description | Required | Supported Values |
---|---|---|---|---|---|
Request Reference | requestId |
string |
Reference of the request | Yes | None provided |
Output Parameters
Display Name | ID | Type | Description |
---|---|---|---|
Status | status |
string |
The status of the integration, ok/failed |
Error | error |
string |
Any returned error |
Reference | reference |
string |
The reference of the request |
Activity Stream ID | activity_stream_id |
string |
The activity stream ID |
Archived | archived |
string |
A true or false statement on if the request has been archived |
BPM Authorised | bpm_authorised |
string |
Showcases if the request is bpm authorised |
BPM Stage Expired | bpm_stage_expired |
string |
Shows at what point the BPM stage has expired |
BPM UI State | bpm_ui_state |
string |
The state of the BPM UI at the time of retrieval |
Catalog | catalog |
string |
The catalog associated with the get request |
Catalog ID | catalog_id |
string |
The ID of the catalog associated with the request |
Created By | createdby |
string |
The user who created the request |
Customer Type | customer_type |
string |
The customer type returned by the request |
Date Last Modified | datelastmodified |
string |
The date of last modification returned by the request |
Last Modified User ID | lastmodifieduserid |
string |
The ID of the user that performed the last modification |
Last Modified User Name | lastmodifiedusername |
string |
The name of the user that performed the last modification |
Last Modified User Type | lastmodifiedusertype |
string |
The user type that performed the last modification |
Last Modified Type | lastmodifiedtype |
string |
The type of modification that was made |
Date Logged | datelogged |
string |
The date time the request was logged at |
Description | description |
string |
Any further information about the request |
External Reference Number | external_ref_number |
string |
The external reference number that relates to the request |
Feedback Status | feedback_status |
string |
The status of the feedback assocaited with the request |
Service ID | serviceid |
string |
The ID of the service associated with the request |
Service Name | servicename |
string |
The service name assocaited with the request |
Team ID | team_id |
string |
The ID of the team associated with the request |
Team Name | team_name |
string |
The name of the team associated with the request |
Is Analyst Unread | isanalystunread |
string |
States of the analysis has been left unread |
Last Update Activity ID | last_update_activity_id |
string |
The ID of the last activity update |
Organization ID | org_id |
string |
The organization ID associated with the request |
OwnerID | ownerid |
string |
The ID of the request owner |
Owner Name | ownername |
string |
The name of the owner of the request |
Reopen Count | reopencount |
string |
A count of the number of times this request was reopened |
Request Language | request_language |
string |
The language the request was made in |
Request Type | requesttype |
string |
The type of request at the time of retrieval |
Request Status | requestStatus |
string |
The status of the request at the time of retrieval |
Summary | summary |
string |
The summary of the request |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}