Hub 2.0 Help

Get QueryAssist

Request

GET /services/queryAssist?query=string&caret=int
Parameter Description
query

Filter query. See Query Syntax for the definition of supported logical operations syntax. Following fields and tuples are supported for services:

id: value — A service with the given id

key: value — A service with the given key

name: serviceName — A service with the given name

applicationName: serviceApplictionName — Services with the given application name

has: applicationName — Services with defined applicationName

vendor: serviceVendor — Services from the given vendor

has: vendor — Services with defined vendor

version: serviceVersion — Services of the given version

has: version — Services with defined version

homeUrl: value — Services with the given homeURL

has: homeUrl — Services with defined homeUrl

userUriPattern: value — Services with the given user uri

has: userUriPattern — Services with defined user uri

groupUriPattern: value — Services with the given group uri

has: groupUriPattern — Services with defined group uri

redirectUri: value — Services with the given redirectUri

has: redirectUri — Services with defined homeUrl

permission: permission — A service that provide the given permission

has: permission — Services that provide some permissions

defaultRole: roleName — A service that provide the given default role

has: defaultRole — Services that provide some permissions

resource: resource — A service that holds the given resource

has: resource — Services that provide some resources

is: trusted — All trusted services

has: license — Services with licenses

access(project: project, with: role) — Has the given role in the given project

access(project: project, with: permission) — Has the given permission in the given project

access(project: project) — Has any permission in the given project

access(with: role) — Has the given role in some project

access(with: permission) — Has the given permission in some project

caret Query parameter of type int.

Response

Response Code Meaning
200 OK Successful request.
400 Bad Request Some of the parameters of the request are invalid (for example, required fields in the passed JSON object are missing). The response contains message describing the error.
403 Forbidden Requester has no access to the request.
404 Not Found Requested resource wasn't found.
500 Internal Server Error Failed to process request because of the server error. The response contains message describing the error.

Response body

queryAssist

{ "query": string, "caret": int, "styleRanges": [queryStyleRange, ...], "suggestions": [querySuggestItem, ...] }
Last modified: 19 September 2016