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 simpler integration using Jira REST API and/or 3rd party add-ons? Follow the links below:
Use the same authentication that you use to authenticate to Jira applications on your instances.
GET /rest/railsware/1.0/checklist
Retrieves an existing list of checklists for the given issue key
Query parameters
Responses
|
PUT /rest/railsware/1.0/checklist/{checklistId}
Updates checklist items
Path parameters
Body parameters (application/json) - list of JSON objects:
ExampleChanges the item 50859 position and changes label + status of item 50860:
Responses
|
DELETE /rest/railsware/1.0/checklist/{checklistId}
Deletes all checklist items for the given checklist
Path parameters
Responses
|
PUT /rest/railsware/1.0/checklist/{checklistId}/item
Creates or updates checklist items from string
Path parameters
Body parameters (application/json)
Example
Responses
|
GET /rest/railsware/1.0/template/global
Returns a paginated list of templates available in Jira
Query parameters
Responses
|
GET /rest/railsware/1.0/template/project/{projectId}
Returns a paginated list of project templates
Path parameters
Query parameters
Responses
|
GET /rest/railsware/1.0/template/{templateId}
Returns the Smart Checklist template by id
Path parameters
Responses
|
GET /rest/railsware/1.0/template/fields
Returns a supported list of fields with types for template condition section
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
|
POST /rest/railsware/1.0/template
Creates a new template
Body parameters (application/json)
Request body example:
Responses
|
PUT /rest/railsware/1.0/template/{id}
Updates template
|
POST /rest/railsware/1.0/checklist{checklistId}/template/{templateId}
Apply template to the issue
Path parameters
Responses
|
DELETE /rest/railsware/1.0/template/{id}
Deletes template by id
Path parameters
Query parameters:
Responses
|
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
Query parameters:
Responses
|
POST /rest/railsware/1.0/migration
Start the storage migration or migration from other apps (My ToDo, Elements Checklist)
Query parameters:
Example
Responses
|
REST API endpoints will not be accessible for all the users with the introduced custom permissions in the Smart Checklist v6.4.1. |
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 |
|
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 | only with "projectId" in request body | only with "projectId" in request body |
|