Get All Resources
Request
GET <REST API URL>/resources?fields=string&$skip=int&$top=int&query=string&orderBy=stringParameter | Description |
|---|---|
fields | Optional. Returns only the specified subset of the fields for each Resource. Use Fields Syntax to define the subset. |
$skip | Optional. Lets you set a number of Resources to skip before returning the first one. |
$top | Optional. Lets you set the maximum number of Resources to return. |
query | Optional. Lets you specify a search query to filter the returned results. See Query Syntax for the definition of supported logical operations syntax. For the Resources, the following fields and tuples are supported: has: type — Resources with some type has: homeUrl — Resources with some homeURL homeUrl: value — Resource with the given home URL id: value — Resource with the given ID key: resourceKey — Resources with the given key name: resourceName — Resources with the given name project: project — Resources in the given project service: service — Resources provided by the given service type: resourceType — Resources of the given type |
orderBy | Optional. Returns the list of Resources sorted by a specified field. See Sorting Syntax for details. Resources support ordering by the following fields: key, name, project, service, type |
Response
Response Code | Meaning |
|---|---|
200 OK | Successful request. |
400 Bad Request | At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response. |
403 Forbidden | The requester has no access to the requested resource. |
404 Not Found | The requested resource was not found. |
500 Internal Server Error | Failed to process request because of the server error. For details, check the error message in the response. |
Response body
{
"skip": int,
"top": int,
"total": int,
"resources": [resource, ...]
}