GetJiraIssue

Description:

This processor collects issues from Jira

Additional Details...

Tags:

jira, source, ingest

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Web Client Service Providerweb-client-service-providerController Service API:
WebClientServiceProvider
Implementation: StandardWebClientServiceProvider
Controller service for HTTP client operations.
URLjira-base-urlBase URL of Jira. Example: https://issues.apache.org/jira
Authentication Methodjira-authentication-methodNone
  • None Access Jira anonymously
  • Personal Access Token Use Personal Access Token to access Jira (supported by Jira Server).
  • API Token Use your e-mail address & API token to access Jira (supported by Jira Cloud).
Method used to authenticate with Jira
Personal Access Tokenjira-personal-access-tokenPersonal access tokens (PATs) are a secure way to use scripts and integrate external applications with your Atlassian application. In Jira, select your profile picture at the top right of the screen, then choose Profile. Once you access your profile, select Personal Access Tokens in the left-hand menu.
Sensitive Property: true

This Property is only considered if the [Authentication Method] Property has a value of "Personal Access Token".
E-mail Addressjira-email-addressYour registered e-mail address at Jira Cloud.

This Property is only considered if the [Authentication Method] Property has a value of "API Token".
API tokenjira-api-tokenYour API token at Jira Cloud. To create such token, visit your Atlassian ID Account Settings page at: https://id.atlassian.com
Sensitive Property: true

This Property is only considered if the [Authentication Method] Property has a value of "API Token".
Projectjira-projectFetch only issues in this project.
Queryjira-queryFilter issues by this JQL expression. See Additional Details about required JQL format.
Page Sizejira-page-size50The maximum number of items fetched from Jira per request.
State Tracking Fieldjira-state-tracking-fieldUpdated
  • Created Creation timestamp of Jira issues
  • Updated Last update timestamp of Jira issues
Consider a Jira issue updated, based on this field.

Relationships:

NameDescription
successFetched Jira issues will be emitted from this relationship.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
mime.typeSets the MIME type to application/json

State management:

ScopeDescription
CLUSTERQuery expression, and maximum value of the state tracking field is stored from the last query. Updated after each successful request.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.