Page Comparison

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.

This API lets you configure Checklist, Proxy and Customer Portal Proxy parameters based on what the provided field configuration ID is provided.

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}/parameters

Info
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

Status

colour	Green
title	get

[...]/parameters

Response

Returns the full JSON representation of the requested parameters.

JSON examples

The following are full JSON examples of the different parameters with default values.

Checklist parameters

Code Block

language	json

{
   "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,
   "

collapseHeaderItemsByDefault

showHeaderItemSummaries":

false

true,
   "

showHeaderItemSummaries

collapseHeaderItemsByDefault":

true

false,
   "

showContactSupport

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"

,

||

reporterCanEdit

Name"

:true,

 || "

allCanComplete

Initials"

:true,

 || "

limitEditionWithRoles

AvatarAndName"

:false,

||

editRoleIds":[ ]

AvatarAndInitials",
   "

canImportTemplateIntoChecklist

descriptionDisplay":

true, "canCreateTemplateFromChecklist":true, "createTemplateFromChecklistRoleIds":[ ]

"LinkUnderItem" || "TooltipNextToItem",
   "

validateGlobalItems

compactView":

true

false,
   "

cleverChangelog

reporterCanEdit":true,
   "

useConfluenceRenderer

allCanComplete":true

}

Update parameters

Status

colour	Yellow
title	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.

Code Block
{"showStatusMenu":true}

or

Code Block

language	json

{"showStatusMenu":true, "allowLocalItems":false}

Response

Returns the full JSON representation of the updated parameters.

Code Block

language	json

{

version

limitEditionWithRoles":

5

false,
   "

discretionaryOptionIds

editRoleIds":[],
   "

statusCsv":"notApplicable, N/A, Default, Complete, Keep\r\ninProgress, In Progress, Current, Incomplete, Remove\r\nblocked, Blocked, Error, Incomplete, Remove", "showStatusMenu":false, "allowLocalItems":

canImportTemplateIntoChecklist":true,
   "

allowMandatory

canCreateTemplateFromChecklist":true,
   "

lockOnResolution

createTemplateFromChecklistRoleIds":

true

[],
   "

canConvertToIssue

useConfluenceRenderer":true

,

Checklist proxy parameters

Code Block

language	json

"canAssignUsers":false,

canSetDueDate

version":

false

5,
   "

canSetPriority

type":

false, "enableAdvancedMarkdown":false

"Banner",
   "

enableExternalAssetLinking

summarySource":

false, "enableHeaderItems":true, "enableHeaderItemCollapsing":true

"AllItems" || "MandatoryItems",
   "

collapseHeaderItemsByDefault

banner":

false,

"showHeaderItemSummaries":true,

showContactSupport

completedLabel":

true,

showProgressHeaderInReadOnlyView

:true

"showProgressHeaderInEditView":true,

"strikeThrough":true, "showMore":false, "showMoreCount":0, "alwaysShowEmptyChecklist":true,

"allMandatoryLabel":"",
      "

alwaysShowUncheckedChecklist":true, "issueViewDisplayMode

incompleteLabel":"

CustomField

",

"summarySource":"AllItems",

bannerParameters

emptyLabel":

{ "completedLabel

:

"

,
      "

allMandatoryLabel

type":"Progression",
      "

incompleteLabel

appearance":"Subtle",
      "

emptyLabel

prefix":"Checkbox",
      "

type

customPrefix":"

Progression

,

"appearance":"Normal"

},
   "

assigneeDisplay

progressBarParameters":

"Avatar"

null,
   "

reporterCanEdit

onlyShowUnchecked":

true,

false
}

Checklist proxy for customer portal parameters

Code Block

language	json

"allCanComplete":true,

limitEditionWithRoles

version":

false

5,
   "

editRoleIds

proxiedFieldConfigId":

[ ]

null,
   "

canImportTemplateIntoChecklist

showOnCreateScreen":true,
   "

canCreateTemplateFromChecklist

showOnViewScreen":true

, "createTemplateFromChecklistRoleIds":[ ], "validateGlobalItems":true, "cleverChangelog":true, "useConfluenceRenderer":true }

APIs

Get parameters

Status

colour	Green
title	get

[...]/parameters

	Description	Example
Response	Returns the full JSON representation of the requested parameters.

Update parameters

Status

colour	Yellow
title	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.

Code Block
{"showStatusMenu":true}

or

Code Block

language	json

{"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.

Versions Compared

Old Version 5

New Version 6

Key

Request URI

APIs

Get parameters

JSON examples

Checklist parameters

Update parameters

Checklist proxy parameters

Checklist proxy for customer portal parameters

APIs

Get parameters

Update parameters

Exceptions

Status
title SERVER DOCUMENTATION
(On Cloud? Go here.)

Have questions? Contact our Service Desk for help anytime.

Page Comparison

Versions Compared

Old Version 5

New Version 6

Key

Request URI

APIs

Get parameters

JSON examples

Checklist parameters

Update parameters

Checklist proxy parameters

Checklist proxy for customer portal parameters

APIs

Get parameters

Update parameters

Exceptions

StatustitleSERVER DOCUMENTATION (On Cloud? Go here.)

Have questions? Contact our Service Desk for help anytime.

Status
title SERVER DOCUMENTATION
(On Cloud? Go here.)