Help Contents
-
System Administration
-
User Guide & Application Administration Guide
-
Using Enterprise Tester
-
Application Administration
-
Searching & TQL
-
API
-
API / Permissions
-
Features
-
Resources
-
Agile Run
-
Agile Run All Relationships
-
Agile Run Relationships
-
Agile Runs
-
Agile Run Step Attachments
-
Agile Run Step Incident
-
Agile Run Step Incidents
-
Agile Run Step Result Attachment
-
API / Resources / Resources / Search #1
-
API / Resources / Resources / Search #2
-
Assigned To Search
-
Attachment Contents
-
Automated Test
-
Automated Test All Relationships
-
Automated Test Assignment
-
Automated Test Assignment All Relationships
-
Automated Test Assignment Relationships
-
Automated Test Assignment Runs
-
Automated Test Assignments
-
Automated Test Relationships
-
Automated Test Run
-
Automated Test Run Attachment
-
Automated Test Run Attachments
-
Automated Test Run Data
-
Automated Test Run Incident
-
Automated Test Run Incidents
-
Automated Test Run Node Attachment
-
Automated Test Run Node Attachments
-
Automated Test Run Result Children
-
Automated Test Run Result Node
-
Automated Test Run Result Root Nodes
-
Automated Test Runs
-
Automated Tests
-
Automated Test Schedule
-
Automated Test Schedule Import Configuration
-
Automated Test Schedule Import Configurations
-
Automated Test Schedules
-
Automated Test Schedule Schedule Configuration
-
Automated Test Schedule Schedule Configuration Run
-
Automated Test Schedule Schedule Configurations
-
Automated Test Type
-
Automated Test Types
-
Background Task
-
Background Tasks
-
Custom Field
-
Custom Fields (Resources)
-
Custom Field Type
-
Custom Field Types
-
Event Types Search
-
Execution Package
-
Execution Package Children
-
Execution Packages
-
Export File
-
External Source Metadata
-
External Sources Metadata
-
External System
-
External System's Links
-
External System Link
-
External System Link Copy
-
External System Link Field Values
-
External System Links
-
External System Links Search
-
External System Link Ticket
-
External System Link Ticket Link
-
External Systems
-
External System Type
-
External System Types
-
Grid Widget Data
-
Grid Widget State
-
Grid Widget States
-
Group
-
Group Permission Projects
-
Group Permissions
-
Groups
-
Groups Search
-
Group Users
-
Incident
-
Incident All Relationships
-
Incident Attachment
-
Incident Attachments
-
Incident Comments
-
Incident Relationships
-
Incident Relationships All Relationships
-
Incidents
-
Latest Performance Measurement
-
Mail Queue Messages
-
Mail Sender Settings
-
Notification
-
Notification Entity Type Search
-
Notifications (Resources)
-
Organisation (Resources)
-
Organisation Picklist
-
Organisation Picklist Search
-
Organisation Relationship Types
-
Organisations
-
Permission
-
Permissions (Resources)
-
Project (Resources)
-
Project Assignees
-
Project Categories
-
Project Category
-
Project Category Children
-
Project Group Permissions
-
Project Picklist
-
Project Picklist Search
-
Projects
-
Projects Search
-
Project Templates
-
Project Tickets
-
Project User Permissions
-
Relationship (Resources)
-
Relationships (Resources)
-
Relationship Type (Resources)
-
Relationship Types
-
Requirement
-
Requirement All Relationships
-
Requirement Attachment
-
Requirement Attachments
-
Requirement Children
-
Requirement Comments
-
Requirement Package
-
Requirement Package Children
-
Requirement Packages
-
Requirement Relationships
-
Requirements (Resources)
-
Resources / Custom Fields
-
Resources / Notifications
-
Resources / Organisation
-
Resources / Permissions
-
Resources / Project
-
Resources / Relationship
-
Resources / Relationships
-
Resources / Relationship Type
-
Resources / Requirements
-
Resources / Script
-
Resources / Search
-
Resources / Widgets
-
Root
-
Rover Execution Tree
-
Rover Licensing Info
-
Script's Assignments
-
Script (Resources)
-
Script All Relationships
-
Script Assignment
-
Script Assignment All Relationships
-
Script Assignment Relationships
-
Script Assignment Runs
-
Script Assignments
-
Script Attachment
-
Script Attachments
-
Script Package
-
Script Package Children
-
Script Packages
-
Script Relationships
-
Script Run
-
Script Runs
-
Scripts
-
Search (Resources)
-
Search Index
-
Search Indexes
-
Step Result
-
Step Result Attachment
-
Step Result Attachments
-
Step Result Incident
-
Step Result Incidents
-
Swagger API
-
Swagger API List
-
Synchronizer Schedule
-
Synchronizer Schedule Run
-
Synchronizer Schedules
-
System Event
-
System Events
-
System Info
-
Temporary Attachment Set
-
Temporary Attachment Set Attachment
-
Temporary Attachments Set
-
Test Automated Test Assignments
-
Time Zone
-
User
-
User Groups
-
User Mail
-
User Password
-
User Permission Projects
-
User Permissions
-
Users
-
Users and Group Search
-
Users Search
-
Agile Run
-
Swagger
-
API / Permissions
-
Using Enterprise Tester
-
Platform Plugins
-
Troubleshooting
-
Earlier Versions of this Documentation
-
Support & Bug Fixes
Resource: External System ( /api/externalsystem/{id} )
Allows the retrieval of the details for a single external system (Defect Tracker, Enterprise Architect connection etc.).
This resource supports the following methods: DELETE, GET, PATCH, PUT
Methods
DELETE
Delete the external system.
Required Permissions
- Resources/ExternalLinks
Status Codes
These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successfully. |
404 - NotFound | Returned if external system does not exist. |
Delete an external system and retain references (previously synchronized entities will remain unchanged after deleting the system).
Request Headers
Key | Value | Description |
---|---|---|
Content-type | application/json | |
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | A01FC7ED-3492-4792-9A0B-E2B52FA10913 | Unique identifier of the external system to delete. |
keepReferences | true | Keep references but delete the external system (this is the default value for this parameter and can be omitted). |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Status Code
200 - OK
Delete an external system and remove references (previously synchronized entities will no longer show as being synchronized to the external system).
Request Headers
Key | Value | Description |
---|---|---|
Content-type | application/json | |
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | A01FC7ED-3492-4792-9A0B-E2B52FA10913 | Unique identifier of the external system to delete. |
keepReferences | false | Do not retain references (previously synchronized entities will have all references for this system removed). |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Status Code
200 - OK
GET
Retrieves a single external system by its identifier.
Required Permissions
- Resources/ExternalLinks
Supported Expansions
- Configuration
- ExternalSystemLinks
- FieldValues
- Widgets
- AdditionalConfigurationLinks
For more details on expansions, please see the Expand help topic.
Status Codes
These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successfully. |
404 - NotFound | Returned if external system does not exist. |
Example of fetching an external system by ID
Request Headers
Key | Value | Description |
---|---|---|
Content-type | application/json | |
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | a01fc7ed-3492-4792-9a0b-e2b52fa10913 |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
{ "Id": "a01fc7ed-3492-4792-9a0b-e2b52fa10913", "OrganisationId": null, "Name": "TFS", "Type": "TFS2010", "ConnectionType": "TFS2010", "ConnectionString": "http://tfs.mycompany.com:8080/tfs/Projects", "Enabled": true, "QualifiedName": null, "TypeDescription": null, "NumberOfLinks": 0, "Categories": [], "UserName": "remote_tfs", "HasPassword": true, "ConfigurationComplete": true, "ConfigurationProblems": [], "Self": "http://localhost/api/externalsystem/a01fc7ed-3492-4792-9a0b-e2b52fa10913" }
Status Code
200 - OK
Example of fetching an external system by ID which has configuration problems.
Request Headers
Key | Value | Description |
---|---|---|
Content-type | application/json | |
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | a01fc7ed-3492-4792-9a0b-e2b52fa10913 |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
{ "Id": "a01fc7ed-3492-4792-9a0b-e2b52fa10913", "OrganisationId": null, "Name": "TFS", "Type": "TFS2010", "ConnectionType": "TFS2010", "ConnectionString": "http://tfs.mycompany.com:8080/tfs/Projects", "Enabled": true, "QualifiedName": null, "TypeDescription": null, "NumberOfLinks": 0, "Categories": [], "UserName": null, "HasPassword": false, "ConfigurationComplete": false, "ConfigurationProblems": [ "UserName is not configured", "Password is not configured" ], "Self": "http://localhost/api/externalsystem/a01fc7ed-3492-4792-9a0b-e2b52fa10913" }
Status Code
200 - OK
PATCH
Updates the enabled state of the external system to enabled or disabled.
Required Permissions
- Resources/ExternalLinks
Supported Expansions
- Configuration
- ExternalSystemLinks
- FieldValues
- Widgets
- AdditionalConfigurationLinks
For more details on expansions, please see the Expand help topic.
Status Codes
These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successfully. |
404 - NotFound | Returned if external system does not exist. |
Enabling a disabled external system (will cause validation of external system configuration).
Request Headers
Key | Value | Description |
---|---|---|
Content-type | application/json | |
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | 744904d6-9612-4e87-a718-7b5d80c0060d | Unique identifier of the external system to update. |
Request Body
{ "Enabled": true }
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
{ "Id": "744904d6-9612-4e87-a718-7b5d80c0060d", "OrganisationId": null, "Name": "Jira", "Type": "Jira", "ConnectionType": "Jira", "ConnectionString": "http://mycompany.com:8090/", "Enabled": true, "QualifiedName": null, "TypeDescription": null, "NumberOfLinks": 0, "Categories": [], "UserName": "remote", "HasPassword": true, "ConfigurationComplete": true, "ConfigurationProblems": [], "Self": "http://localhost/api/externalsystem/744904d6-9612-4e87-a718-7b5d80c0060d" }
Status Code
200 - OK
PUT
Update the external system.
Required Permissions
- Resources/ExternalLinks
Supported Expansions
- Configuration
- ExternalSystemLinks
- FieldValues
- Widgets
- AdditionalConfigurationLinks
For more details on expansions, please see the Expand help topic.
Status Codes
These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successfully. |
404 - NotFound | Returned if external system does not exist. |
An example of updating an external system with full configuration supplied in field values (Note: we set 'Enabled' true, which will cause the configuration to be validated).
Request Headers
Key | Value | Description |
---|---|---|
Content-type | application/json | |
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | 744904d6-9612-4e87-a718-7b5d80c0060d | Unique identifier of the external system to update. |
$expand | FieldValues | Include field values in response as well. |
Request Body
{ "Type": "Jira", "Name": "Jira", "Enabled": true, "FieldValues": { "Url": "http://mycompany.com:8090/", "UserName": "remote", "Password": "password", "IgnoreInvalidRemoteCertificates": false } }
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
{ "Id": "744904d6-9612-4e87-a718-7b5d80c0060d", "OrganisationId": null, "Name": "Jira", "Type": "Jira", "ConnectionType": "Jira", "ConnectionString": "http://mycompany.com:8090/", "Enabled": true, "QualifiedName": null, "TypeDescription": null, "NumberOfLinks": 0, "Categories": [], "UserName": "remote", "HasPassword": true, "ConfigurationComplete": true, "ConfigurationProblems": [], "FieldValues": { "Url": "http://mycompany.com:8090/", "UserName": "remote", "Password": "password", "IgnoreInvalidRemoteCertificates": false }, "Self": "http://localhost/api/externalsystem/744904d6-9612-4e87-a718-7b5d80c0060d" }
Status Code
200 - OK