Issue Tracking System Instance API

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.

Authentication - Use Basic Authentication for this API.

JIRA

Property NameTypeRequiredDescriptionExample Property Value
JIRA_USER_NAMEStringYesUser name to login into the JIRA serverusername
JIRA_PASSWORDStringYesAPI token or password to login into the JIRA server. Jira Documentation contains more information on generating API tokens.password
JIRA_PORTIntegerYesPort to access the JIRA system1234
JIRA_TICKET_REST_PATTERNStringYesPattern to update/retrieve information on a given JIRA ticket on the JIRA server/rest/api/2/issue/{JIRA_ISSUE}
JIRA_TICKET_URL_PATTERNStringYesPattern to link to a given JIRA ticket on the JIRA server/browse/{JIRA_ISSUE}
JIRA_URLStringYesURL to the JIRA systemhttp://myjira.atlassian.net

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/itsinstance/{Id}

Request

Parameter
Required
Type
Description
IdYesURLURL parameter for the Id which is used to find and return an issue tracking system

Response

Attributes
Type
Required
Description
instanceIdIntegerNoPrimary ID of the Issue Tracking System, created when first making an Issue Tracking System.
instanceCodeStringYesThe code of the Issue Tracking System
instanceNameStringYesThe name of the Issue Tracking System
issueTrackingSystemIdIntegerYesThe ID of the type of Issue Tracking System
descriptionStringNoThe description of the Issue Tracking System
isActiveBooleanNoWhether or not this Issue Tracking System is active.
propertiesList<PropertyValue>NoThe properties associated with the type of Issue Tracking System

Each JSON ITS instance object contains a list of property value. The property value object has these attributes.

AttributesTypeDescription
propertyNameStringThis is the name of the property
propertyValueStringThis is the value of the property

Response Codes

HTTP CodeDescription
200Change manage system instance was found and returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Change manage system instance not found
500Unexpected internal server error
 GET by ID Example

Example

If we had an Issue Tracking System in our database with an Id of 11101 with the following attributes

Issue Tracking System - 11101
{
	"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"
		}
	]
}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/v1/topology/integrations/itsinstance/11101

The GET request would return the following JSON Issue Tracking System object

Issue Tracking System - 11101
{
	"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"
		}
	]
}

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/itsinstance?

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/itsinstance?instanceCode={instanceCode}

To specify the code and name parameters:

http://host:port/flexdeploy/rest/v1/topology/integrations/itsinstance?instanceCode={instanceCode}&instanceName={instanceName}

To specify the issue tracking system name only:

http://host:port/flexdeploy/rest/v1/topology/integrations/itsinstance?itsName={itsName}

The query parameters are not case sensitive. Searching by instanceName=NAME is the same as searching by instanceName=name.

Request

Parameter
Required
Type
Description
instanceCodeNoQuery - String

This is a URL query parameter for the instance code which is used to search the issue tracking systems.

Equals ignore case search

instanceNameNoQuery - String

This is a URL query parameter for the instance name which is used to search the issue tracking systems.

Contains ignore case search

itsNameNoQuery - String

This is a URL query parameter for the issue tracking system name which is used to search the issue tracking systems.

Equals ignore case search

Response

Attributes
Type
Required
Description
instanceIdIntegerNoPrimary ID of the Issue Tracking System, created when first making an Issue Tracking System.
instanceCodeStringYesThe code of the Issue Tracking System
instanceNameStringYesThe name of the Issue Tracking System
issueTrackingSystemIdIntegerYesThe ID of the type of Issue Tracking System
descriptionStringNoThe description of the Issue Tracking System
isActiveBooleanNoWhether or not this Issue Tracking System is active.
propertiesList<PropertyValue>NoThe properties associated with the type of Issue Tracking System

Each JSON ITS instance object contains a list of property value. The property value object has these attributes.

AttributesTypeDescription
propertyNameStringThis is the name of the property
propertyValueStringThis is the value of the property

Response Codes

HTTP CodeDescription
200Search successful and results returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error

Example

Output when the Group Code was made "Group" through http://host:port/flexdeploy/rest/v1/topology/integrations/itsinstance?itsName=Jira

Issue Tracking System - 11101
[
	{
		"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/itsinstance

Request

Attributes
Type
Required
Description
instanceCodeStringYesThe code of the Issue Tracking System.
instanceNameStringYesThe name of the Issue Tracking System.
issueTrackingSystemIdIntegerYesThe ID of the type of Issue Tracking System.
descriptionStringNoThe description of the Issue Tracking System.
isActiveBooleanYesWhether or not this Issue Tracking System is active. Defaults to true.
propertiesList<PropertyValue>DependsThe properties associated with the type of Issue Tracking System: requirements depend on the Issue Tracking System selected.

Response

Attributes
Type
Required
Description
instanceIdIntegerNoPrimary ID of the Issue Tracking System, created when first making an Issue Tracking System.
instanceCodeStringYesThe code of the Issue Tracking System
instanceNameStringYesThe name of the Issue Tracking System
issueTrackingSystemIdIntegerYesThe ID of the type of Issue Tracking System
descriptionStringNoThe description of the Issue Tracking System
isActiveBooleanNoWhether or not this Issue Tracking System is active.
propertiesList<PropertyValue>NoThe properties associated with the type of Issue Tracking System

Each JSON ITS instance object contains a list of property value. The property value object has these attributes.

AttributesTypeDescription
propertyNameStringThis is the name of the property
propertyValueStringThis is the value of the property

Response Codes

HTTP CodeDescription
201Change manage system instance was created successfully
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error
 POST Example

If the POST receives the following JSON issue tracking system object,

Issue Tracking System - 11101
{
	"instanceId": 1,
	"instanceCode": "ITS",
	"instanceName": "ITS Name",
	"issueTrackingSystemId": 1,
	"description": "ITS example",
	"isActive": true,
	"properties":
	[
		{
			"propertyName": "JIRA_PASSWORD",
			"propertyValue": "password"
		},
		{
			"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"
		}
	]
}

the following Issue Tracking System will be created in the database and returned. Notice the updated Instance Id field and changed password.

Issue Tracking System - 11101
{
	"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"
		}
	]
}

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/itsinstance/{Id}

Request

Attributes
Type
Required
Description
instanceCodeStringYesThe code of the Issue Tracking System.
instanceNameStringYesThe name of the Issue Tracking System.
issueTrackingSystemIdIntegerYesThe ID of the type of Issue Tracking System.
descriptionStringNoThe description of the Issue Tracking System.
isActiveBooleanYesWhether or not this Issue Tracking System is active. Defaults to true.
propertiesList<PropertyValue>Depends

The properties associated with the type of Issue Tracking System: requirements depend on the Issue Tracking System selected.

The JSON object must have all of the properties of the instance's ITS. Value for properties not included in input request will be cleared.

Response

Attributes
Type
Required
Description
instanceIdIntegerNoPrimary ID of the Issue Tracking System, created when first making an Issue Tracking System.
instanceCodeStringYesThe code of the Issue Tracking System
instanceNameStringYesThe name of the Issue Tracking System
issueTrackingSystemIdIntegerYesThe ID of the type of Issue Tracking System
descriptionStringNoThe description of the Issue Tracking System
isActiveBooleanNoWhether or not this Issue Tracking System is active.
propertiesList<PropertyValue>NoThe properties associated with the type of Issue Tracking System

Each JSON ITS instance object contains a list of property value. The property value object has these attributes.

AttributesTypeDescription
propertyNameStringThis is the name of the property
propertyValueStringThis is the value of the property

Response Codes

HTTP CodeDescription
200Change manage system instance was found and updated
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Change manage system instance not found
500Unexpected internal server error
 PUT Example

Example

If we had an issue tracking system in our database with an Id of 11223 and had the following attributes

Issue Tracking System - 11223
{
	"instanceId": 11223,
	"instanceCode": "ITS",
	"instanceName": "ITS Name",
	"issueTrackingSystemId": 1,
	"description": "ITS example",
	"isActive": false,
	"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"
		}
	]
}

When we run a PUT request at the following URL

http://host:port/flexdeploy/rest/v1/topology/integrations/itsinstance/11223

And the PUT request receives the following JSON issue tracking system object,

Issue Tracking System - 11223
{
	"instanceId": 1,
	"instanceCode": "NEWITS",
	"instanceName": "New Name",
	"issueTrackingSystemId": 1,
	"description": "PUT example",
	"isActive": true,
	"properties":
	[
		{
			"propertyName": "JIRA_PASSWORD",
			"propertyValue": "updatedpassword"
		},
		{
			"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"
		}
	]
}

The PUT request would then update the Issue Tracking System with Id 11223 and return the  following JSON Issue Tracking System object.

Issue Tracking System - 11223
{
	"instanceId": 11223,
	"instanceCode": "NEWITS",
	"instanceName": "New Name",
	"issueTrackingSystemId": 1,
	"description": "PUT 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"
		}
	]
}

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/itsinstance/{Id}

The only required attribute is the Instance Id in the URL.

Request

Attributes
Type
Required
Description
instanceCodeStringNoThe code of the Issue Tracking System.
instanceNameStringNoThe name of the Issue Tracking System.
issueTrackingSystemIdIntegerNoThe ID of the type of Issue Tracking System.
descriptionStringNoThe description of the Issue Tracking System.
isActiveBooleanNoWhether or not this Issue Tracking System is active. Defaults to true.
propertiesList<PropertyValue>No

The properties associated with the type of Issue Tracking System: requirements depend on the Issue Tracking System selected.

The JSON object doesn't need to have all of the properties of the ITS. Values provided in input list are the only ones updated.

Response

Attributes
Type
Required
Description
instanceIdIntegerNoPrimary ID of the Issue Tracking System, created when first making an Issue Tracking System.
instanceCodeStringYesThe code of the Issue Tracking System
instanceNameStringYesThe name of the Issue Tracking System
issueTrackingSystemIdIntegerYesThe ID of the type of Issue Tracking System
descriptionStringNoThe description of the Issue Tracking System
isActiveBooleanNoWhether or not this Issue Tracking System is active.
propertiesList<PropertyValue>NoThe properties associated with the type of Issue Tracking System

Each JSON ITS instance object contains a list of property value. The property value object has these attributes.

AttributesTypeDescription
propertyNameStringThis is the name of the property
propertyValueStringThis is the value of the property

Response Codes

HTTP CodeDescription
200Change manage system instance was found and updated
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Change manage system instance not found
500Unexpected internal server error
 PATCH Example

Example

If we had an issue tracking system in our database with an Id of 11223 and had the following attributes

Issue Tracking System - 11223
{
	"instanceId": 11223,
	"instanceCode": "NEWITS",
	"instanceName": "New Name",
	"issueTrackingSystemId": 1,
	"description": "PUT 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"
		}
	]
}

When we run a PATCH request at the following URL

http://host:port/flexdeploy/rest/v1/topology/integrations/itsinstance/11223

And the PATCH request receives the following JSON issue tracking system object,

Issue Tracking System - 11223
{
	"instanceId": null,
	"instanceCode": null,
	"instanceName": "Updated Password",
	"issueTrackingSystemId": null,
	"description": null,
	"isActive": null,
	"properties":
	[
		{
			"propertyName": "JIRA_PASSWORD",
			"propertyValue": "newpassword"
		}
	]
}

The PATCH request would then update the issue tracking system with Id 11223 and return the  following JSON issue tracking system object.

Issue Tracking System - 11223
{
	"instanceId": 11223,
	"instanceCode": "NEWITS",
	"instanceName": "Updated Password",
	"issueTrackingSystemId": 1,
	"description": "PUT 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"
		}
	]
}
The following macros are not currently supported in the footer:
  • style