Jira Integration Framework
HomeBlogDocsContact
  • Overview
    • Try It!
    • Introduction
    • Key Features
    • Reviews
  • Technical Docs
    • Getting Started
    • Spoke Actions
      • Additional Information Payload - Add Attribute
      • Get Array of Attachment Objects from Issue Payload
      • Additional Information Payload :: Add Attribute
      • Get Journal Entry by Created On
      • Get Applicable JIRA Issue Type
      • Get Applicable JIRA Project
      • Get Status Mapping Entry
      • Inbound Map :: Process
      • Issue :: Synchronize Attachments
      • Jira Field :: Get Field Name
      • Linkage :: Get Available Transition ID for Status
      • Send Record Attachments to Jira
      • Webhook :: Get Changelog Data Components
      • Webhook :: Get Webhook Data Components
      • Get Setting Value as a String
      • JSON :: Get attribute value
      • Comment :: JIRA Panel Format
      • Comment :: JIRA Panel Type Format
      • Check request status
      • Outbound Map :: Generate Payload
      • Comment :: Add
      • Comments :: Get
      • Issue :: Change Logs :: Get by IDs
      • Issue :: Create
      • Issue :: Do Transition
      • Issue :: Get Watchers
      • Issue :: Get
      • Issue :: Set assignment directly
      • Issue :: Set assignment via Rules
      • Issue :: Update
      • Migrate Attachment from Jira
      • Record :: Import Comment from JIRA
      • Record :: Import Issue from JIRA
      • Remote Issue Link :: Add
    • Available Components
      • UI for Creating a New Jira Issue
    • Logging
    • Troubleshooting
    • Privacy Policy
  • SUPPORT
    • Patches & Hotfixes
Powered by GitBook
On this page
  • Summary
  • Action Inputs
  • Action Outputs
  • Notes
  • Example Usage
  • Example 1: Basic Usage
  1. Technical Docs
  2. Spoke Actions

Comments :: Get

Summary

Retrieves a paginated array of Comment objects for a specific JIRA issue using the asynchronous request queue. Retries are handled automatically.

Action Inputs

Label
Name
Type
Mandatory
Description

Connector

connector

Reference (Reference: Jira Connector)

No

[optional] The sys_id of the connector to use (If none specified, the default connector is used)

Issue ID or Key

issue_id_or_key

String

No

The JIRA issue ID or Key of the issue to retrieve

Start At

start_at

Integer

No

[optional] Where to start the pagination within the entire list of comments for the issue. (Default is 0)

Max Results

max_results

Integer

No

[optional] How many results to return. If not specified, the framework's default value is used

Order By

order_by

String

No

[optional] Which attribute to use when ordering the comments. In most JIRA versions, the only attribute currently supported is created. (default: N/A)

Sort Direction

sort_direction

Choice

No

[optional] If an Order By attribute is specified, this will be the direction by which its data is sorted.

Execute ASAP

execute_asap

True/False

No

Whether to run this as an asynchronous business rule when the record gets created or wait for the job to pick it up in relative order on the queue

Expansion Options

expansion_options

String

No

[optional] Comma separate list of attributes of the Issue that are typically hidden in responses (In most versions of JIRA, this is limited to renderedBody)

Action Outputs

Label
Name
Type
Mandatory
Description

Request

request

Reference (Reference: Async Request Queue)

No

The original asynchronous request queue record used to make the request

Success

success

True/False

No

Whether the communication and response was as expected

Log

log

String

No

Scripted log statements of activities that took place during the operation of this activity

Retry Request

retry_request

Reference (Reference: Async Request Queue)

No

If there were Retries used in the process, the last retry record is returned

Comments JSON

comments_json

JSON

No

The resulting JSON representation of the JIRA Comments

Number of Results Returned

num_returned

Integer

No

The number of comments returned in this request

Has Next Page

has_next

True/False

No

If there are more paginated results beyond this set, then this value is true.

Next Starting Index

next_start_at

Integer

No

The Start At index for the next set of paginated results.

Comments

comments

String

No

An Array of Comment objects

Notes

  • This action belongs to the JIRA Request Queue category.

  • This action includes reference fields that link to other tables in ServiceNow:

    • references the table.

  • This action returns 9 output(s) that can be used in subsequent flow steps.

Example Usage

Example 1: Basic Usage

This example demonstrates how to use the action with typical inputs.

Input:

Output:

In this example, the action processes the provided inputs and returns the appropriate outputs. The actual values returned will depend on the specific functionality of this action and the input values provided.

PreviousComment :: AddNextIssue :: Change Logs :: Get by IDs