Page Comparison

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.

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/configuration/{FieldConfigId}/globalitems

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

Create

Status

colour	Purple
title	post

[...]/globalitems

You can create a new global item in the field configuration.

Description

Example

Request

A JSON representation of the item to create.

The JSON can be simplified to only include the required fields, such as the name.

Info

Specifying a rankvalue will insert the item at that specific rank.

Ranks are zero-based.

Code Block

language	json

{
  "name": "All tests clear"
}

or

Code Block

language	json

{
  "name": "All tests clear",
  "statusId": "blocked"
}

Response

Returns the full JSON representation of the newly created item.

Code Block

language	json

{
  "id": 3,
  "name": "All tests clear",
  "mandatory": true,
  "rank": 0,
  "statusId": "blocked",
  "dueDate": null,
  "isHeader": false,
  "checked": false,
  "priorityId": null,
  "disabled": false
}

Obtain

Get all items

Status

colour	Green
title	get

[...]/globalitems

You can obtain get all global items included in the path’s field configuration, with the option to exclude disabled items.

Description

Example

Query parameters

Status

title	optional

enabledOnlycan be appended as a query parameter to exclude disabled items.

[...]/globalitems?enabledOnly

Response

Returns the full JSON representation of the list of global items.

Code Block

language	json

[
  {
    "id": 3,
    "name": "All tests clear",
    "mandatory": true,
    "rank": 0,
    "statusId": "none",
    "dueDate": null,
    "isHeader": false,
    "checked": false,
    "priorityId": null,
    "disabled": false
  },
  {
    "id": 5,
    "name": "Development reviewed",
    "mandatory": true,
    "rank": 1,
    "statusId": "none",
    "dueDate": null,
    "isHeader": false,
    "checked": false,
    "priorityId": null,
    "disabled": false
  }
]

Obtain

Get a single item

Status

colour	Green
title	get

[...]/globalitems/{globalItemId}

By providing a global item ID, you can obtain get the contents of a single global item.

Description

Example

Response

Returns the full JSON representation of the requested global item.

Code Block

language	json

{
  "id": 3,
  "name": "All tests clear",
  "mandatory": true,
  "rank": 0,
  "statusId": "none",
  "dueDate": null,
  "isHeader": false,
  "checked": false,
  "priorityId": null,
  "disabled": false
}

Update an item

Status

colour	Yellow
title	put

[...]/globalitems/{globalItemId}

You can update the specified global item’s content.

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 that you want to update.

Info

Specifying a rankvalue will move the item at that specific rank.

Ranks are zero-based.

Code Block

language	json

{"mandatory":false}

or

Code Block

language	json

{"mandatory":false, "disabled":true}

Response

Returns the full JSON representation of the updated global item.

Code Block

language	json

{
  "id": 3,
  "name": "All tests clear",
  "mandatory": false,
  "rank": 0,
  "statusId": "none",
  "dueDate": null,
  "isHeader": false,
  "checked": false,
  "priorityId": null,
  "disabled": true
}

See where a global item is in use

Status

title	available since 5.2.1

Status

colour	Green
title	get

[...]/globalitems/{globalItemId}/usages

You can query to know how many issues currently have a value for the global item.

Description

Example

Response

Returns a JSON with the number of issues that have a value for the specified global item.

Code Block

language	json

{
  "issueCount": 123
}

Delete

Status

title	available since 5.2.1

Status

colour	Red
title	delete

[...]/globalitems/{globalItemId}

You can delete a global item in the field configuration.

Description

Example

Query parameters

Status

title	available since 5.2.1

Status

title	optional

deleteIssueValues can be appended as a query parameter to also delete issue values.

Note

If this parameter isn’t provided, issue values won’t be deleted.

The deletion will behave the same way as if the Global Item Validation setting were disabled.

[...]/globalitems/1?deleteIssueValues

Exceptions

For the list of potential exceptions, see https://okapya.atlassian.net/wiki/spaces/CHKDOC5/pages/2940666327/Exceptions+for+configuration+REST+APIs#Global-items-exceptions.

Versions Compared

Old Version 5

New Version Current

Key

Request URI

APIs

Create

Get all items

Get a single item

Update an item

See where a global item is in use

Delete

Exceptions

Status
title SERVER documentation
(On Cloud? Go here.)

Have questions? Contact our Service Desk for help anytime.

Page Comparison

Versions Compared

Old Version 5

New Version Current

Key

Request URI

APIs

Create

Get all items

Get a single item

Update an item

See where a global item is in use

Delete

Exceptions

StatustitleSERVER documentation (On Cloud? Go here.)

Have questions? Contact our Service Desk for help anytime.

Status
title SERVER documentation
(On Cloud? Go here.)