Versions Compared

Key

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

...

Expand
titleExpand

Query parameters

  • page: number

  • projectId: number - if projectId is specified then only project templates will be returned

  • global: boolean - used in conjunction with projectId parameter. Returns global project templates (All and Multiple scope of the project) if true, returns templates with single project scope otherwise

  • reversed: boolean - specifies ASC or DESC order of templates

  • query: string - specifies the filter by template name

  • orderBy: string - specifies the order column of templates. Valid values are name enabled, issueTypes and projects

Responses

  • Status
    colourGreen
    titleSTATUS 200
    application/json returns a list of all or project templates in JSON format

    Example:

Code Block
languagejson
{
    "totalPages": 1,
    "templates": [
        {
            "id": 16,
            "name": "5.2.0 TEMPLATE PROJ",
            "value": "- 1\n- 2\n# Definition of Done\n- Code produced (all ‘to do’ items in code completed)\n- Code commented, checked in and run against current version in source control\n- Peer reviewed (or produced with pair programming) and meeting development standards\n- Builds without errors\n- Unit tests written and passing\n- Deployed to system test environment and passed system tests\n- Passed UAT (User Acceptance Testing) and signed off as meeting requirements\n- Any build/deployment/configuration changes implemented/documented/communicated\n- Relevant documentation/diagrams produced and/or updated\n- Remaining hours for task set to zero and task closed\n# Definition of Done\n- Code produced (all ‘to do’ items in code completed)\n- Code commented, checked in and run against current version in source control\n- Peer reviewed (or produced with pair programming) and meeting development standards\n- Builds without errors\n- Unit tests written and passing\n- Deployed to system test environment and passed system tests\n- Passed UAT (User Acceptance Testing) and signed off as meeting requirements\n- Any build/deployment/configuration changes implemented/documented/communicated\n- Relevant documentation/diagrams produced and/or updated\n- Remaining hours for task set to zero and task closed\n",
            "enabled": true,
            "defaultContext": {
                "type": 0,
                "values": []
            },
            "scope": {
                "type": 2,
                "values": [
                    {
                        "value": "10000",
                        "label": "Project",
                        "iconUrl": "http://localhost:8075/secure/projectavatar?size=xsmall&pid=10000&avatarId=10209",
                        "link": ""
                    }
                ]
            }
        },
        {
            "id": 7,
            "name": "Acceptance Criteria PROJ",
            "value": "- uno uno\n~ dos dos\nx tres tres\n+ quatro quatro\n- uno uno\n~ dos dos\nx tres tres\n+ quatro quatro\n",
            "enabled": true,
            "defaultContext": {
                "type": 0,
                "values": []
            },
            "scope": {
                "type": 2,
                "values": [
                    {
                        "value": "10000",
                        "label": "Project",
                        "iconUrl": "http://localhost:8075/secure/projectavatar?size=xsmall&pid=10000&avatarId=10209",
                        "link": ""
                    }
                ]
            }
        },
        {
            "id": 13,
            "name": "Browser testing template PROJ",
            "value": "# HEADER DOD\n- Code produced (all ‘to do’ items in code completed)\n- Code commented, checked in and run against current version in source control\n- Peer reviewed (or produced with pair programming) and meeting development standards\n- Builds without errors\n- Unit tests written and passing\n- Deployed to system test environment and passed system tests\n- Passed UAT (User Acceptance Testing) and signed off as meeting requirements\n- Any build/deployment/configuration changes implemented/documented/communicated\n- Relevant documentation/diagrams produced and/or updated\n- Remaining hours for task set to zero and task closed\n# HEADER AC\n- Code produced (all ‘to do’ items in code completed)\n- Code commented, checked in and run against current version in source control\n- Peer reviewed (or produced with pair programming) and meeting development standards\n- Builds without errors\n- Unit tests written and passing\n- Deployed to system test environment and passed system tests\n- Passed UAT (User Acceptance Testing) and signed off as meeting requirements\n- Any build/deployment/configuration changes implemented/documented/communicated\n- Relevant documentation/diagrams produced and/or updated\n- Remaining hours for task set to zero and task closed\n",
            "enabled": true,
            "defaultContext": {
                "type": 0,
                "values": []
            },
            "scope": {
                "type": 2,
                "values": [
                    {
                        "value": "10000",
                        "label": "Project",
                        "iconUrl": "http://localhost:8075/secure/projectavatar?size=xsmall&pid=10000&avatarId=10209",
                        "link": ""
                    }
                ]
            }
        },
        {
            "id": 8,
            "name": "Definition of Done",
            "value": "# Header\n+ [FAILED] item 2\n- [IN QA] item 1\n+ [PASSED] item 4\n+ item 3\n+ [NOT FAILED MAYBE] item 5\n+ hoho\n+ @admin\n- bobo http://localhost:2990/jira/browse/PROJ-3?focusedCommentId=10000&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-10000\n- [bobo](http://localhost:2990/jira/browse/PROJ-3?focusedCommentId=10000&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-10000)\n- dada  http://localhost:2990/jira/browse/PROJ-3?focusedCommentId=10200&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-10200\n- [IN QA] http://localhost:2990/jira/browse/PROJ-3?focusedCommentId=10000&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-10000\n- http://localhost:2990/jira/browse/PROJ-3?focusedCommentId=10000&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-10000\n",
            "enabled": true,
            "defaultContext": {
                "type": 0,
                "values": []
            },
            "scope": {
                "type": 2,
                "values": [
                    {
                        "value": "10000",
                        "label": "Project",
                        "iconUrl": "http://localhost:8075/secure/projectavatar?size=xsmall&pid=10000&avatarId=10209",
                        "link": ""
                    }
                ]
            }
        },
        {
            "id": 14,
            "name": "Help request tempate",
            "value": "- wq\n- e\n",
            "enabled": true,
            "defaultContext": {
                "type": 2,
                "values": [
                    {
                        "value": "10000",
                        "label": "Task",
                        "iconUrl": "http://localhost:2990/jira/secure/viewavatar?size=xsmall&avatarId=10318&avatarType=issuetype"
                    }
                ]
            },
            "scope": {
                "type": 2,
                "values": [
                    {
                        "value": "10100",
                        "label": "SCRUM",
                        "iconUrl": "http://localhost:8075/secure/projectavatar?size=xsmall&avatarId=10324",
                        "link": ""
                    }
                ]
            }
        }
    ]
}
  • Status
    colourRed
    titlestatus 400
    Returned if the request parameters are invalid

  • Status
    colourRed
    titlestatus 404
    Returned if the requested project is not found

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

Retrieve an existing template by id

Expand
titleExpand

Path parameters

  • templateId: number (required)

Responses

  • Status
    colourGreen
    titlestatus 200
    - application/json returns a template in JSON format

Example

Code Block
languagejson
{
            "id": 16,
            "name": "5.2.0 TEMPLATE PROJ",
            "value": "- 1\n- 2\n# Definition of Done\n- Code produced (all ‘to do’ items in code completed)\n- Code commented, checked in and run against current version in source control\n- Peer reviewed (or produced with pair programming) and meeting development standards\n- Builds without errors\n- Unit tests written and passing\n- Deployed to system test environment and passed system tests\n- Passed UAT (User Acceptance Testing) and signed off as meeting requirements\n- Any build/deployment/configuration changes implemented/documented/communicated\n- Relevant documentation/diagrams produced and/or updated\n- Remaining hours for task set to zero and task closed\n# Definition of Done\n- Code produced (all ‘to do’ items in code completed)\n- Code commented, checked in and run against current version in source control\n- Peer reviewed (or produced with pair programming) and meeting development standards\n- Builds without errors\n- Unit tests written and passing\n- Deployed to system test environment and passed system tests\n- Passed UAT (User Acceptance Testing) and signed off as meeting requirements\n- Any build/deployment/configuration changes implemented/documented/communicated\n- Relevant documentation/diagrams produced and/or updated\n- Remaining hours for task set to zero and task closed\n",
            "enabled": true,
            "defaultContext": {
                "type": 0,
                "values": []
            },
            "scope": {
                "type": 2,
                "values": [
                    {
                        "value": "10000",
                        "label": "Project",
                        "iconUrl": "http://localhost:8075/secure/projectavatar?size=xsmall&pid=10000&avatarId=10209",
                        "link": ""
                    }
                ]
            }
        }
  • Status
    colourRed
    titlestatus 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

Responses

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

...