Editing default local item parameters using REST APIs
- Pascal Perreault [Okapya]
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:
{JIRA Instance}/rest/com.okapya.jira.checklist/latest/checklists/configuration/{FieldConfigId}/defaultlocalitemparametersSee 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 parameters
get [...]/defaultlocalitemparameters
| Description | Example |
|---|---|---|
Response | Returns the full JSON representation of the requested parameters. | {
"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. | {"fromTemplate":false}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#Default-local-item-parameter-exceptions.