JensPiegsa / jira-rest-essentials

A JIRA plugin that closes some gaps of the JIRA REST API.

JIRA REST Essentials

This JIRA plugin exists to close some gaps of the JIRA REST API.

FieldScreen

GET https://example.com/jira/rest/essentials/1.0/screen

• lists all screens by id and name

GET https://example.com/jira/rest/essentials/1.0/screen?projectKey={projectKey}

• lists all screens associated with a given project

GET https://example.com/jira/rest/essentials/1.0/screen?name={screenName}

• returns the id for a screen with the given name

CustomField

GET https://example.com/jira/rest/essentials/1.0/customfield/description

• lists all custom field descriptions by field (with prefix custom_*)

GET https://example.com/jira/rest/essentials/1.0/customfield/description?id={id}

• returns a custom field description for a given field (id as long without prefix)

GET https://example.com/jira/rest/essentials/1.0/customfield/translations

• returns all available translations for all fields

PUT https://example.com/jira/rest/essentials/1.0/customfield/translations

Request body example:

[
    {
        "id" : "customfield_12345",
        "name" : {
            "de_DE" : "Hinweis",
            "en_UK" : "Hint"
        },
        "description" : {
            "de_DE" : "Zusatzinformation",
            "en_UK" : "Additional information"
        }
    }
]

GET https://example.com/jira/rest/essentials/1.0/status/translations

• returns all available translations of status name / description

PUT https://example.com/jira/rest/essentials/1.0/status/translations

Request body example:

[
    {
        "id": "1",
        "name": {
            "de": "Offen",
            "en_US": "Open"
        },
        "description": {
            "de": "Ein offener Vorgang.",
            "en_US": "An open issue."
        }
    },
    {
        "id": "2",
        "name": {
            "de": "Geschlossen",
            "en_US": "Closed"
        },
        "description": {
            "de": "Ein geschlossener Vorgang.",
            "en_US": "A closed issue."
        }
    }
]

GET https://example.com/jira/rest/essentials/1.0/workflowscheme?projectKey=EXAMPLE

• returns workflow scheme id for given project

Comments

POST https://example.com/jira/rest/essentials/1.0/comment?issueKey=EXAMPLE-123

Request body example:

{
  "author": "someuser",
  "body": "secret comment",
  "projectAdminsOnly": true
}

Create option

PUT https://example.com/jira/rest/essentials/1.0/option?customfieldId=customfield_12345&value=Yes

• returns the id of the created option
• Limit: works only with the first configuration scheme of a custom field.

Disabled options

GET https://example.com/jira/rest/essentials/1.0/disabled-options

• returns all options marked as disabled

---

Build the Add-on

• Use Maven to build a deployable jar file: mvn clean package