Hub 2018.2 Help

Get All Project Roles of a Service

Request

GET <REST API URL>/services/{service id}/projectroles?fields=string&$skip=int&$top=int&query=string&orderBy=string
Parameter Description
fields Optional. Returns only the specified subset of the fields for each ProjectRole. Use Fields Syntax to define the subset.
$skip Optional. Lets you set a number of ProjectRoles to skip before returning the first one.
$top Optional. Lets you set the maximum number of ProjectRoles 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 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. Returns the list of ProjectRoles sorted by a specified field. 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 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, "projectroles": [projectRole, ...] }
Last modified: 3 September 2018