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 Checklist, Proxy and Customer Portal Proxy parameters based on what field configuration ID is provided.
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}/parameters
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 parameters
GET [...]/parameters
Response | Returns the full JSON representation of the requested parameters. | {
"version":5,
"discretionaryOptionIds":[],
"statusCsv":"notApplicable, N/A, Default, Complete, Keep\r\ninProgress, In Progress, Current, Incomplete, Remove\r\nblocked, Blocked, Error, Incomplete, Remove",
"showStatusMenu":false,
"allowLocalItems":true,
"allowMandatory":true,
"lockOnResolution":true,
"canConvertToIssue":true,
"canAssignUsers":false,
"canSetDueDate":false,
"canSetPriority":false,
"enableAdvancedMarkdown":false,
"enableExternalAssetLinking":false,
"enableHeaderItems":true,
"enableHeaderItemCollapsing":true,
"collapseHeaderItemsByDefault":false,
"showHeaderItemSummaries":true,
"showContactSupport":true,
"showProgressHeaderInReadOnlyView":true,
"showProgressHeaderInEditView":true,
"strikeThrough":true,
"showMore":false,
"showMoreCount":0,
"alwaysShowEmptyChecklist":true,
"alwaysShowUncheckedChecklist":true,
"issueViewDisplayMode":"CustomField",
"summarySource":"AllItems",
"bannerParameters":{
"completedLabel":"",
"allMandatoryLabel":"",
"incompleteLabel":"",
"emptyLabel":"",
"type":"Progression",
"appearance":"Normal"
},
"assigneeDisplay":"Avatar",
"reporterCanEdit":true,
"allCanComplete":true,
"limitEditionWithRoles":false,
"editRoleIds":[
],
"canImportTemplateIntoChecklist":true,
"canCreateTemplateFromChecklist":true,
"createTemplateFromChecklistRoleIds":[
],
"validateGlobalItems":true,
"cleverChangelog":true,
"useConfluenceRenderer":true
}
|
Update parameters
PUT [...]/parameters
| 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. | {"showStatusMenu":true}
or {"showStatusMenu":true, "allowLocalItems":false}
|
Response | Returns the full JSON representation of the updated parameters. | {
"version":5,
"discretionaryOptionIds":[],
"statusCsv":"notApplicable, N/A, Default, Complete, Keep\r\ninProgress, In Progress, Current, Incomplete, Remove\r\nblocked, Blocked, Error, Incomplete, Remove",
"showStatusMenu":false,
"allowLocalItems":true,
"allowMandatory":true,
"lockOnResolution":true,
"canConvertToIssue":true,
"canAssignUsers":false,
"canSetDueDate":false,
"canSetPriority":false,
"enableAdvancedMarkdown":false,
"enableExternalAssetLinking":false,
"enableHeaderItems":true,
"enableHeaderItemCollapsing":true,
"collapseHeaderItemsByDefault":false,
"showHeaderItemSummaries":true,
"showContactSupport":true,
"showProgressHeaderInReadOnlyView":true,
"showProgressHeaderInEditView":true,
"strikeThrough":true,
"showMore":false,
"showMoreCount":0,
"alwaysShowEmptyChecklist":true,
"alwaysShowUncheckedChecklist":true,
"issueViewDisplayMode":"CustomField",
"summarySource":"AllItems",
"bannerParameters":{
"completedLabel":"",
"allMandatoryLabel":"",
"incompleteLabel":"",
"emptyLabel":"",
"type":"Progression",
"appearance":"Normal"
},
"assigneeDisplay":"Avatar",
"reporterCanEdit":true,
"allCanComplete":true,
"limitEditionWithRoles":false,
"editRoleIds":[
],
"canImportTemplateIntoChecklist":true,
"canCreateTemplateFromChecklist":true,
"createTemplateFromChecklistRoleIds":[
],
"validateGlobalItems":true,
"cleverChangelog":true,
"useConfluenceRenderer":true
}
|
Exceptions
For the list of potential exceptions, see https://okapya.atlassian.net/wiki/spaces/CHKDOC5/pages/2940666327/Exceptions+for+configuration+REST+APIs#Parameter-exceptions.