SearchResource Resource

RESTful Web Service Resource to search users and groups. This endpoint can be used to implement typeahead input fields for permissions.

GET /api/rest/search/groups

Returns a list of groups found by the given search string.

Request Parameters
name type description
query query the search string
Response Codes
code condition
200 success
500 internal server error
Response Body
media type data type
application/json SearchResults (JSON)
application/xml searchResults (XML)

Example

Request
GET /search/groups
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "results" : [ {
    "label" : "...",
    "value" : "..."
  }, {
    "label" : "...",
    "value" : "..."
  } ],
  "success" : true
}
                
              

GET /api/rest/search/users

Returns a list of users found by the given search string.

Request Parameters
name type description
query query the search string
Response Codes
code condition
200 success
500 internal server error
Response Body
media type data type
application/json SearchResults (JSON)
application/xml searchResults (XML)

Example

Request
GET /search/users
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "results" : [ {
    "label" : "...",
    "value" : "..."
  }, {
    "label" : "...",
    "value" : "..."
  } ],
  "success" : true
}