Get All Resources of a Service
Request
GET /services/{service id}/resources?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 the subset. |
$skip | Optional query parameter. Number of resources to skip before returning the first entry in the page. |
$top | Optional query parameter. Maximum number of resources 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 resources: id: value — A resource with the given id name: resourceName — A resource with the given name key: resourceKey — A resource with the given key type: resourceType — Resources of the given type has: type — Resources with some type homeUrl: value — A resource with the given homeURL has: homeUrl — Resources with some homeURL service: service — Resources held by the given service |
orderBy | Order results. See Sorting Syntax for details. Resources can be ordered by the following fields: key, name, type |
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, /* Requested number of resources to skip before returning the first entry in the page */
"top": int, /* Requested maximum number of resources to return in the page */
"total": int, /* Total number of resources. Returned only if the total field is included as a value of the fields parameter in the query */
"resources": [resource, ...]
}
Last modified: 19 April 2016