Get All Projects
Request
GET <REST API URL>/projects?fields=string&$skip=int&$top=int&query=string&orderBy=string&archived=boolean| Parameter | Description |
|---|---|
fields | Optional query parameter. Specifies a subset of the fields to be returned. Use Fields Syntax to define subset. |
$skip | Optional query parameter. Number of roles to skip before returning first entry of the page. |
$top | Optional query parameter. Max number of roles 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 Projects: 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 has: resource — Projects with resources id: value — A project with the given id is: archived — Archived project key: projectKey — A project with the given key name: projectName — A project with the given name resource: resource — Projects with the given resource resource(key: resourceKey, service: service) — Projects with the given resource of service resource(name: resourceName, service: service) — Projects with the given resource of service resource(service: service) — Projects with resources of the service |
orderBy | Order results. See Sorting Syntax for details. Roles can be ordered by the following fields: key, name |
archived | Query parameter of type boolean. |
Response
Response body
page
{ "skip": int, "top": int, "total": int, "projects": [project, ...] }