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

Request Type Specific / Update Release Fields

  • Article
  • 3 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 h_fk_reference string Reference of the request being updated Yes None provided
Start time h_start_time string The date time of the start of a release No None provided
End time h_end_time string The date time of the end of a release No None provided
Release Type h_release_type string The release type No None provided
Scheduled h_scheduled string States if a release is scheduled No None provided
Release Category h_release_category string The category of a release No None provided
Proposed start time h_proposed_start_time string The proposed date time of a release No None provided
Proposed end time h_proposed_end_time string The proposed date time of the end of a release No None provided
Disruption level h_disruption_level string The level of disruption of a release No None provided
Release justification h_release_justification string The justification of a release No None provided
Security implication h_security_implication string Any possible security implication cause by a release No None provided
Release_plan h_release_plan string The stratergy surrounding a release No None provided
Test plan h_test_plan string The testing plan for a release No None provided
Communication plan h_communication_plan string The communication plan related to a release No None provided
Support plan h_support_plan string The support plan related to a release No None provided
Backout plan h_backout_plan string The potential backout plan for a release No None provided

Output Parameters

Display Name ID Type Description
Status status string The return status of the API
Error error string Any returned error
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document