StarterTemplate ASP.NET Host

<back to all web services

RequestNotesPost

The following routes are available for this service:
POST/service/api/v1/projects/{ProjectId}/{EntityCode}/{EntityId}/notesAdds a new note (comment) to an itemThe authenticating user must have the Update privilege for the entity (Defects, Tests and so on) to which the node will be added
Parameters:
NameParameterData TypeRequiredDescription
ProjectIdpathintYesThe ID of the project that contains the item
EntityCodepathstringYesThe type of the item you need to add a note to
EntityIdpathintYesThe ID of the item you need to add a note to

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/RequestNotesPost HTTP/1.1 
Host: rest.qacomplete.smartbear.com 
Content-Type: application/xml
Content-Length: length

<RequestNotesPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Notes">
  <Description>String</Description>
  <EntityCode>String</EntityCode>
  <EntityId>0</EntityId>
  <OriginalId>0</OriginalId>
  <ProjectId>0</ProjectId>
</RequestNotesPost>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseNoteSingle xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Notes">
  <DateCreated>0001-01-01T00:00:00</DateCreated>
  <DateUpdated>0001-01-01T00:00:00</DateUpdated>
  <Description>String</Description>
  <EntityCode>String</EntityCode>
  <EntityId>0</EntityId>
  <Id>0</Id>
  <OriginalId>0</OriginalId>
  <Seq>0</Seq>
  <UpdateUserId>0</UpdateUserId>
  <UserName>String</UserName>
</ResponseNoteSingle>