Resource: External System Links Search ( /api/project/{projectId}/searchlinks )
Allows the searching of all external systems for a project by partial match.
Root Relation: ProjectExternalSystemLinksSearch
This resource supports the following methods: GET, POST
Methods
GET
Searches for externa links by partial name match
Required Permissions
- TestManagement/View
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 search request was able to be satisfied. |
An example of searching for project external system links.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
query | jo | The partial external system link name |
$skip | 20 | Number of items to skip (start result number) |
$top | 10 | Number of search results to return |
$inlinecount | allpages | Include or supress inline counts |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
{ "Skip": 20, "Top": 10, "Total": 1, "Items": [ { "ExternalSystemId": "0df3c581-599d-41da-95a6-2e79ff9676dc", "ProjectId": "b8992d43-6e24-4b75-93b8-25168c7e64af", "ProjectName": "Project X", "Id": "3464e9da-f1b7-49aa-87db-7e1eebfd17a5", "Type": "Incident", "TypeForDisplay": "Incident", "ExternalSystemName": "Jira PROD", "ExternalSystemImplementationType": "JIRA5", "ExternalSystemConnectionType": "Incident", "Name": "Project X Incidents", "Enabled": true, "LastSynchronizedAt": "2013-01-01T14:04:05Z", "LastDestinationToSourceSynchronizationAt": null, "LastSourceToDestinationSynchronizationAt": null, "DefectTrackerProjectId": "123", "ConfigurationComplete": true, "ConfigurationProblems": [], "AutoSelect": "NotApplicable", "Expands": [ "Configuration", "ExternalSystem" ], "Self": "http://localhost/api/externalsystemlink/3464e9da-f1b7-49aa-87db-7e1eebfd17a5", "Links": [ { "Title": "Configuration Editor", "Href": "http://localhost/api", "Rel": "Edit" } ] } ], "Self": "http://localhost/api/project/B8992D43-6E24-4B75-93B8-25168C7E64AF/searchlinks?query=proj&$skip=20&$top=10&$inlinecount=allpages", "Links": [ { "Href": "http://localhost/api/project/B8992D43-6E24-4B75-93B8-25168C7E64AF/searchlinks?query=proj&$skip=10&$top=10&$inlinecount=allpages", "Rel": "prev" }, { "Href": "http://localhost/api/project/B8992D43-6E24-4B75-93B8-25168C7E64AF/searchlinks?query=proj&$skip=0&$top=10&$inlinecount=allpages", "Rel": "first" } ] }
Status Code
200 - OK
POST
Searches for external links by partial name match (using POST to allow large existing value queries).
Required Permissions
- TestManagement/View
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 search request was able to be satisfied. |
An example of searching for project external system links.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
query | jo | The partial external system link name |
$skip | 20 | Number of items to skip (start result number) |
$top | 10 | Number of search results to return |
$inlinecount | allpages | Include or supress inline counts |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=utf-8 |
Response Body
{ "Skip": 20, "Top": 10, "Total": 1, "Items": [ { "ExternalSystemId": "0df3c581-599d-41da-95a6-2e79ff9676dc", "ProjectId": "b8992d43-6e24-4b75-93b8-25168c7e64af", "ProjectName": "Project X", "Id": "3464e9da-f1b7-49aa-87db-7e1eebfd17a5", "Type": "Incident", "TypeForDisplay": "Incident", "ExternalSystemName": "Jira PROD", "ExternalSystemImplementationType": "JIRA5", "ExternalSystemConnectionType": "Incident", "Name": "Project X Incidents", "Enabled": true, "LastSynchronizedAt": "2013-01-01T14:04:05Z", "LastDestinationToSourceSynchronizationAt": null, "LastSourceToDestinationSynchronizationAt": null, "DefectTrackerProjectId": "123", "ConfigurationComplete": true, "ConfigurationProblems": [], "AutoSelect": "NotApplicable", "Expands": [ "Configuration", "ExternalSystem" ], "Self": "http://localhost/api/externalsystemlink/3464e9da-f1b7-49aa-87db-7e1eebfd17a5", "Links": [ { "Title": "Configuration Editor", "Href": "http://localhost/api", "Rel": "Edit" } ] } ], "Self": "http://localhost/api/project/B8992D43-6E24-4B75-93B8-25168C7E64AF/searchlinks?$skip=20&$top=10&$inlinecount=allpages", "Links": [ { "Href": "http://localhost/api/project/B8992D43-6E24-4B75-93B8-25168C7E64AF/searchlinks?$skip=10&$top=10&$inlinecount=allpages", "Rel": "prev" }, { "Href": "http://localhost/api/project/B8992D43-6E24-4B75-93B8-25168C7E64AF/searchlinks?$skip=0&$top=10&$inlinecount=allpages", "Rel": "first" } ] }
Status Code
200 - OK