Hub 2018.2 Help

Get All Project Teams

Request

GET <REST API URL>/projectteams?fields=string&$skip=int&$top=int&query=string&orderBy=string
Parameter Description
fields Optional. Returns only the specified subset of the fields for each ProjectTeam. Use Fields Syntax to define the subset.
$skip Optional. Lets you set a number of ProjectTeams to skip before returning the first one.
$top Optional. Lets you set the maximum number of ProjectTeams 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 ProjectTeams, the following fields and tuples are supported:

access(project: project, with: role) — Teams that have the given role in the given project

access(project: project, with: permission) — Teams that have the given permission in the given project

access(project: project) — Teams that have some role in the given project

access(with: role) — Teams that have the given role in some projects

access(with: permission) — Teams that have the given permission in some projects

accessible(with: permission) — Teams that are accessible with the given permission

group: group — Teams containing the given group

has: ownRole — Teams with own roles

has: user — Teams with users

has: groups — Teams with included groups

id: value — Project team with the given ID

name: projectName — Team of project with the given name

ownRole: role — Teams that have the given role as an own role

project: project — Team of the given project

user: user — Teams that contain the given user

orderBy Optional. Returns the list of ProjectTeams sorted by a specified field. See Sorting Syntax for details. ProjectTeams support ordering by the following fields: 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, "projectteams": [projectTeam, ...] }
Last modified: 3 September 2018