Welcome to the Smart Checklist for Jira Server/Data Center platform REST API reference. You can use this REST API to develop integrations between Smart Checklist, Jira, and other 3rd party applications. This page documents the REST resources available in Smart Checklist for the Jira Server/Data Center platform, along with expected HTTP response codes and sample requests.
Looking for simplier simpler integration using Jira REST API and/or 3rd party add-ons? Follow the links below:
...
Expand | ||
---|---|---|
| ||
|
Authentication
Use the same authentication that you use to authenticate to Jira applications on your instances.
Resources
/rest/railsware/1.0/checklist
Get checklists GET /rest/railsware/1.0/checklist
Retrieve Retrieves an existing list of checklist checklists for the given issue key
Expand | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Query parameters
Responses
|
Update checklist PUT /rest/railsware/1.0/checklist/{checklistId}
Updates checklist items
Expand | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Path parameters
Body parameters (application/json) - list of JSON objects:
ExampleChanges the item 50859 position and changes label + status of item 50860:
Responses
|
Delete checklist items DELETE /rest/railsware/1.0/checklist/{checklistId}
Deletes all checklist items for the given checklist
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Path parameters
Responses
|
Create/Update checklist from string PUT /rest/railsware/1.0/checklist/{checklistId}/item
Creates or updates checklist items from string
Expand | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Path parameters
Body parameters (application/json)
Example
Responses
|
/rest/railsware/1.0/template/
Get templates list GET /rest/railsware/1.0/template/global
Retrieve Returns a paginated list of checklist templates available in Jira
Expand | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Query parameters
Responses
|
GET template BY ID GET /rest/railsware/1.0/template/{templateId}
Retrieve an existing template by id
Expand | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
Path parameters
Responses
Example
|
Get project templates GET /rest/railsware/1.0/template/project/{projectId}
Returns a paginated list of project templates
...
Expand | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
Path parameters
Query parameters
Responses
|
...
|
Get template by ID GET /rest/railsware/1.0/template/{templateId}
Returns the Smart Checklist template by id
Expand | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
Path parameters
Responses
|
Get templates fields GET /rest/railsware/1.0/template/fields
Returns a supported list of fields with types for template condition section
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Supported options per field types are:
Also, if a field has property “canBeEmpty” equal to ‘true’, a list of options will extend with two additional values - IS_EMPTY and IS_NOT_EMPTY Responses
|
Create template POST /rest/railsware/1.0/template
Creates a new template
Expand | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
Body parameters (application/json)
Request body example:
Responses
|
Update template PUT /rest/railsware/1.0/template/{id}
Updates template
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Apply template to the issue POST /rest/railsware/1.0/checklist{checklistId}/template/{templateId}
Apply template to the issue
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Path parameters
Responses
|
Delete template DELETE /rest/railsware/1.0/template/{id}
Deletes template by id
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Path parameters
Query parameters:
Responses
|
Status | ||||
---|---|---|---|---|
|
GET /rest/railsware/1.0/history
- available from v6.5.0Retrieves an existing list of changes/updates done to the checklist for the given issue key
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
Query parameters:
Responses
|
Status | ||||
---|---|---|---|---|
|
POST /rest/railsware/1.0/migration
Start the storage migration or migration from other apps (My ToDo, Elements Checklist)
Expand | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
Query parameters:
Example
Responses
|
Note |
---|
REST API endpoints will not be accessible for all the users with the introduced custom permissions in the Smart Checklist v6.4.1. |
Resources based on permissions
REST API endpoints with Jira Standard permission
Jira Standard Permission (Role) | |||||
---|---|---|---|---|---|
REST API Resources | Description |
|
|
|
|
GET /rest/railsware/1.0/checklist | Get checklist |
|
|
|
|
GET /rest/railsware/1.0/history | Get Smart Checklist history |
|
|
|
|
PUT /rest/railsware/1.0/checklist/{checklistId} | Update checklist |
| |||
DELETE /rest/railsware/1.0/checklist/{checklistId} | Delete checklist items |
| |||
PUT /rest/railsware/1.0/checklist/{checklistId}/item | Create/Update checklist from string |
| |||
GET /rest/railsware/1.0/template/global | Get template list |
| |||
GET rest/railsware/1.0/template/project/{{projectId}}?reversed=false&page=1&global=true | Get global templates |
|
|
| |
GET /rest/railsware/1.0/template/project/{projectId}?reversed=false&page=1&global=false | Get project templates |
|
|
| |
GET /rest/railsware/1.0/template/{templateId} | Get template by ID |
| |||
GET /rest/railsware/1.0/template/fields | Get template fields |
| |||
POST /rest/railsware/1.0/template | Create template | only with "scope":{"type":2,"values":["projectId"] in request |
| ||
DELETE /rest/railsware/1.0/template/{id} | Delete template | only if add ?projectId={id} to the endpoint |
| ||
PUT rest/railsware/1.0/template/{Id} | Update template | only with "projectId" in request body |
|
REST API endpoints with Custom permissions to View and Work with Smart Checklist
Tip |
---|
You can set up Custom Permissions to View and Work with Smart Checklist starting from Smart Checklist v6.4.1. |
Custom Smart Checklist permission | Jira permission | ||||||||
---|---|---|---|---|---|---|---|---|---|
REST API Resources | Description |
|
|
|
|
|
|
|
|
GET /rest/railsware/1.0/checklist | Get checklist |
|
|
|
|
|
|
| |
GET /rest/railsware/1.0/history | Get Smart Checklist history | ||||||||
PUT /rest/railsware/1.0/checklist/{checklistId} | Update checklist | only change status of checklist items |
| ||||||
DELETE /rest/railsware/1.0/checklist/{checklistId} | Delete checklist items |
|
| ||||||
PUT /rest/railsware/1.0/checklist/{checklistId}/item | Create/Update checklist from string | only add new items with "isReplace": false in request |
| ||||||
GET /rest/railsware/1.0/template/global | Get template list |
| |||||||
GET rest/railsware/1.0/template/project/{{projectId}}?reversed=false&page=1&global=true | Get global templates |
|
|
|
| ||||
GET /rest/railsware/1.0/template/project/{projectId}?reversed=false&page=1&global=false | Get project templates |
|
|
|
| ||||
GET /rest/railsware/1.0/template/{templateId} | Get template by ID |
| |||||||
GET /rest/railsware/1.0/template/fields | Get template fields |
| |||||||
POST /rest/railsware/1.0/template | Create template | only with "scope":{"type":2,"values":["projectId"] in request | only with "scope":{"type":2,"values":["projectId"] in request |
| |||||
DELETE /rest/railsware/1.0/template/{id} | Delete template | only if add ?projectId={id} to the endpoint | only if add ?projectId={id} to the endpoint |
| |||||
PUT rest/railsware/1.0/template/{ |
...
Id} |
...
Update template |
...
title | Expand |
---|
Path parameters
id: number (required)
Query parameters:
page: number
Responses
application/json Returns list of existing templates in JSON formatStatus colour Green title status 200
...
only with "projectId" in request body | only with "projectId" in request body |
|
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|