Definition of CIMON REST API

CIMON REST API

UltimateAccess Web server provides REST API that lets anyone easily request the data in CIMON Historian Database. The verified end user may utilize the 4 types of data shared via REST API.

1. Page Recorder

Get recorded data list

URL : http://(IP):(PORT)/pageRec/page_rec_time

Method : 'POST'

Headers : ‘Content-Type’: ‘application/json’

Request	Response
`{ "pageName":"Pagename" }`	`{ "data": [ { "start_time": (Start time), "end_time": (End time), "min_sec": (Minute/Second) }, … ] }`

2. Data Log

Get data log

URL : http://(IP):(PORT)/dataLog/get_log_rawdata

Method : 'POST'

Headers : ‘Content-Type’: ‘application/json’

Request	Response
`{ "tagArr": [ "TAG1", "TAG2", "TAG3" ], "startTime":"yyyy/MM/dd hh:mm:ss", "endTime":"yyyy/MM/dd hh:mm:ss" }`	`{ "data":[ { "time": (Time), "tag_name": (Tag name), "tag_value": (Tag value) }, … ] }`

3. Alarm History

Get alarm history

URL : http://(IP):(PORT)/historyAlarm/get_history_alarm

Method : 'POST'

Headers : ‘Content-Type’: ‘application/json’

NOTE : Enter asc (ascending) or desc (descending) to the parameter order to request data.

Request	Response
`{ "startTime":"yyyy/MM/dd hh:mm:ss", "endTime":"yyyy/MM/dd hh:mm:ss", "order":"asc" }`	`{ "data": [ { "time": (Time), "freetime": (Cleared time), "almtime": (Alarm time), "occtime": (Occurred time), "tag_name": (Tag name), "value": (Tag value), "statuscode": (Status code), "status": (Status), "typecode": (Type code), "type": (Type), "almlabel": (Alarm label), "areacode": (Alarm zone code), "area": (Alarm zone), "priority": (Alarm level) }, … ] }`

4. Network Status

Get network status

URL : http://(IP):(PORT)/networkStatus/get_network_status

Method : 'POST'

Headers : ‘Content-Type’: ‘application/json’

Request

Response

{
  "data": [
    { 
      "station": (Station), 
      "address": (통신 주소),
      "description": (Station description),
      "status": (Normal / Abnormal),
      "read": (Amount of reads), 
      "readerr": (Read error),
      "readprect": (Read success rate),
      "write": (Amount of writes),
      "writeerr": (Write error),
      "writeprect": (Write success rate)
    },
    …
  ]
}