Hub 2018.1 Help

Get All Favorite Projects of a User

Request

GET <REST API URL>/users/{user id}/favoriteprojects?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 FavoriteProjects, the following fields and tuples are supported:

accessible(for: user, with: role) — Projects where the given user has the given role

accessible(for: group, with: role) — Projects where the given group has the given role

accessible(for: service, with: role) — Projects where the given service has the given role

accessible(for: user, with: permission) — Projects where the given user has the given permission

accessible(for: group, with: permission) — Projects where the given group has the given permission

accessible(for: service, with: permission) — Projects where the given service has the given permission

accessible(for: user) — Projects where the given user has any permission

accessible(for: group) — Projects where the given group has any permission

accessible(for: service) — Projects where the given service has any permission

accessible(with: role) — Projects where somebody has the given role

accessible(with: permission) — Projects where somebody has the given permission

after: instant — Projects created after the given moment

before: instant — Projects created before the given moment

favorite(for: user) — Favorite projects of the given user

has: resource — Projects with resources

id: value — Project with the given ID

is: global — Global project

is: archived — Archived project

is: favorite — My favorite project

key: projectKey — Project with the given key

name: projectName — Project with the given name

resource: resource — Project with the given resource

resource(key: resourceKey, service: service) — Projects with the given resource of service

resource(service: service) — Projects with resources of the service

resource(name: resourceName, service: service) — Projects with the given resource of service

orderBy Optional Lets you order the returned results. See Sorting Syntax for details. FavoriteProjects support ordering by the following fields: creationTime, key, name

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, "favoriteprojects": [project, ...] }
Last modified: 5 April 2018