Comments

Description

• Retrieve the comment for ProcessValue on a given tag.

URL

/Comments

Method

GET 

Required Parameters

• Type
  The filter option for the comment resource must specify 'ProcessValue'.

• FQN=[string ]
  The fully qualified name for the tag. A fully qualified name uses the format: datasource.tagname.

Optional Parameters

• DateTime=[DateTimeOffset ]
  (v2 and later) Specified in UTC using the RFC3339 / ISO8601 format with the Z time zone designator. For example: 2016-09-03T18:44:09.352247Z.
  By default, the end time is set to the current time (now) and the start time is set to one hour before.

Sample Query

This example retrieves comments for a specific time range for a tag:

https://online.wonderware.[DOMAINSUFFIX]/apis/Historian/v2/Comments?$filter= Type eq ‘ProcessValue’
and FQN eq ‘Crane5.TestTag5_1’ and DateTime ge 2014-06-17T09:51:49.7687436Z
and DateTime lt 2017-02-18T09:56:49.7687436Z

Sample Output

{

"@odata.context": "https://online.wonderware.[DOMAINSUFFIX]/Historian/v2/$metadata#Annotations",

"value": [

{

"Id": "8a5a98a9-77a5-469d-b223-2a7838c37bb5",

"CreatedUserName": "Arun",

"SharedMode": "Team",

"SharedTime": "2017-07-17T02:40:19.4058692Z",

"Location": "\Lake Forest",

"DateCreated": "2017-07-17T02:40:19.4058692Z",

"Text": "SampleAnnotation 1",

"DateModified": "2017-07-17T02:40:19.4058692Z",

"Type": "ProcessValue",

"FQN": "aaaa",

"DateTime": "2017-07-16T19:40:19.403869-07:00"

},

{

"Id": "aa09e2cc-be07-4180-9591-009987efc53f",

"CreatedUserName": "Arun",

"SharedMode": "Team",

"SharedTime": "2017-07-17T03:40:19.4068693Z",

"Location": "\",

"DateCreated": "2017-07-17T03:40:19.4068693Z",

"Text": "SampleAnnotation 2",

"DateModified": "2017-07-17T03:40:19.4068693Z",

"Type": "ProcessValue",

"FQN": "aaaa",

"ProcessDateTime": "2017-07-16T19:40:19.403869-07:00"

}

]

}