Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel

On this page

Table of Contents
maxLevel2
exclude(On this page|Use case).*
stylecircle
typeflat
separatorpipe



UI Text Box
sizemedium
typeinfo

Use case

In this use case we will get the insight object entries assets (formerly insight objects) of a Jira Cloud isssue and afterwards add them in a commentissue and write the respective object labels to a custom text field.


Image ModifiedPrerequisites

UI Text Box
typeinfo

For this use case we need an Action a custom action for executing the get Insight object entries assets operation. It should be executed in for a Jira cloud instance using the current Cloud instance connection.


UI Expand
titleCreate a connection

Configure the

action

connection either inside the post function

configuration or

configuration or using the Remote actions page in the

Connector app

Manage apps administration by setting the following input.

UI Steps


UI Step

Name

Atlassian API


UI Step

Connection type

Choose External.


UI Step

Base URL

Code Block
https://api.atlassian.com



ui-step

Authentication

Choose Basic authentication and provide an email as the username and an API token as password.




ui-expand
titleCreate an action

Create the action either inside the post function configuration or using the Remote actions page in the Manage apps administration by setting the following input.

UI Steps


UI Step

Name

Get insight object entriesassets


UI Step

Method

Choose GET.


UI Step

Default connection

Choose Current instance Atlassian API.


UI Step

REST path


Code Block
linenumberstrue
/jsm/insightassets/workspace/{workspaceId}/v1/iqlaql/objects?{iql}qlQuery}


Excerpt Include
DECADIS:_snip_execute_remote_action_use_case_values
DECADIS:_snip_execute_remote_action_use_case_values
nopaneltrue

qlQuery

The qlQuery parameter holds an AQL (Asset Query Language) expression and determines which objects should be fetched. For the sake of the example we set the issue key as ISSUE-1

iql

The iql stands for "insight query language" and it is the query to determine which objects that should be fetched. In this case we want to get all the objects related to the transitioned issue.

UI Step

Parameters

workspaceId

The workspaceId is used to identify your individual instance of Insight. It is retrieved through the following endpoint: https://SITE_NAME.atlassian.net/rest/servicedeskapi/insight/workspace.

Code Block
linenumberstrue
Code Block
linenumberstrue
object HAVING connectedTickets(key = %{issue.key}ISSUE-1)





Image ModifiedConfiguration

UI Steps


UI Step

Add the Execute remote action post function to the desired transition or create a new transition and choose the Expert mode.


UI Step

Select action

Choose the previous created action which we named Update issue Get assets.


UI Step

Select connection

It is automatically preselected with the default connection value of the selected action.


UI Step
Storing results

Update issue fields (optional)

Excerpt Include
DECADIS:_snip_execute_remote_action_default_responses
DECADIS:_snip_execute_remote_action_default_responses
nopaneltrue

UI Steps


UI Step

Select the field to be set.

Choose New commentthe text custom field to hold the object entry labels.


UI Step

Set the value manually by using the following parser expression:

Code Block
%{action.response.objectEntries[*].
Choose Response status
label}


UI Text Box
typetip

This parser expression uses the field code Action response details and JMESPath in order to get the information from the response.











Image ModifiedRelated use cases

Page properties report
firstcolumnUse case
headingsJWT feature, Workflow function, Parser function, Label
sortByTitle
cqllabel = "use-case-workflow" and ancestor = "7340095373403011"


Excerpt Include
DECADIS:Contact support
DECADIS:Contact support
nopaneltrue


Page properties
hiddentrue


JWT feature

Workflow function

Assign to project roleExecute remote action

Label



Page properties
hiddentrue



Status
Tech review

Green
Status
colour
titledonetodo

Style guide

Green
Status
colour
titledonetodo

Status
titletodo
Status
colourYellow
titleReady for review
Status
colourGreen
titledone
Status
colourRed
titleflagged