Versions Compared

Version Old Version 1 New Version Current
Changes made by

Pascal Perreault [Okapya]

Pascal Perreault [Okapya]

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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.

The default local item parameters dictate whether the custom field uses a template for its default local items or not.

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/checklists/configuration/{FieldConfigId}/defaultlocalitemparameters
Info

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

APIs

Get parameters

Status
colourGreen
titleget
[...]/defaultlocalitemparameters

Description

Example

Response

Returns the full JSON representation of the requested parameters.

Code Block
languagejson
Update the 
{
  "version": 5,
  "fromTemplate": false,
  "templateId": null
}

Update parameters

Status
colourYellow
titleput
[...]/defaultlocalitemparameters

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
languagejson
{"fromTemplate":false}

or

Code Block
languagejson
{"fromTemplate":true, "templateId":1}

Response

Returns the full JSON representation of the updated parameters.

Code Block
languagejson
{
  "version": 5,
  "fromTemplate": false,
  "templateId": null
}

Exceptions

For the list of potential exceptions, see https://okapya.atlassian.net/wiki/spaces/CHKDOC5/pages/2825977895/5.2.0+Configuration2940666327/Exceptions+for+configuration+REST+API+exceptions#DefaultAPIs#Default-local-item-parametersparameter-exceptions.

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