Versions Compared

Old Version 5

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

Saved on

compared with

New Version Current

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 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
colourGreen
titleget
[...]/parameters

Response

Returns the full JSON representation of the requested parameters.

Code Block
languagejson
{

JSON examples

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

Checklist parameters

Code Block
{
  "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,
"canConvertToIssue
"canBulkEdit": true,
  "canBulkComplete": true,
  "issueLinkType": null,
  "canAssignUsers": false,

  "canSetDueDate": false,
  
"canSetPriority": false,
  
"enableAdvancedMarkdown": false,
  
"enableExternalAssetLinking": false,

  "enableHeaderItems": true,
  
"enableHeaderItemCollapsing": true,
  "showHeaderItemSummaries": true,
  "collapseHeaderItemsByDefault": false,
  
"
showHeaderItemSummaries
defaultMandatoryState": true,

  "
showContactSupport
limitChecklistWidth": true,
  
"showProgressHeaderInReadOnlyView": true,

  "showProgressHeaderInEditView": true,

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

  "alwaysShowUncheckedChecklist": true,
  "hideUncheckedInReadonlyView": false,
  "issueViewDisplayMode": "CustomField",
  
"summarySource": "AllItems",

  "bannerParameters": {
    
"completedLabel": "",
    
"allMandatoryLabel": "",

    
"incompleteLabel": "",
    
"emptyLabel": "",
    
"type": "Progression",

    "appearance": "Normal"

  },
  
"assigneeDisplay": "Avatar",
  
"
reporterCanEdit
descriptionDisplay":
true,
 
"
allCanComplete
LinkUnderItem"
:true
,

  "
limitEditionWithRoles
compactView": false,

  "
editRoleIds
reporterCanEdit":
[ ]
 true,
  
"
canImportTemplateIntoChecklist
allCanComplete": true,
  
"
canCreateTemplateFromChecklist
limitEditionWithRoles":
true
 false,

  "
createTemplateFromChecklistRoleIds
editRoleIds":
[ 
 [],

  "
validateGlobalItems
canImportTemplateIntoChecklist": true,
  
"
cleverChangelog
canCreateTemplateFromChecklist": true,

  "
useConfluenceRenderer
createTemplateFromChecklistRoleIds":
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
,
  "useConfluenceRenderer": true
}

Checklist proxy parameters

Code Block
{
   "version":5,
   "
discretionaryOptionIds
type":
[], "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
"Banner",
   "summarySource":"AllItems" || "MandatoryItems",
   "
lockOnResolution
banner":
true, 
{
"canConvertToIssue":true,
    "
canAssignUsers
completedLabel":
false, 
"
canSetDueDate
"
:false
,
"canSetPriority":false,
   
"
enableAdvancedMarkdown
allMandatoryLabel":
false, 
"
enableExternalAssetLinking
"
:false
,
"enableHeaderItems":true, 
   "
enableHeaderItemCollapsing
incompleteLabel":
true, 
"
collapseHeaderItemsByDefault
"
:false
,
"showHeaderItemSummaries":true,
    "
showContactSupport
emptyLabel":
true, 
"
showProgressHeaderInReadOnlyView
"
:true
,
"showProgressHeaderInEditView":true,
   
"
strikeThrough
type":
true, "showMore":false
"Progression",
"showMoreCount":0, 
   "
alwaysShowEmptyChecklist
appearance":
true, "alwaysShowUncheckedChecklist":true, 
"Subtle",
"issueViewDisplayMode":"CustomField",
    "
summarySource
prefix":"
AllItems
Checkbox",
"bannerParameters":{
   
"
completedLabel
customPrefix":""
,
"allMandatoryLabel":"", 
},
   
"
incompleteLabel
progressBarParameters":
""
null,

   
"
emptyLabel
onlyShowUnchecked":
"", 
false
}

Checklist proxy for customer portal parameters

Code Block
{
   
"
type":"Progression", "appearance":"Normal" }
version":5,
   "
assigneeDisplay
proxiedFieldConfigId":
"Avatar"
null,
   "
reporterCanEdit
showOnCreateScreen":true,
   "
allCanComplete
showOnViewScreen":true
, "limitEditionWithRoles":false, "editRoleIds":[ ], "canImportTemplateIntoChecklist":true, "canCreateTemplateFromChecklist":true, "createTemplateFromChecklistRoleIds":[ ], "validateGlobalItems":true, "cleverChangelog":true, "useConfluenceRenderer":true }

}

APIs

Get parameters

Status
colourGreen
titleGET
[...]/parameters

 

Description

Example

Response

Returns the full JSON representation of the requested parameters.

 

Update parameters

Status
colourYellow
titlePUT
[...]/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
{"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.

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