Add Custom field value Thru REST API In Issue Update

unknown

Hi,

I want to add a New Field Value to Multi-Select in Issue Update thru REST API.  While Passing the New Value to the JIRA Update I am getting an error. I am not sure how to add the new value to Multi-select. Any other suggestions will be helpful.

Input:

{
"fields" : {
"customfield_12354" : [
{
"value" : "New Jira Test Account"
}
],
"project" : {
"id" : "11000",
"key" : "TP"
}
},
"issueIdOrKey" : "86758"
}

 

JIRA Output:

{
"errorMessages": [],
"errors": {
"customfield_12354": "Option value 'New Jira Test Account' is not valid"
}
}

 

Thanks,

Nagendra M

Andy Heinzer

Hi,

If I understand your question here, you are trying to create a new value for a multi-select field, assign that value to a specific Jira issue in a single REST API call.

You can not do this action in a single REST API call.  Which might explain why you are getting this error.  When you edit an issue in Jira via REST, you are only able to select from the current possible values that have been preset for that field.  For multi-select fields, their values have to be defined before any issue in Jira can actually utilize that value.  (The same is not true for the labels type field, but this is not the same kind of field).

The other problem here is that for user created custom fields in Jira Cloud, the REST API currently won't let you edit the field option values.  There are a pair of feature requests for this functionality via REST API in

• JRACLOUD-28539
• JRACLOUD-36112

There is an endpoint that could do this in POST /rest/api/2/field/{fieldKey}/option.  However this endpoint can only be used by connect apps (aka plugins or apps) that create custom fields.  From that document:

Note that this operation cannot be used with the built-in custom fields. It only works with issue fields added by Connect apps, as described above.

So if you're creating a connect app that in turn creates a custom field, then you could use that endpoint to add options to a multi-select type custom field.  However if that custom field is not created by a connect app, there does not appear to be a way to change those options/values via REST at this time.  Instead you would need to do this via the web interface of Jira.

Once those options exist for those fields, then you can use the Edit issue endpoint in PUT /rest/api/2/issue/{issueIdOrKey}.  Which can then set/change the custom field value on that issue from the available options.

I hope this helps.

Andy