Versions Compared

Old Version 1

changes.mady.by.user Pascal Perreault [Okapya]

Saved on

compared with

New Version Current

changes.mady.by.user Pascal Perreault [Okapya]

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
titleavailable since 6.1.0

Note

You need administrator rights in Jira to perform the tasks on this page.

Info

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:

Code Block
{JIRA Instance}/rest/com.okapya.jira.checklist/latest/configuration
Info

See https://okapya.atlassian.net/wiki/spaces/CHKDOC5/pages/2940666209/Configuring+checklists+using+REST+APIs#Base-configuration-path for more help with the Request URI.

APIs

Get the parameters

Status
colourGreen
titleget

Description

Example

Response

Returns the full JSON array representation of the app parameters.

Code Block
languagejson
{
  "historyDateFormat": "yyyy-MM-dd HH:mm Z",
  "allowProjectAdminsToConfigure": false
}

Get the parameter examples

Status
colourGreen
titleget
[...]/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.

[...]/examples?historyDateFormat=YYYY

Response

Returns the full JSON array representation of the app parameter examples.

Info

The fieldsInError field indicates what fields have a bad configuration.

Code Block
languagejson
{
    "fieldsInError": [],
    "historyDateFormat": "2022"
}
Code Block
languagejson
// If requested with a bad date format
// [...]/examples?historyDateFormat=abcdef
{
   "fieldsInError":[
      "historyDateFormat"
   ]
}

Update the parameters

Status
colourYellow
titlePUT

The fieldsInError field indicates what fields have a bad configuration

.

 

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.

Code Block
{"historyDateFormat":"YYYY"}

or

Code Block
languagejson
{"allowProjectAdminsToConfigure":true}

 

Response

Returns the full JSON representation of the updated parameters.

Info
Code Block
languagejson
{
  "historyDateFormat": "yyyy-MM-dd HH:mm Z",
  "allowProjectAdminsToConfigure": false
}
// If requested with a bad date format
// [...]/examples?historyDateFormat=abcdef
{
   "fieldsInError":[
      "historyDateFormat"
   ]
}

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.

Status
titleSERVER DOCUMENTATION
(On Cloud? Go here.)
Have questions? Contact our Service Desk for help anytime.