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.
...
Request
Parameter | Required | Type | Description |
---|---|---|---|
Id | Yes | URL | URL parameter for the Id which is used to find and return an issue tracking system |
Include Page | ||||
---|---|---|---|---|
|
Response Codes
HTTP Code | Description |
---|---|
200 | Change manage system instance was found and returned |
400 | Bad request |
401 | Authentication failure |
403 | Authorization failure (no access to resource) |
404 | Change manage system instance not found |
500 | Unexpected internal server error |
Expand | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
ExampleIf we had an Issue Tracking System in our database with an Id of 11101 with the following attributes
When we run a GET request at the following URL
The GET request would return the following JSON Issue Tracking System object
|
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.
Info | ||
---|---|---|
| ||
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} |
Tip |
---|
The query parameters are not case sensitive. Searching by instanceName=NAME is the same as searching by instanceName=name. |
Request
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 |
Include Page | ||||
---|---|---|---|---|
|
Response Codes
HTTP Code | Description |
---|---|
200 | Change manage system instances were found and Search successful and results returned |
400 | Bad request |
401 | Authentication failure |
403 | Authorization failure (no access to resource) |
500 | Unexpected internal server error |
Example
...