See all operations
POST: projects/{project_id}/incidents/{incident_id}/comments
Description
Adds new incident comments to an incident in a project in the system
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/v6_0/RestService.svc/projects/{project_id}/incidents/{incident_id}/comments
Request Parameters
|
Name
|
Description
|
|
project_id
|
The id of the project
|
|
incident_id
|
The id of the incident
|
Request Body
<ArrayOfRemoteComment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
<RemoteComment>
<ArtifactId>0</ArtifactId>
<CommentId i:nil="true" />
<CreationDate i:nil="true" />
<IsDeleted>false</IsDeleted>
<IsPermanent>false</IsPermanent>
<Text i:nil="true" />
<UserId i:nil="true" />
<UserName i:nil="true" />
</RemoteComment>
</ArrayOfRemoteComment>
[{"CommentId":null,
"ArtifactId":0,
"UserId":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.
<ArrayOfRemoteComment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
<RemoteComment>
<ArtifactId>0</ArtifactId>
<CommentId i:nil="true" />
<CreationDate i:nil="true" />
<IsDeleted>false</IsDeleted>
<IsPermanent>false</IsPermanent>
<Text i:nil="true" />
<UserId i:nil="true" />
<UserName i:nil="true" />
</RemoteComment>
</ArrayOfRemoteComment>
[{"CommentId":null,
"ArtifactId":0,
"UserId":null,
"UserName":null,
"Text":null,
"CreationDate":null,
"IsDeleted":false,
"IsPermanent":false}]