Editing app parameters using REST APIs
available since 6.1.0
You need administrator rights in Jira to perform the tasks on this page.
To improve readability, all JSON results will be beautified whereas the actual results will not.
This API lets you configure the global app parameters.
Request URI
The base request URI for all APIs on this page is as follows:
{JIRA Instance}/rest/com.okapya.jira.checklist/latest/configurationAPIs
Get the parameters
get
| Description | Example |
|---|---|---|
Response | Returns the full JSON array representation of the app parameters. | {
"historyDateFormat": "yyyy-MM-dd HH:mm Z",
"allowProjectAdminsToConfigure": false
} |
Get the parameter examples
get [...]/examples
You can query to get examples of values calculated from the current parameters and possible errors caused by the parameter values.
| Description | Example |
|---|---|---|
Request | You can optionally pass query parameters with alternate values to find out what the results would be, without having to save the new values right away. |
|
Response | Returns the full JSON array representation of the app parameter examples. | {
"fieldsInError": [],
"historyDateFormat": "2022"
} |
Update the parameters
PUT
| Description | Example |
|---|---|---|
Request | A JSON representation of the fields to update, including their values. To keep updating simple, you only have to list the fields and values you want to update. | or
|
Response | Returns the full JSON representation of the updated parameters. |
Exceptions
For the list of potential exceptions, see https://okapya.atlassian.net/wiki/spaces/CHKDOC5/pages/2940666327/Exceptions+for+configuration+REST+APIs#App-parameter-exceptions.