Get All Projects
Request
Parameter | Description |
---|---|
fields | Optional query parameter. Specifies a subset of the fields to be returned. Use Fields Syntax to define the subset. |
$skip | Optional query parameter. Number of projects to skip before returning the first entry in the page. |
$top | Optional query parameter. Maximum number of projects 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: id: value — A project with the given id 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(service: service) — Projects with resources of the service has: resource — Projects with resources is: archived — Archived project 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 |
orderBy | Order results. See Sorting Syntax for details. Projects can be ordered by the following fields: key, name |
archived | Query parameter of type boolean. |
Response
Response body
page
{
"skip": int, /* Requested number of projects to skip before returning the first entry in the page */
"top": int, /* Requested maximum number of projects to return in the page */
"total": int, /* Total number of projects. Returned only if the total field is included as a value of the fields parameter in the query */
"projects": [project, ...]
}