Editing default local items using REST APIs

You need administrator rights in Jira to perform the tasks on this page.

To improve readability, all JSON results will be beautified, whereas the actual results will not.

Special notes for default local items

As opposed to most ID-based systems, default local item IDs start at -1 and decrement as more items are added.

When all items are cleared, the IDs start back at -1.

Whenever you need to update a default local item, we suggest that you get all default local items and filter them to determine which item ID you should use.

Request URI

The base request URI for all APIs on this page is as follows:

CODE

{JIRA Instance}/rest/com.okapya.jira.checklist/latest/checklists/configuration/{FieldConfigId}/defaultlocalitems

See Configuring checklists using REST APIs: Base configuration path for more help with the Request URI.

APIs

Create

POST [...]/defaultlocalitems

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 necessary fields for creation such as the name.

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

Ranks are zero-based.

JSON

{"name":"All tests clear"}

or

JSON

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

Response

Returns the full JSON representation of the newly created item.

JSON

{
  "id": -1,
  "name": "All tests clear",
  "mandatory": true,
  "rank": 0,
  "statusId": "none",
  "dueDate": null,
  "isHeader": false,
  "checked": false,
  "priorityId": null,
  "globalItemId": 0,
  "version": "5.0",
  "assigneeIds": []
}

Get all items

GET [...]/defaultlocalitems

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

Description

Example

Response

Returns the full JSON representation of the list of default local items.

JSON

[
  {
    "id": -1,
    "name": "All tests clear",
    "mandatory": true,
    "rank": 0,
    "statusId": "none",
    "dueDate": null,
    "isHeader": false,
    "checked": false,
    "priorityId": null,
    "globalItemId": 0,
    "version": "5.0",
    "assigneeIds": []
  },
  {
    "id": -2,
    "name": "Deployed to production",
    "mandatory": true,
    "rank": 1,
    "statusId": "none",
    "dueDate": null,
    "isHeader": false,
    "checked": false,
    "priorityId": null,
    "globalItemId": 0,
    "version": "5.0",
    "assigneeIds": []
  }
]

Get a single item

GET [...]/defaultlocalitems/{defaultLocalItemId}

By providing a default local item ID, you can get the contents of a single default local item.

Description

Example

Response

Returns the full JSON representation of the requested default local item.

JSON

{
  "id": -2,
  "name": "Deployed to production",
  "mandatory": true,
  "rank": 1,
  "statusId": "none",
  "dueDate": null,
  "isHeader": false,
  "checked": false,
  "priorityId": null,
  "globalItemId": 0,
  "version": "5.0",
  "assigneeIds": []
}

Update an item

PUT [...]/defaultlocalitems/{defaultLocalItemId}

You can update the specified default local 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 you want to update.

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

Ranks are zero-based.

JSON

{"mandatory":false}

or

JSON

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

Response

Returns the full JSON representation of the updated default local item.

JSON

{
  "id": -2,
  "name": "Deployed to production",
  "mandatory": false,
  "rank": 1,
  "statusId": "none",
  "dueDate": null,
  "isHeader": false,
  "checked": true,
  "priorityId": null,
  "globalItemId": 0,
  "version": "5.0",
  "assigneeIds": []
}

Delete

DELETE [...]/defaultlocalitems/{defaultLocalItemId}

You can delete a default local item in the field configuration. This API doesn’t provide a response.

Exceptions

For the list of potential exceptions, see Exceptions for configuration REST APIs: Default local item exceptions.