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

Jira Cloud / Get Issue

  • Article
  • 3 minutes to read

Operation Information

Retrieves information about a Jira Cloud issue.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Jira Cloud 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 Jira Cloud Authentication in the Type pick list;
  • Give the Jira Cloud Authentication KeySafe key a Title (this is the name / identifier for the Jira Cloud 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
Endpoint Name string Jira Cloud Endpoint Name
Username string Authentication Username
API Token string Atlassian API Token generated against the above user.

Tip

The Endpoint Name field should be populated with the Jira Cloud Endpoint that you wish to connect to. This can be taken from the Jira Cloud URL, as so: https://[Endpoint Name].atlassian.net.

See the Atlassian website for details on creating API tokens.

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 Jira Cloud Authentication account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Issue issue string Issue ID or Key Yes None provided
Additional Fields additionalFields object The unique IDs of any additional fields that you wish to return No None provided

Output Parameters

Display Name ID Type Description
Status status string Operation Status - can be ok/fail
Errors errors string Any error(s) returned by the operation
Type type string Type
Summary summary string Issue Summary
Description description string Issue Description
Priority priority string Priority
Issue Status issueStatus string Issue Status
Resolution resolution string Resolution
Resolution Date resolutionDate string Resolution Date
Fix Versions fixVersions string Fix Versions
Affects Version affectsVersion string Affects Version
Labels labels string Labels
Security Level securityLevel string Security Level
Assignee Email assigneeEmail string Assignee Email
Assignee Name assigneeName string Assignee Name
Reporter Email reporterEmail string Reporter Email
Reporter Name reporterName string Reporter Name
Created created string Created
Updated updated string Updated
Field 1 field1 string Field 1 Value
Field 2 field2 string Field 2 Value
Field 3 field3 string Field 3 Value
Field 4 field4 string Field 4 Value
Field 5 field5 string Field 5 Value
Field 6 field6 string Field 6 Value
Field 7 field7 string Field 7 Value
Field 8 field8 string Field 8 Value
Field 9 field9 string Field 9 Value
Field 10 field10 string Field 10 Value
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document