Versions Compared

Old Version 1

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.

Status
titleavailable since 5.2.1

Info

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 Block
http://{JIRA Instance Name}/rest/com.okapya.jira.checklist/latest/checklists/
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 all checklist custom field configuration contexts

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

Info

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

Note

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.

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

Status
colourGreen
titleget
[...]/{customFieldId}/configuration

Description

Example

Response

Returns the full JSON array representation of the specified field’s configuration contexts.

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

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