nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

How to get and set custom field values via API

Rajeev Gill

This appears to be a question which has already been asked however the answers I found did not relate to my particular situation.

I am writing a script using the app 'Scriptrunner' which has been installed on an instance of Jira Service Desk Cloud not server.

I am also writing this script in the context of a 'Post function', the script is triggered upon creation of a new issue

What I am trying to do with the script is:

1. Get the value of the custom field 'Market' from the created issue

2. Depending on the value found in the 'Market' field

3. Create a new custom field on the created issue and populate the value of the new custom field

The problem I am having is getting the values of the custom fields (I haven't got as far as setting a new custom field yet.

// Get all the fields from the issue as a Map
def fields = issue.fields as Map

log.debug("FIELDS:" + fields)

I get the fields by using the above snippet, it should return the following fields:

However the log output shows that the majority of the fields have the value 'null', see below:

2020-01-24 14:35:21.237 DEBUG - FIELDS:[customfield_10070:null, customfield_10071:null, customfield_10072:null, customfield_10073:null, customfield_10076:null, customfield_10077:null, customfield_10078:null, resolution:null, customfield_10079:null, lastViewed:null, customfield_10060:null, customfield_10061:null, customfield_10062:null, customfield_10063:null, customfield_10064:null, customfield_10065:null, customfield_10066:https://www.volkswagen.it/it.html, customfield_10067:https://www.volkswagen.it/it.html, customfield_10068:null, labels:[], aggregatetimeoriginalestimate:null, issuelinks:[[id:10280, self:https://vw-engine.atlassian.net/rest/api/2/issueLink/10280, type:[id:10003, name:Relates, inward:relates to, outward:relates to, self:https://vw-engine.atlassian.net/rest/api/2/issueLinkType/10003], outwardIssue:[id:12395, key:ES-485, self:https://vw-engine.atlassian.net/rest/api/2/issue/12395, fields:[summary:OPS - Automation of Jira processes, status:[self:https://vw-engine.atlassian.net/rest/api/2/status/3, description:This issue is being actively worked on at the moment by the assignee., iconUrl:https://vw-engine.atlassian.net/images/icons/statuses/inprogress.png, name:In Progress, id:3, statusCategory:[self:https://vw-engine.atlassian.net/rest/api/2/statuscategory/4, id:4, key:indeterminate, colorName:yellow, name:In Progress]], priority:[self:https://vw-engine.atlassian.net/rest/api/2/priority/3, iconUrl:https://vw-engine.atlassian.net/images/icons/priorities/medium.svg, name:Medium, id:3], issuetype:[self:https://vw-engine.atlassian.net/rest/api/2/issuetype/10006, id:10006, description:A task that needs to be done., iconUrl:https://vw-engine.atlassian.net/secure/viewavatar?size=medium&avatarId=10517&avatarType=issuetype, name:Task, subtask:false, avatarId:10517]]]]], assignee:[self:https://vw-engine.atlassian.net/rest/api/2/user?accountId=5be05eade3a3ee7e0823c2f9, accountId:5be05eade3a3ee7e0823c2f9, avatarUrls:[48x48:https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/i

As you can see the only custom fields I can get via the API are 'Website/Domain' and 'Page URL example' - Does anybody know how I can access ALL fields?

def issue = get("/rest/api/2/issue/${issueId}")
  .header('Content-Type', 'application/json')
  .asObject(Map)
  .body

Just to add I have used both the above method and the method detailed in my initial question.

Thanks in advance

Accepted answers

All comments

Kristian Walker _Adaptavist_

Hi Rajeev,

Thank you for your question.

I can confirm the example shown in the ScriptRunner for Jira Cloud documentation site located here shows how to return all of the custom fields in a post function in the customFields rest call located at the top of the script.

This rest API call gets all of the custom field objects and the script shows how to then return values off of fields on the issue.

You will be able to use this script as a reference to see how to get the field values you require inside of your script.

I can also confirm on the documentation pages located here we have examples of how to set the values in different types of fields which you may find helpful.

I hope this information helps.

Regards,

Kristian

Rajeev Gill

Thanks Kristian!

Kristian Walker _Adaptavist_

Hi Rajeev,

Thank you for confirming that our response allowed you to achieve your requirements.

Regards,

Kristian

Rajeev Gill

Hi Kristian,

Unfortunately the second part of the suggested script doesn't work.

I am able to get the value of the 'Market' field but I am unable to set the value of the Region field.

When I try to set the value of the region field and then log that value it returns null, see code and log output below:

//Add libsimport org.apache.log4j.Loggerimport org.apache.log4j.Levelimport groovy.json.JsonSlurper
//Set up loggerdef log = Logger.getLogger("Rajeevs log")log.setLevel(Level.DEBUG)
//List nations and associated regions as stringdef nation_info_str = '''[
//A json list of nations (I left it out because it is too long)
]'''
//Convert list of nations into JSON objectdef jsonSlurper = new JsonSlurper()def nations_json = jsonSlurper.parseText(nation_info_str)
//Get custom fieldsdef customFields = get("/rest/api/2/field")        .asObject(List)        .body        .findAll { (it as Map).custom } as List<Map>
//get market custom field IDdef marketId = customFields.find { it.name == 'Market' }?.id
//get region custom field IDdef regionId = customFields.find { it.name == 'Region' }?.id
//get market namedef marketName = issue.fields[marketId]?.value
//Cycle through each nation in listfor (int i = 0; nations_json.length; i++) {    //If nation in list matches market of current ticket    if(nations_json[i]?.name == marketName) {        //Set custom field 'region' of issue to region property in nations list e.g. region = nations[i].region        log.debug("THIS TICKET HAS BEEN SUBMITTED FROM " + nations_json[i]?.region)                put("/rest/api/2/issue/${issue.key}")         // .queryString("overrideScreenSecurity", Boolean.TRUE)         .header("Content-Type", "application/json")        .body([            fields:[                    (regionId): nations_json[i]?.region            ]        ])        .asString()            }        break}
customFields = get("/rest/api/2/field")        .asObject(List)        .body        .findAll { (it as Map).custom } as List<Map>
//log.debug("ISSUEKEY" + issue.key)log.debug("REGIONFIELD " + customFields.find { it.name == 'Region' })log.debug("REGIONFIELD " + customFields.find { it.name == 'Region' }?.value)

Log output

2020-01-29 13:58:07.001 INFO - Serializing object into 'interface java.util.List'2020-01-29 13:58:07.012 INFO - GET /rest/api/2/field asObject Request Duration: 540ms2020-01-29 13:58:07.344 INFO - Serializing object into 'interface java.util.List'2020-01-29 13:58:07.350 INFO - GET /rest/api/2/field asObject Request Duration: 299ms2020-01-29 13:58:07.410 DEBUG - REGIONFIELD [id:customfield_10179, key:customfield_10179, name:Region, custom:true, orderable:true, navigable:true, searchable:true, clauseNames:[cf[10179], Region], schema:[type:option, custom:com.atlassian.jira.plugin.system.customfieldtypes:select, customId:10179]]2020-01-29 13:58:07.412 DEBUG - REGIONFIELD null2020-01-29 13:58:07.430 INFO - Condition didn't eval to true, exiting

Do you know how to properly set a custom field value?

Many thanks,

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

cloud

jira-service-desk

jira-service-desk-cloud