Hub 2017.2 Help

Get All Services

Request

GET <REST API URL>/services?fields=string&$skip=int&$top=int&query=string&orderBy=string
Parameter Description
fields Optional query parameter. Specifies a subset of the fields to be returned. Use Fields Syntax to define subset.
$skip Optional query parameter. Number of roles to skip before returning first entry of the page.
$top Optional query parameter. Max number of roles to return in the page.
query

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

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

applicationName: serviceApplictionName — Services with the given application name

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

groupUriPattern: value — Services with the given group uri

has: applicationName — Services with defined applicationName

has: vendor — Services with defined vendor

has: version — Services with defined version

has: homeUrl — Services with defined homeUrl

has: userUriPattern — Services with defined user uri

has: groupUriPattern — Services with defined group uri

has: redirectUri — Services with defined homeUrl

has: permission — Services that provide some permissions

has: defaultRole — Services that provide some permissions

has: resource — Services that provide some resources

has: license — Services with licenses

homeUrl: value — Services with the given homeURL

id: value — A service with the given id

is: trusted — All trusted services

key: value — A service with the given key

name: serviceName — A service with the given name

permission: permission — A service that provide the given permission

redirectUri: value — Services with the given redirectUri

resource: resource — A service that holds the given resource

userUriPattern: value — Services with the given user uri

vendor: serviceVendor — Services from the given vendor

version: serviceVersion — Services of the given version

orderBy Order results. See Sorting Syntax for details. Roles can be ordered by the following fields: name, key, applicationName, vendor

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

page

{ "skip": int, "top": int, "total": int, "services": [service, ...] }
Last modified: 19 July 2017