Hub 2018.1 Help

Get All Project Roles of a User Group

Request

GET <REST API URL>/usergroups/{user group id}/projectroles?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 ProjectRoles, the following fields and tuples are supported:

group: group — Project roles owned by the given group

id: value — Role in project with the given ID

permission: permission — Project roles granted with the given permission

project: project — Project roles granted for the given project

role: role — Project roles granted with the given role

team: project — Project roles owned by the given project team

user: user — Project roles owned by the given user

orderBy Optional Lets you order the returned results. See Sorting Syntax for details. ProjectRoles support ordering by the following fields: project, role

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