Add a Note Comment

Add a comment to the dialogue.

Query String Parameters

Name	Type	Description	Required
Action	String	CommentSave	Required
EntityId	Int	This is the Id of the entity you’d like to associate the comment with. This must match the entity type. For example, if you select entity type 1, then the entity id must be a Note Id.	Required
EntityType	Int	Set the entity type of the item you want to attach the comment to. Not all entity types can associate a comment. Current valid types are: 1 = Note 2 = Asset Defect	Required
NoteComment	String	Adds text passed as a "Comment", on the entity.	Required
CreationDate	DateTime	Date time the dialogue was captured - defaults to current time	Optional
UserIds	Int	Used to add users and only works where Mentions is set to True.	Optional
PreviousMentions	Bool	Defaults to false - if set to true it will add the previous notes mentions.	Optional
Mentions	Bool	Defaults to false. If set to true, it will add the previous mentions (if true) and the UserIds (if populated)	Optional
Reaction	String	Name of reaction to add to the dialogue	Optional

Response Codes

Code	Message	Information
0	Response Data	See 'Response' example tab
2	Missing or Empty parameter - NoteComment	Mandatory parameter was not supplied
2	Missing or Invalid parameter - EntityType	Integer value is invalid or was not specified (when required)
2	Invalid parameter - EntityType	Unrecognized constant value - please verify the supported values
2	Missing or Invalid parameter - EntityId	Integer value is invalid or was not specified (when required)
2	Invalid parameter - EntityId	Unrecognized constant value - please verify the supported values
2	EntityId does not exist in JobWatch	There is no record with this Id
2	Invalid Parameter CreationDateTime	Date value is invalid or was not specified (when required)
2	There are no users set up in JobWatch	No data returned or set-up in BigChange
2	Invalid parameter - Reaction	Unrecognized constant value - please verify the supported values

Example

Request

Request URL

?action=CommentSave&NoteComment=Another note comment&EntityType=1&EntityId=24878975

Response

Response Data

{
  "Code": 0,
  "Result": 177027873
}