StarterTemplate ASP.NET Host

<back to all web services

RequestNotesPut

The following routes are available for this service:
PUT/service/api/v1/projects/{ProjectId}/{EntityCode}/{EntityId}/notes/{Id}Updates the note (comment) added to an itemThe authenticating user must have the Update privilege for the entity (Defects, Tests and so on) that contains the note.
Parameters:
NameParameterData TypeRequiredDescription
ProjectIdpathintYesThe ID of the project that contains the item
EntityCodepathstringYesThe type of the item that has the note
EntityIdpathintYesThe ID of the item that has the note
IdpathintYesThe ID of the note you need to update

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/RequestNotesPut HTTP/1.1 
Host: rest.qacomplete.smartbear.com 
Content-Type: application/xml
Content-Length: length

<RequestNotesPut 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>
  <Id>0</Id>
  <OriginalId>0</OriginalId>
  <ProjectId>0</ProjectId>
</RequestNotesPut>

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>