Skip to main content
Skip table of contents

Editing default local item parameters using REST APIs

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.

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
{JIRA Instance}/rest/com.okapya.jira.checklist/latest/checklists/configuration/{FieldConfigId}/defaultlocalitemparameters

See Configuring checklists using REST APIs: Base configuration path for more help with the Request URI.

APIs

Get parameters

GET [...]/defaultlocalitemparameters

Description

Example

Response

Returns the full JSON representation of the requested parameters.

JSON
{
  "version": 5,
  "fromTemplate": false,
  "templateId": null
}

Update parameters

PUT [...]/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.

JSON
{"fromTemplate":false}

or

JSON
{"fromTemplate":true, "templateId":1}

Response

Returns the full JSON representation of the updated parameters.

JSON
{
  "version": 5,
  "fromTemplate": false,
  "templateId": null
}

Exceptions

For the list of potential exceptions, see Exceptions for configuration REST APIs: Default local item parameter exceptions.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.