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: applicationName: serviceApplicationName — Services with the given application name baseUrl: value — Services with the given base URL defaultRole: roleName — Services that define the given role groupUriPattern: value — Services with the given group URI pattern 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: baseUrl — Services with defined baseUrl has: userUriPattern — Services with defined user uri has: groupUriPattern — Services with defined group uri has: redirectUri — Services with defined redirect URI has: permission — Services that provide some permissions has: defaultRole — Services that define some default roles has: resource — Services that provide some resources has: license — Services with licenses homeUrl: value — Services with the given home URL id: value — Service with the given ID is: trusted — All trusted services key: value — Service with the given key name: serviceName — Services with the given name permission: permission — Services with the given home URL redirectUri: value — Services with the given redirect URI resource: resource — Service that provides the given resource userUriPattern: value — Services with the given user URI pattern vendor: serviceVendor — Services provided by the given vendor |
orderBy | Order results. See Sorting Syntax for details. Roles can be ordered by the following fields: applicationName, key, name, 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. |