Versions Compared

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

Apply template to the issue POST /rest/railsware/1.0/checklist{checklistId}/template/{templateId}

Apply template to the issue

Expand
titleExpand

Path parameters

  • checklistId: number (required)

  • templateId: number (required)

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

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

Deletes template by id

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

...

Expand
titleExpand

Query parameters:

  • issueKey: string (required)

Responses

  • Status
    colourGreen
    titlestatus 200
    application/json Returns list of all history events for the checklist associated with the provided issue key in JSON format

...