Add a comment

Add a new comment to an activity

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areaactivities.json
GeneralYesParameters described in overviewuser=user&password=user&version=3.7v3.7 Overview
ActionYesThe action to performaction=comment
IdentifierNoActivty ID or UUIDactivtyid=8951

Example request:

http://<SERVER>/jsonapi/activities.json?&user=user&password=user&version=3.7&activityid=8951&action=comment&description="Mike, here is an example of the issue"

Example response:

{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "Comment created.",
"warningmessage": "",
"success": true,
"synversion": "12.600",
"synapiversion": 3.7
}

List history items

Example requests:

ParameterDescription/example
ActionAction=history
ActivityIDIdentifies the record you wish to create a comment/history record for
http://<SERVER>/jsonapi/activities.json?&user=user&password=user&version=3.7&action=history&activityID=4833

or

http://<SERVER>/jsonapi/activityhistory.json?&user=user&password=user&version=3.7&activityID=4833

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 44,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "activityhistoryUuid": "1EB57F5625EE344B84DAEEF92F93AD10",
      "activityhistoryTimeStampModified": 1494410784,
      "activityhistoryRecordVersionNumber": 0,
      "activityhistoryComment": "",
      "activityhistoryCreatedByUserID": 54,
      "activityhistoryDateCreated": "2017-05-10",
      "activityhistoryHistoryDetail": "hello3",
      "activityhistoryNotesHistoryCategory": 0,
      "activityhistoryTimeCreated": "11:06:24",
      "activityhistoryCreatedByFullNAme": "User",
      "activityhistoryCreatedDisplayDescription": "Created by User on 10/05/2017 at 11:06am"
    },
    {
      "activityhistoryUuid": "EDF3AB010E6A92468123C5A686B1B951",
      "activityhistoryTimeStampModified": 1475771092,
      "activityhistoryRecordVersionNumber": 0,
      "activityhistoryComment": "",
      "activityhistoryCreatedByUserID": 3,
      "activityhistoryDateCreated": "2016-10-06",
      "activityhistoryHistoryDetail": "Document 32424 deleted.",
      "activityhistoryNotesHistoryCategory": 14,
      "activityhistoryTimeCreated": "17:24:52",
      "activityhistoryCreatedByFullNAme": "SYN_Jon",
      "activityhistoryCreatedDisplayDescription": "Created by SYN_Jon on 06/10/2016 at 5:24pm"
    },
  ]
}