Hub 2.5 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 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 ProjectRoles:

id: value — A project role with the given id

project: project — Project roles granted for the given project

role: role — Project roles granted with the given role

user: user — Project roles owned by the given user

group: group — Project roles owned by the given group

service: service — Project roles owned by the given service

orderBy Order results. See Sorting Syntax for details. Roles can be ordered 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 message describing the error.
403 Forbidden Requester has no access to the request.
404 Not Found Requested resource wasn't found.
500 Internal Server Error Failed to process request because of the server error. The response contains message describing the error.

Response body

page

{ "skip": int, "top": int, "total": int, "projectroles": [projectRole, ...] }
Last modified: 20 September 2016