Versions Compared

Old Version 11

changes.mady.by.user Olena Brazhko

Saved on

compared with

New Version 12

changes.mady.by.user Mariya Solovey

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleExpand


Path parameters

  • id: number (required)

Body parameters (application/json)

  • projectId: number (optional) - specifies a project ID

  • name: string (required) - specifies a template name

  • value: string - specifies checklist value in string format

  • enabled: boolean (true by default)

  • scope: object (required) - specifies a scope of projects to be displayed on
    type: number - (0 - All projects, 1 - Multiple projects, 2 - Single project)
    values: array of project ids

  • trigger: object - specifies a trigger for automatically template applying
    type: number - (0 - Issue created, 1 - Issue updated, 2 - Issue transitioned, 3 - none)
    from: array of status ids - available only for Issue transitioned trigger type
    to: array of status ids - available only for Issue transitioned trigger type
    preventDuplicates: boolean

  • conditions: array of objects - specifies a list of conditions that have to be checked before applying a template
    field: object
    type: string (required)
    id: string (required)
    option: string
    values: array of strings

Responses

  • Status
    colourGreen
    titlestatus 200
    application/json returns the created template in JSON format

  • Status
    colourRed
    titlestatus 400
    returned if the request parameters are invalid

...

Expand
titleExpand

Path parameters

  • id: number (required)

Query parameters:

  • page: number

  • projectId: number (optional) - specifies project ID

Responses

  • Status
    colourGreen
    titlestatus 200
    application/json Returns list of existing templates in JSON format

  • Status
    colourRed
    titlestatus 404
    status 404 - returned if the requested template is not found

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

Browse Projects

Edit Issues

Administer Projects

Site Admin

GET /rest/railsware/1.0/checklist

Get checklist

(tick)

(tick)

(tick)

(tick)

PUT /rest/railsware/1.0/checklist/{checklistId}

Update checklist

(tick)

DELETE /rest/railsware/1.0/checklist/{checklistId}

Delete checklist items

(tick)

PUT /rest/railsware/1.0/checklist/{checklistId}/item

Create/Update checklist from string

(tick)

GET /rest/railsware/1.0/template/global

Get template list

(tick)

GET rest/railsware/1.0/template/project/{{projectId}}?reversed=false&page=1&global=true

Get global templates

(tick)

(tick)

(tick)

GET /rest/railsware/1.0/template/project/{projectId}?reversed=false&page=1&global=false

Get project templates

(tick)

(tick)

(tick)

GET /rest/railsware/1.0/template/{templateId}

Get template by ID

(tick)

GET /rest/railsware/1.0/template/fields

Get template fields

(tick)

POST /rest/railsware/1.0/template

Create template

(warning) only with "scope":{"type":2,"values":["projectId"] in request

(warning) only with "scope":{"type":2,"values":["projectId"] in request

(tick)

DELETE /rest/railsware/1.0/template/{id}

Delete template

(warning) only if add ?projectId={id} to the endpoint

(tick)

PUT rest/railsware/1.0/template/{Id}

Update template

(warning) only with "projectId" in request body

(tick)

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

View Smart Checklist

Add Smart Checklist Items

Set status of Smart Checklist Items

Delete Smart Checklist Items

Manage Smart Checklist Items

Project Admin

Site Admin

GET /rest/railsware/1.0/checklist

Get checklist

(tick)

(tick)

(tick)

(tick)

(tick)

(tick)

(tick)

PUT /rest/railsware/1.0/checklist/{checklistId}

Update checklist

(warning) only change status of checklist items

(tick)

DELETE /rest/railsware/1.0/checklist/{checklistId}

Delete checklist items

(tick)

(tick)

PUT /rest/railsware/1.0/checklist/{checklistId}/item

Create/Update checklist from string

(warning) only add new items with "isReplace": false in request

(tick)

GET /rest/railsware/1.0/template/global

Get template list

(tick)

GET rest/railsware/1.0/template/project/{{projectId}}?reversed=false&page=1&global=true

Get global templates

(tick)

(tick)

(tick)

(tick)

GET /rest/railsware/1.0/template/project/{projectId}?reversed=false&page=1&global=false

Get project templates

(tick)

(tick)

(tick)

(tick)

GET /rest/railsware/1.0/template/{templateId}

Get template by ID

(tick)

GET /rest/railsware/1.0/template/fields

Get template fields

(tick)

POST /rest/railsware/1.0/template

Create template

(warning) only with "scope":{"type":2,"values":["projectId"] in request

(warning) only with "scope":{"type":2,"values":["projectId"] in request

(warning) only with "scope":{"type":2,"values":["projectId"] in request

(tick)

DELETE /rest/railsware/1.0/template/{id}

Delete template

(warning) only if add ?projectId={id} to the endpoint

(tick)

PUT rest/railsware/1.0/template/{Id}

Update template

(warning) only with "projectId" in request body

(tick)

...

Insert excerpt
Support
Support
nopaneltrue