/
Issue Tracking System Instance API

Issue Tracking System Instance API

Dec 02, 2022

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 Topology REST API page.

JIRA

Property Name

Type

Required

Description

Example Property Value

Property Name

Type

Required

Description

Example Property Value

JIRA_USER_NAME

String

Yes

User name to login into the JIRA server

username

JIRA_PASSWORD

String

Yes

API token or password to login into the JIRA server. Jira Documentation contains more information on generating API tokens.

password

JIRA_PORT

Integer

Yes

Port to access the JIRA system

1234

JIRA_TICKET_REST_PATTERN

String

Yes

Pattern to update/retrieve information on a given JIRA ticket on the JIRA server

/rest/api/2/issue/{JIRA_ISSUE}

JIRA_TICKET_URL_PATTERN

String

Yes

Pattern to link to a given JIRA ticket on the JIRA server

/browse/{JIRA_ISSUE}

JIRA_URL

String

Yes

URL to the JIRA system

http://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

Id

Yes

URL

URL parameter for the Id which is used to find and return an issue tracking system

Response Codes

HTTP Code

Description

HTTP Code

Description

200

Issue Tracking System instance was found and returned

400

Bad request

401

Authentication failure

403

Authorization failure (no access to resource)

404

Issue Tracking System instance not found

500

Unexpected internal server error

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": "*****", "credentialId": 45845 }, { "propertyName": "JIRA_PORT", "propertyValue": "1234", "credentialId": null }, { "propertyName": "JIRA_TICKET_REST_PATTERN", "propertyValue": "/rest/api/2/issue/{JIRA_ISSUE}", "credentialId": null }, { "propertyName": "JIRA_TICKET_URL_PATTERN", "propertyValue": "/browse/{JIRA_ISSUE}", "credentialId": null }, { "propertyName": "JIRA_URL", "propertyValue": "http://myjira.atlassian.net", "credentialId": null }, { "propertyName": "JIRA_USER_NAME", "propertyValue": "username", "credentialId": null } ] } 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": "*****", "credentialId": 45845 }, { "propertyName": "JIRA_PORT", "propertyValue": "1234", "credentialId": null }, { "propertyName": "JIRA_TICKET_REST_PATTERN", "propertyValue": "/rest/api/2/issue/{JIRA_ISSUE}", "credentialId": null }, { "propertyName": "JIRA_TICKET_URL_PATTERN", "propertyValue": "/browse/{JIRA_ISSUE}", "credentialId": null }, { "propertyName": "JIRA_URL", "propertyValue": "http://myjira.atlassian.net", "credentialId": null }, { "propertyName": "JIRA_USER_NAME", "propertyValue": "username", "credentialId": null } ] }

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

Parameter

Required

Type

Description

instanceCode

No

Query - String

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

Equals ignore case search

instanceName

No

Query - String

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

Contains ignore case search

itsName

No

Query - 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 Codes

HTTP Code

Description

HTTP Code

Description

200

Search successful and results returned

400

Bad request

401

Authentication failure

403

Authorization failure (no access to resource)

500

Unexpected internal server error

The following macros are not currently supported in the footer:
  • style