AVAILABLE SINCE 5.2.1
To improve readability, all JSON results will be beautified, whereas the actual results will not.
Request URI
The base request URI for all APIs on this page is as follows:
http://{JIRA Instance Name}/rest/com.okapya.jira.checklist/latest/checklists/
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 all checklist custom field configuration contexts
GET [...]/configuration
Description | Example | |
|---|---|---|
Path parameters |
When a project ID is used, the current user only needs the Administer Project permissions on that project. Using both the |
|
Response | Returns the full JSON array representation of the custom field configuration contexts. | [
{
"id": 101,
"customFieldId": 10001,
"name": "Default Configuration Scheme for DoD",
"customFieldName": "DoD",
"projectIds": [],
"issueTypeIds": []
},
{
"id": 102,
"customFieldId": 10001,
"name": "Main project configuration",
"customFieldName": "DoD",
"projectIds": [
1001,
1002,
1003
],
"issueTypeIds": []
},
{
"id": 103,
"customFieldId": 10002,
"name": "Default Configuration Scheme for AC",
"customFieldName": "AC",
"projectIds": [
1004
],
"issueTypeIds": [
"10000",
"1"
]
}
]
|
Get a checklist custom field’s configuration contexts
GET [...]/{customFieldId}/configuration
Description | Example | |
|---|---|---|
Response | Returns the full JSON array representation of the specified field’s configuration contexts. | [
{
"id": 101,
"customFieldId": 10001,
"name": "Default Configuration Scheme for DoD",
"customFieldName": "DoD",
"projectIds": [],
"issueTypeIds": []
},
{
"id": 102,
"customFieldId": 10001,
"name": "Main project configuration",
"customFieldName": "DoD",
"projectIds": [
1001,
1002,
1003
],
"issueTypeIds": []
}
]
|
Exceptions
For the list of potential exceptions, see Exceptions for configuration REST APIs.