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 the provided field configuration ID.
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.
JSON examples
The following are full JSON examples of the different parameters with default values.
Checklist 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,
"canBulkEdit":true,
"canBulkComplete":true,
"issueLinkType":null,
"canAssignUsers":false,
"canSetDueDate":false,
"canSetPriority":false,
"enableAdvancedMarkdown":false,
"enableExternalAssetLinking":false,
"enableHeaderItems":true,
"enableHeaderItemCollapsing":true,
"showHeaderItemSummaries":true,
"collapseHeaderItemsByDefault":false,
"defaultMandatoryState":true,
"showProgressHeaderInReadOnlyView":true,
"showProgressHeaderInEditView":true,
"strikeThrough":true,
"showMore":false,
"showMoreCount":0,
"alwaysShowEmptyChecklist":true,
"alwaysShowUncheckedChecklist":true,
"hideUncheckedInReadonlyView":false,
"issueViewDisplayMode":"CustomField" || "SidebarPanel" || "IndependentPanel",
"summarySource":"AllItems" || "MandatoryItems",
"bannerParameters":{
"completedLabel":"",
"allMandatoryLabel":"",
"incompleteLabel":"",
"emptyLabel":"",
"type":"Progression",
"appearance":"Normal"
},
"assigneeDisplay":"Avatar" || "Name" || "Initials" || "AvatarAndName" || "AvatarAndInitials",
"descriptionDisplay":"LinkUnderItem" || "TooltipNextToItem",
"compactView":false,
"reporterCanEdit":true,
"allCanComplete":true,
"limitEditionWithRoles":false,
"editRoleIds":[],
"canImportTemplateIntoChecklist":true,
"canCreateTemplateFromChecklist":true,
"createTemplateFromChecklistRoleIds":[],
"useConfluenceRenderer":true
}
Checklist proxy parameters
{
"version":5,
"type":"Banner",
"summarySource":"AllItems" || "MandatoryItems",
"banner":{
"completedLabel":"",
"allMandatoryLabel":"",
"incompleteLabel":"",
"emptyLabel":"",
"type":"Progression",
"appearance":"Subtle",
"prefix":"Checkbox",
"customPrefix":""
},
"progressBarParameters":null,
"onlyShowUnchecked":false
}
Checklist proxy for customer portal parameters
{
"version":5,
"proxiedFieldConfigId":null,
"showOnCreateScreen":true,
"showOnViewScreen":true
}
APIs
Get parameters
GET [...]/parameters
| Description | Example |
|---|---|---|
Response | Returns the full JSON representation of the requested parameters. |
Update parameters
PUT [...]/parameters
| Description | Example |
|---|---|---|
Request | A JSON representation of the fields to be updated, including their values. 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. |
Exceptions
For the list of potential exceptions, see https://okapya.atlassian.net/wiki/spaces/CHKDOC5/pages/2940666327/Exceptions+for+configuration+REST+APIs#Parameter-exceptions.