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}}

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?

What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{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 / Update Request Fields

  • Article
  • 4 minutes to read

Operation Information

Updates fields against 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 being updated Yes None provided
Summary summary string None provided No None provided
Description description string None provided No None provided
External Reference Number external_ref_number string None provided No None provided
Custom A custom_a string None provided No None provided
Custom B custom_b string None provided No None provided
Custom C custom_c string None provided No None provided
Custom D custom_d string None provided No None provided
Custom E custom_e string None provided No None provided
Custom F custom_f string None provided No None provided
Custom G custom_g string None provided No None provided
Custom H custom_h string None provided No None provided
Custom I custom_i string None provided No None provided
Custom J custom_j string None provided No None provided
Custom K custom_k string None provided No None provided
Custom L custom_l string None provided No None provided
Custom M custom_m string None provided No None provided
Custom N custom_n string None provided No None provided
Custom O custom_o string None provided No None provided
Custom P custom_p string None provided No None provided
Custom Q custom_q string None provided No None provided
Custom R custom_r string None provided No None provided
Custom S custom_s string None provided No None provided
Custom T custom_t string None provided No None provided
Custom 21 custom_21 string Date/Time type field No None provided
Custom 22 custom_22 string Date/Time type field No None provided
Custom 23 custom_23 string Date/Time type field No None provided
Custom 24 custom_24 string Date/Time type field No None provided
Custom 25 custom_25 string Date/Time type field No None provided
Custom 26 custom_26 integer Integer type field No None provided
Custom 27 custom_27 integer Integer type field No None provided
Custom 28 custom_28 integer Integer type field No None provided
Custom 29 custom_29 integer Integer type field No None provided
Custom 30 custom_30 integer Integer type field No None provided
Custom 31 custom_31 string None provided No None provided
Custom 32 custom_32 string None provided No None provided
Custom 33 custom_33 string None provided No None provided
Custom 34 custom_34 string None provided No None provided
Custom 35 custom_35 string None provided No None provided
Custom 36 custom_36 string None provided No None provided
Custom 37 custom_37 string None provided No None provided
Custom 38 custom_38 string None provided No None provided
Custom 39 custom_39 string None provided No None provided
Custom 40 custom_40 string None provided No 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
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document