Yousuf Ahmad
Yousuf Ahmad

Reputation: 3

How can I make a Jira REST API call to get a specific value?

I am making a Jira REST API call using this example url:

http://example.com/rest/api/2/search/?jql=project=example%20and%20type=test&fields=customfield_14600

Here is an example of the returned JSON

{
    "expand":"names",
    "startAt":0,
    "maxResults":50,
    "total":2,
    "issues":[
        {
            "expand":"examples",
            "id":"1111",
            "self":"https://example.com/rest/api/2/issue/111111",
            "key":"EX-1111",
            "fields":{
                "customfield_14600":{
                    "self":"https://example.com/rest/api/2/customFieldOption/1111",
                    "value":"Common",
                    "id":"11111",
                    "disabled":false
                }
            }
        },
        {
            "expand":"examples",
            "id":"1111",
            "self":"https://example.com/rest/api/2/issue/111111",
            "key":"EX-1111",
            "fields":{
                "customfield_14600":{
                    "self":"https://example.com/rest/api/2/customFieldOption/1111",
                    "value":"Uncommon",
                    "id":"11111",
                    "disabled":false
                }
            }
        }
    ]
}

Here is an image of the returned JSON with better formatting

What URL would I use to only return the issues with the value "Common" for the customfield_14600? Basically I am trying to return the number of issues with the "Common" value.

Upvotes: 0

Views: 1174

Answers (2)

CeydaAkb
CeydaAkb

Reputation: 1

@Yousuf, for your question:

Example:

rest/api/2/search?jql=project = NAME AND labels = Sprint1 AND cf[15200] = \"4771\""

Or just use Postman and add the JQL query as a param. Then see the code snippet there. The URL is ready.

Upvotes: 0

Diego Agulló
Diego Agulló

Reputation: 9576

Since you are using a JQL query, you could add another filter to check that the custom field you need has the value you require, as such:

project = example AND type = test AND cf[14600] = "Common"

Or, if you know the name of the custom field and/or prefer it to be readable:

project = example AND type = test AND "Field name" = "Common"

You can check the manual for more operators/keywords.

On another topic, I would recommend using the POST endpoint instead of the GET one for searches that include complex queries. Check the REST API documentation for instructions.

Upvotes: 0

Related Questions