Hub 2018.1 Help

Get All Resources

Request

GET <REST API URL>/resources?fields=string&$skip=int&$top=int&query=string&orderBy=string
Parameter Description
fields Optional Lets you specify a subset of the fields to be returned. Use Fields Syntax to define the subset.
$skip Optional Lets you set a number of entries to skip before returning the first entry of the page.
$top Optional Lets you set the maximum number of entries to return in the page.
query

Optional Lets you 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 Lets you order the returned results. 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 Some of the parameters of the request are invalid (for example, required fields in the passed JSON object are missing). The response contains a message that describes the error.
403 Forbidden Requester has no access to the request.
404 Not Found Requested resource was not found.
500 Internal Server Error Failed to process request because of the server error. The response contains a message that describes the error.

Response body

page

{ "skip": int, "top": int, "total": int, "resources": [resource, ...] }
Last modified: 5 April 2018