Base URL for Issue Tracking System Instance REST API
http://host:port/flexdeploy/rest/v1/topology/integrations/issuetrackingsystem
Issue Tracking Systems can be accessed and modified through this API using four services: GET, POST, PUT, and PATCH. These four services allow for the retrieval, creation, complete update, and partial update of Issue Tracking Systems.
You can find more information about the REST API functions on the /wiki/spaces/FLEX/pages/392986625page.
Each function returns a JSON Issue Tracking System object. An Issue Tracking System object has these attributes:
Attributes | Type | Required* | Description |
---|---|---|---|
instanceId | Integer | No | Primary ID of the Issue Tracking System, created when first making an Issue Tracking System. |
instanceCode | String | Yes | The code of the Issue Tracking System |
instanceName | String | Yes | The name of the Issue Tracking System |
issueTrackingSystemId | Integer | Yes | The ID of the type of Issue Tracking System |
description | String | No | The description of the Issue Tracking System |
isActive | Boolean | No** | Whether or not this Issue Tracking System is active. |
properties | List<Property> | No** | The properties associated with the type of Issue Tracking System |
*unless otherwise stated
**defaults to true
GET
There are two implementations of GET. One will find an Issue Tracking System with the given Id and return the JSON representation of the Issue Tracking System. The other will find a list of Issue Tracking Systems matching the parameters supplied to it.
GET by ID
This GET service will find an Issue Tracking System with the given Id and return the JSON representation of the object.
API URL
http://host:port/flexdeploy/rest/v1/topology/integrations/issuetrackingsystem/{Id}
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Id | Yes | URL | URL parameter for the Id which is used to find and return an issue tracking system |
GET by Query Parameters
This GET service will return a list of Issue Tracking Systems in the form of JSON objects based on the query parameters code, name, and issue tracking system type. Issue Tracking Systems are only returned if they match ALL of the specified query parameters. If no query parameters are given this request will return the entire list of Issue Tracking Systems.
API URL
http://host:port/flexdeploy/rest/v1/topology/integrations/issuetrackingsystem?
Append the following character sequences to the above URL to specify Query parameters.
Use '&' between successive query parameters:
instanceCode={instanceCode}
instanceName={instanceName}
itsName={itsName}
Examples:
To specify the code parameter only:
http://host:port/flexdeploy/rest/v1/topology/integrations/issuetrackingsystem?instanceCode={instanceCode}
To specify the code and name parameters:
http://host:port/flexdeploy/rest/v1/topology/integrations/issuetrackingsystem?instanceCode={instanceCode}&instanceName={instanceName}
To specify the issue tracking system name only:
http://host:port/flexdeploy/rest/v1/topology/integrations/issuetrackingsystem?itsName={itsName}
The query parameters are not case sensitive. Searching by instanceName=NAME is the same as searching by instanceName=name.
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
instanceCode | No | URL | This is a URL query parameter for the instance code which is used to search the issue tracking systems. |
instanceName | No | URL | This is a URL query parameter for the instance name which is used to search the issue tracking systems. |
itsName | No | URL | This is a URL query parameter for the issue tracking system name which is used to search the issue tracking systems. |
Example Output
Output when the Group Code was made "Group" through http://host:port/flexdeploy/rest/v1/topology/integrations/issuetrackingsystem?itsName=Jira
[ { "instanceId": 11101, "instanceCode": "ITS", "instanceName": "ITS Name", "issueTrackingSystemId": 1, "description": "ITS example", "isActive": true, "properties": [ { "propertyName": "JIRA_PASSWORD", "propertyValue": "*****" }, { "propertyName": "JIRA_PORT", "propertyValue": "1234" }, { "propertyName": "JIRA_TICKET_REST_PATTERN", "propertyValue": "/rest/api/2/issue/{JIRA_ISSUE}" }, { "propertyName": "JIRA_TICKET_URL_PATTERN", "propertyValue": "/browse/{JIRA_ISSUE}" }, { "propertyName": "JIRA_URL", "propertyValue": "http://myjira.atlassian.net" }, { "propertyName": "JIRA_USER_NAME", "propertyValue": "username" } ] }, { "instanceId": 11105, "instanceCode": "ITS2", "instanceName": "ITS 2 Name", "issueTrackingSystemId": 1, "description": "ITS example 2", "isActive": true, "properties": [ { "propertyName": "JIRA_PASSWORD", "propertyValue": "*****" }, { "propertyName": "JIRA_PORT", "propertyValue": "2345" }, { "propertyName": "JIRA_TICKET_REST_PATTERN", "propertyValue": "/rest/api/2/issue/{JIRA_ISSUE}" }, { "propertyName": "JIRA_TICKET_URL_PATTERN", "propertyValue": "/browse/{JIRA_ISSUE}" }, { "propertyName": "JIRA_URL", "propertyValue": "http://myjira.atlassian.net" }, { "propertyName": "JIRA_USER_NAME", "propertyValue": "admin" } ] } ]
POST
The POST service will create a new issue tracking system with the same attributes as the given JSON object. It returns the JSON representation of the issue tracking system that was just created with an updated ID attribute.
API URL
http://host:port/flexdeploy/rest/v1/topology/integrations/issuetrackingsystem
PUT
This PUT service will update all attributes of an issue tracking system with the given Id based on the attributes of the supplied JSON object.
API URL
http://host:port/flexdeploy/rest/v1/topology/integrations/issuetrackingsystem/{Id}
PATCH
This PATCH service will update the information of the Issue Tracking System of the specified Id with the non-null parameters of the JSON. The parameters that are null will not be changed in the Issue Tracking System .
API URL
http://host:port/flexdeploy/rest/v1/topology/integrations/issuetrackingsystem/{Id}
The only required attribute is the Instance Id in the URL.