SpiraPlan: REST Web Service (v5.0)

See all operations

POST: projects/{project_id}/requirements/{requirement_id}/comments

Description

Creates a new comment for a requirement.

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/v5_0/RestService.svc/projects/{project_id}/requirements/{requirement_id}/comments

Request Parameters

Name Description
project_id
requirement_id

Request Body

Property Description
CommentId The unique ID for this comment / artifact type.
ArtifactId The artifact ID that this comment belongs to.
UserId The userID of the author. The authenticated user is used if no value provided
UserName The full name of the author.
Text The text of the comment.
CreationDate The date and time the comment was made.
IsDeleted Whether the comment was marked for deletion or hidden.Not currently used, should remain false.
IsPermanent Whether the comment can be deleted or is a permanent one

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
CommentId The unique ID for this comment / artifact type.
ArtifactId The artifact ID that this comment belongs to.
UserId The userID of the author. The authenticated user is used if no value provided
UserName The full name of the author.
Text The text of the comment.
CreationDate The date and time the comment was made.
IsDeleted Whether the comment was marked for deletion or hidden.Not currently used, should remain false.
IsPermanent Whether the comment can be deleted or is a permanent one