API for Integration
List All Integrations
Request
EndPoint: POST /rest/admin/integration/list{type}
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
type | path | yest | Send 'all' to see all Jira Integrations | - | string |
start | body | yes | provide start | - | integer |
limit | body | yes | provide limit | - | integer |
page | body | yes | provide page | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | List of integrations shown successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Definitions
ResponseEntity
name | type | required | description | example |
|---|---|---|---|---|
headers | object | optional | - | |
body | object | optional | - | |
statusCode | string | optional | - |
Get Integration Instance Details API
Request
Endpoint: GET /rest/integration/instance/details
This API retrieves integration instance details configured for external systems like Azure DevOps or Jira.
If no request body is provided, it returns all integration instances.
If instance is provided, it returns detailed configuration including external project mappings.
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
apikey | header | Yes | API key for authentication | - | string |
project | header | Yes | Project ID / Name / Key | - | string |
orgCode | header | Yes | Organization code | - | string |
action | header | Yes | action | - | string |
scope | header | Yes | Scope | - | string |
screenName | header | Yes | Screen Name | - | string |
instance | body | Yes | Integration instance ID. If provided, returns details of the specific instance. | - | integer |
fetchFields | body | No | If true, returns field-level metadata. Works only when instance is provided. | false | boolean |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | List of integrations shown successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Definitions
Response
Field | Type | Description |
|---|---|---|
data | array | List of integration instance objects |
total | integer | Total number of instances returned |
Field | Type | Integer |
|---|---|---|
instanceId | integer | Unique ID of the integration instance |
instanceType | string | Type of integration (e.g., Azure, Jira) |
instanceUrl | string | Base URL of external system |
integratedBy | string | User who configured integration |
alias | string | Display name of the instance |
externalProjects | array | List of linked external projects (only when instance is requested) |
Field | Type | Description |
|---|---|---|
projectID | string | External project ID |
projectName | string | External project name |
modules | object | Module mapping details |
Field | Type | Description |
|---|---|---|
requirement | Object | Requirement module configuration |
issue | Object | Issue module configuration |
Field | Type | Description |
|---|---|---|
id | string | Work item type ID |
name | string | Work item type name |
jqlFilterString | string | Filter/query string |
fields | array | Field metadata (only when fetchFields=true) |
Field | Type | Description |
|---|---|---|
fieldName | string | Name |
fieldId | string | ID |
fieldType | string | Data Type |
mandatory | boolean | Required flag |
mapped | boolean | Mapping Status |