Skip to content

Commit

Permalink
workflow scheme id exposure
Browse files Browse the repository at this point in the history
  • Loading branch information
JensPiegsa committed Feb 28, 2019
1 parent 086158c commit 70430be
Show file tree
Hide file tree
Showing 7 changed files with 394 additions and 196 deletions.
55 changes: 48 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,35 +7,36 @@ This JIRA plugin exists to close some gaps of the [JIRA REST API](https://docs.a

### FieldScreen

#### `GET https:/example.com/jira/rest/essentials/1.0/screen`
#### `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}`
#### `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}`
#### `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`
#### `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}`
#### `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`
#### `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`
#### `PUT https://example.com/jira/rest/essentials/1.0/customfield/translations`

Request body example:

```json
[
{
Expand All @@ -52,6 +53,46 @@ Request body example:
]
```


#### `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:

```json
[
{
"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 all workflow scheme id for given project

---

### Build the Add-on ###
Expand Down
Loading

0 comments on commit 70430be

Please sign in to comment.