Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

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!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Common / Get Request Details

  • Article
  • 3 minutes to read

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 None provided
Activity Stream ID activity_stream_id string None provided
Archived archived string None provided
BPM Authorised bpm_authorised string None provided
BPM Stage Expired bpm_stage_expired string None provided
BPM UI State bpm_ui_state string None provided
Catalog catalog string None provided
Catalog ID catalog_id string None provided
Created By createdby string None provided
Customer Type customer_type string None provided
Date Last Modified datelastmodified string None provided
Last Modified User ID lastmodifieduserid string None provided
Last Modified User Name lastmodifiedusername string None provided
Last Modified User Type lastmodifiedusertype string None provided
Last Modified Type lastmodifiedtype string None provided
Date Logged datelogged string None provided
Description description string None provided
External Reference Number external_ref_number string None provided
Feedback Status feedback_status string None provided
Service ID serviceid string None provided
Service Name servicename string None provided
Team ID team_id string None provided
Team Name team_name string None provided
Is Analyst Unread isanalystunread string None provided
Last Update Activity ID last_update_activity_id string None provided
Organization ID org_id string None provided
OwnerID ownerid string None provided
Owner Name ownername string None provided
Reopen Count reopencount string None provided
Request Language request_language string None provided
Request Type requesttype string None provided
Request Status requestStatus string None provided
Summary summary string None provided
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document