Resource: External System Types ( /api/externalsystemtypes )
This is the collection resource which allows the search and retrieval of external system types.
Root Relation: ExternalSystemTypes
This resource supports the following methods: GET
Methods
GET
Retrieves all (or a subset) of external system types.
This method supports the OData parameters $filter, $top, $take, $orderby and $inlinecount. See OData Topic for more details.
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. |
Example - GET
Retrieve all external system types.
Request Headers
Key | Value | Description |
---|---|---|
Content-type | application/json | |
Accept | application/json |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
{ "Skip": 0, "Top": 25, "Total": 3, "Items": [ { "Id": "Jira", "Name": "Jira", "Categories": [ "DefectTracker" ], "Self": "http://localhost/api/externalsystemtype/Jira" }, { "Id": "TFS2010", "Name": "TFS 2010", "Categories": [ "DefectTracker" ], "Self": "http://localhost/api/externalsystemtype/TFS2010" }, { "Id": "EnterpriseArchitect", "Name": "Enterprise Architect", "Categories": [ "CaseModelingTool" ], "Self": "http://localhost/api/externalsystemtype/EnterpriseArchitect" } ], "Self": "http://localhost/api/api/externalsystemtypes" }
Status Code
200 - OK