Versions Compared

Old Version 1

changes.mady.by.user Pavel Pavlovsky

Saved on

compared with

New Version 2

changes.mady.by.user Pavel Pavlovsky

Saved on

Key

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

...

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

Status
colourYellow
titlePOSTPONED
Create template POST /rest/railsware/1.0/template

Creates a new template

Expand
titleExpand

Body parameters(application/json)

  • name: string (required)

  • value: string (required)

  • enabled: boolean

  • defaultContext: object

    • type: integer (0 - None, 1 - All issue types, 2 - Multiple issue types)

    • values: array of issue type ids

  • scope: object

    • Type: integer (0 - All projects, 1 - Multiple projects, 2 - Single project)

    • values: array of project ids

Example

Code Block
languagejson
{
   "value":"- test\n- second item\n",
   "name":"New template",
   "enabled":true,
   "defaultContext":{"type":0,"values":[]},
   "scope":{"type":2,"values":["10200"]}}
}

Responses

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

  • Status
    colourRed
    titlestatus 400
    Returned if the request body parameters are invalid

Status
colourYellow
titlePOSTPONED
Update template PUT /rest/railsware/1.0/template/{id}

Updates template

Expand
titleExpand

Path parameters

  • id: number (required)

Body parameters(application/json):

  • name: string (required)

  • value: string (required)

  • enabled: boolean

  • defaultContext: object

    • type: integer (0 - None, 1 - All issue types, 2 - Multiple issue types)

    • values: array of issue type ids

  • scope: object

    • Type: integer (0 - All projects, 1 - Multiple projects, 2 - Single project)

    • values: array of project ids

Responses

  • Status
    colourGreen
    titlestatus 200
    application/json Returns the updated template in JSON format

  • Status
    colourRed
    titlestatus 400
    Returned if the request body parameters are invalid

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

...