Versions Compared

Key

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

We have integrated an API for our app's elements, such as custom fields and relations. This page provides a collection of examples on how to modify or work with the data using scripts. For information about the scripting language itself and available functions and features please refer to the respective documentation. The following section will help you to set up your API requests.

Table of Contents

Work with Assets data via REST

When using the REST API, you can access and modify STAGIL Assets fields in the same way you would do with other issue fields. When getting the data, you can use your REST call to get the issues data and see all related issues in the Assets custom field as issue keys:

  • URL: https://yourjiraURL.xyz/rest/api/latest/issue/{issue-id}

  • Example output for Assets CF: "customfield_10794": "PROJECT1-44, PROJECT1-17, PROJECT1-12"

...

  • Example output for a QR code: "customfield_10795": "https://yourjiraURL.xyz/plugins/servlet/SA-QrCode.png?issueKey=CONFIGMGR-5"

GET Relation Field Values via REST

You can retrieve the information contained in a relation custom field via the following two URLs, which will give you the same results:

URL 1: https://yourjiraURL.com/rest/soj/1.0/relationField/values/relation/{relationId}/{issueOutKey}/{issueInKey}

URL 2: https://yourjiraURL.com/rest/soj/1.0/relationField/values/{issueLinkTypeId}/{issueOutKey}/{issueInKey}

You will get the following response: {“relationFieldValues”: [{“name”: “Name of relation”, “id”: “10”, “type”: “text”, “valueStr”:”relation attribute(s)”}]

Info

How to retrieve the issue link type ID?

Navigate to the issue graph with the relation which contains attribute(s). Active “Inspect Element” in your browser settings and click on the arrow in your graph that contains the attribute.

SIL (Simple Issue Language)

...

Refer to Get the values of the linked issues for information about the script, but for updating the links you need to transform the issue list to a string and update it by using

  • string "A,B,C" or

  • string[] [A,B,C]

where A, B and C are the issue keys.