Community articleScopes API
Added by IBM contributorIBM on February 10, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

The Scopes API returns the set of supported values that can be passed to the "scope" parameter of the Search API.
Tags: rest, search

The Scopes API returns the set of supported values that can be passed to the "scope" parameter of the Search API. Scopes relating to Connections applications that have not been installed will not be returned.

Request Format



Context Path Description
/search/atom/scopes Scopes API


Response Format



Response is ATOM formatted list of possible values that can be passed to the Search API using the "scope" parameter of the Search API.
Method URI Description
GET /search/atom/scopes The Scopes API returns the set of supported values that can be passed to the "scope" parameter of the Search API. Scopes relating to Connections applications that have not been installed will not be returned.
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.