Versions Compared

Old Version 4

changes.mady.by.user Pascal Perreault [Okapya]

Saved on

compared with

New Version 5

changes.mady.by.user Pascal Perreault [Okapya]

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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 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

Update the

Get parameters

Status
colourGreen
titleget
[...]/parameters

Response

Returns the full JSON representation of the requested parameters.

Code Block
languagejson
{
   "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

Status
colourYellow
titlePUT
[...]/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
languagejson
{"showStatusMenu":true, "allowLocalItems":false}

 

Response

Returns the full JSON representation of the updated parameters.

Code Block
languagejson
{
   "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.

Status
titleSERVER DOCUMENTATION
(On Cloud? Go here.)
Have questions? Contact our Service Desk for help anytime.