Hub 2018.3 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. Returns only the specified subset of the fields for each FavoriteProject. Use Fields Syntax to define the subset.

$skip

Optional. Lets you set a number of FavoriteProjects to skip before returning the first one.

$top

Optional. Lets you set the maximum number of FavoriteProjects 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 FavoriteProjects, the following fields and tuples are supported:

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

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

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

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

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

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

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

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

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

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

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

after: instant — Projects created after the specified moment

before: instant — Projects created before the specified moment

favorite(for: user) — Returns favorite projects of the specified 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 specified key

name: projectName — Project with the specified name

resource: resource — Project with the specified resource

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

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

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

orderBy

Optional. Returns the list of FavoriteProjects sorted by a specified field. 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

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