Comments API

The following APIs are available for use in connection with comments to records:

Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Update comment

Enter the following PUT request URI:

https://<serverAddress>/rest/<tenant-id>/collaboration/comments/<EntityType>/<EntityId>/<CommentId>

where EntityType specifies the record type and EntityId specifies the required record.

An example of a PUT request JSON is:

{
	"IsSystem": false,
	"Body": "Updated body!",
	"AttachmentIds": [],
	"PrivacyType": "PUBLIC",    //INTERNAL,PUBLIC,AGENTPUBLIC
	"Submitter": {
		"UserId": 10016
	},
	"ActualInterface": "API",  //SAW,ESS,EMAIL,API,SYSTEM
	"CommentFrom": "User",     //System,Agent,User,Vendor,ExternalServiceDesk,SocialUser
	"CommentTo": "",           //Agent,User,Vendor,ExternalServiceDesk,Stakeholder
	"FunctionalPurpose": "StatusUpdate",  //StatusUpdate,RequestMoreInformation,
        ProvideInformation,EndUserComment,Diagnosis,Resolution,ResolutionActivity,FollowUp 
	"Media": "Unknown",       //Unknown,UI,Email,Phone,Fax,InstantMessage,InternalChat
	"PersonParticipant": "",
	"CompanyVendor": "",
	"Group": "",
	“CreateTime”: 1451360022122,
	“Id”:  “abdec6fb-0bac-4a7b-a533-6735cabf9c88”
}

The response includes the updated comment:

{
    "IsSystem": false,
    "Body": "Updated body!",
    "PrivacyType": "PUBLIC",
    "Submitter": {
      "UserId": "10016"
    },
    "UpdatedBy": {
      "UserId": "10015"
    },
    "ActualInterface": "API",
    "CommentFrom": "User",
    "FunctionalPurpose": "StatusUpdate",
    "Media": "Unknown",
    "PersonParticipant": "",
    "CompanyVendor": "",
    "Group": "",
    "CreateTime": 1452749848614,
    "UpdateTime": 1452751819091,
    "Id": "92334628-6e8e-46d6-b799-8948e4cd0f89"
  }

Note To update existing comments of a record, you must have Comments permission for the relevant record type.