See all operations
POST: projects/{project_id}/risks/{risk_id}/comments
Description
Creates a new comment for a risk.
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/projects/{project_id}/risks/{risk_id}/comments
Request Parameters
|
Name
|
Description
|
|
project_id
|
The id of the current project
|
|
risk_id
|
The ID of the risk to add comments to
|
Request Body
|
Property
|
Description
|
|
CommentId
|
The unique ID for this comment / artifact type.
|
|
ArtifactId
|
The artifact ID that this comment belongs to.
|
|
Guid
|
The unique identifier for the artifact
|
|
UserId
|
The userID of the author.
The authenticated user is used if no value provided
|
|
UserGuid
|
The user guid.
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
|
<RemoteComment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<ArtifactId>0</ArtifactId>
<CommentId i:nil="true" />
<CreationDate i:nil="true" />
<Guid i:nil="true" />
<IsDeleted>false</IsDeleted>
<IsPermanent>false</IsPermanent>
<Text i:nil="true" />
<UserGuid i:nil="true" />
<UserId i:nil="true" />
<UserName i:nil="true" />
</RemoteComment>
{"CommentId":null,
"ArtifactId":0,
"Guid":null,
"UserId":null,
"UserGuid":null,
"UserName":null,
"Text":null,
"CreationDate":null,
"IsDeleted":false,
"IsPermanent":false}
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.
|
|
Guid
|
The unique identifier for the artifact
|
|
UserId
|
The userID of the author.
The authenticated user is used if no value provided
|
|
UserGuid
|
The user guid.
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
|
<RemoteComment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<ArtifactId>0</ArtifactId>
<CommentId i:nil="true" />
<CreationDate i:nil="true" />
<Guid i:nil="true" />
<IsDeleted>false</IsDeleted>
<IsPermanent>false</IsPermanent>
<Text i:nil="true" />
<UserGuid i:nil="true" />
<UserId i:nil="true" />
<UserName i:nil="true" />
</RemoteComment>
{"CommentId":null,
"ArtifactId":0,
"Guid":null,
"UserId":null,
"UserGuid":null,
"UserName":null,
"Text":null,
"CreationDate":null,
"IsDeleted":false,
"IsPermanent":false}