Searching for field contexts using REST APIs

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:

CODE

http://{JIRA Instance Name}/rest/com.okapya.jira.checklist/latest/checklists/

See 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

projectId - Will filter out the results to only show the contexts that apply to the specified project ID.
proxiesOnly - Will filter out the results to only include Checklist Proxy custom fields.
customerPortalsOnly - Will filter out the results to only include Checklist Customer Portal Proxy custom fields.
checklistsOnly - Will filter out the results to only include Checklist custom fields.

When a project ID is used, the current user only needs the Administer Project permissions on that project.

Using both the proxiesOnly and checklistsOnly parameters will default to only show the Checklist custom fields.

/123/configuration?projectId=234

/123/configuration?checklistsOnly

/123/configuration?checklistsOnly&projectId=234

Response

Returns the full JSON array representation of the custom field configuration contexts.

If the user does not have access to a project linked to the field context, the project key will be empty. See the example for project with the ID 1003.

JSON

[
  {
    "id": 101,
    "customFieldId": 10001,
    "name": "Default Configuration Scheme for DoD",
    "customFieldName": "DoD",
    "projects": {},
    "issueTypes": {}
  },
  {
    "id": 102,
    "customFieldId": 10001,
    "name": "Main project configuration",
    "customFieldName": "DoD",
    "projects": {
      "1001": "OK",
      "1002": "TEST",
      "1003": ""
    },
    "issueTypes": {}
  },
  {
    "id": 103,
    "customFieldId": 10002,
    "name": "Default Configuration Scheme for AC",
    "customFieldName": "AC",
    "projects": [
      "1004":"REP"
    ],
    "issueTypes": [
      "10000": "Task",
      "1": "Issue"
    ]
  }
]

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.

If the user does not have access to a project linked to the field context, the project key will be empty. See the example for project with the ID 1003.

JSON

[
  {
    "id": 101,
    "customFieldId": 10001,
    "name": "Default Configuration Scheme for DoD",
    "customFieldName": "DoD",
    "projects": {},
    "issueTypes": {}
  },
  {
    "id": 102,
    "customFieldId": 10001,
    "name": "Main project configuration",
    "customFieldName": "DoD",
    "projects": {
      "1001": "OK",
      "1002": "TEST",
      "1003": ""
    },
    "issueTypes": {}
  }
]

Exceptions

For the list of potential exceptions, see Exceptions for configuration REST APIs.