SpiraPlan: REST Web Service (v7.0)

See all operations

POST: project-roles

Description

Allows a user to add a project role to the list of project roles. Only takes into account name, description, admin, active, discussionsAdd, SourceCodeView and permissions.

How to Execute

To access this REST web service, you need to use the following URL (make sure to replace any parameters (eg {project_id}) with the relevant value (eg 1):

https://api.inflectra.com/Spira/Services/v7_0/RestService.svc/project-roles

Request Body

Property Description
ProjectRoleId The id of the project role
Name The name of the project role
Description The description of the project role
Active Whether the role is active or not
Admin Whether the role is a project owner or not
DiscussionsAdd Can this role add discussions/comments to the project
SourceCodeView Can this role view the source code repository of the project
Permissions The collection of role permissions
Guid The unique identifier for the artifact
ConcurrencyGuid GUID for representing the concurrency state of a given artifact
LastUpdateDate Last time the artifact was updated

Return Data

The JSON and XML examples below show the shape of one entry that will be returned. It does not show an example of how that entry will be populated.

Property Description
ProjectRoleId The id of the project role
Name The name of the project role
Description The description of the project role
Active Whether the role is active or not
Admin Whether the role is a project owner or not
DiscussionsAdd Can this role add discussions/comments to the project
SourceCodeView Can this role view the source code repository of the project
Permissions The collection of role permissions
Guid The unique identifier for the artifact
ConcurrencyGuid GUID for representing the concurrency state of a given artifact
LastUpdateDate Last time the artifact was updated