Get FaultIncidents

Returns fault incidents for the specified asset.

Relative URL

rest/FaultIncidents?AssetName={AssetName}&FaultName={FaultName}&RetrieveChildren={RetrieveChildren}&StartDate={StartDate}&EndDate={EndDate}

Parameters

AssetName (required) -The name of the asset for which to return the fault incidents.

Default Value: None

Example Value: Company

FaultName (required) -The name of the fault for which to return the incidents. Use * to return incidents for all faults.

Default Value: None

Example Value: *

RetrieveChildren (optional) - Whether or not to return fault incidents for children of the specified asset.

Default Value: false

Example Value: true

StartDate (optional) - The start time of the window for which to retrieve the data in the format: YYYY-MM-ddThh:mm:ss. The special value of 'now' (without quotes) can be used to pass the current date and time. A negative offset can also be provided using the format: now - hh:mm:ss

Default Value: 1 day back from the value of EndDate.

Example Value: 2015-04-01T00:00:00

EndDate (optional) -The end time of the window for which to retrieve the data in the format: YYYY-MM-ddThh:mm:ss. The special value of 'now' (without quotes) can be used to pass the current date and time. A negative offset can also be provided using the format: now - hh:mm:ss

Default Value: The current date and time at the moment of the call.

Example Value: 2015-05-01T00:00:00

Example Result

An array containing multiple objects, each one representing a fault incident.

[

{

"AssetName": "Company",

"AssetFullName": "Company",

"AssetLevelName": "Enterprise",

"FaultName": "FaultCom",

"FaultActiveTime": "2015-04-17T19:24:23.023-04:00",

"Active": true,

"FaultDeactivationTime": null,

"ActiveDuration": 0.0,

"Acknowledged": false,

"Resolved": false,

"RelatedValue1": "",

"RelatedValue2": "",

"RelatedValue3": "",

"RelatedValue4": "(null)",

"RelatedValue5": "(null)",

"RelatedValue6": "(null)",

"RelatedValue7": "(null)",

"RelatedValue8": "(null)",

"RelatedValue9": "(null)",

"RelatedValue10": "(null)",

"RelatedValue11": "(null)",

"RelatedValue12": "(null)",

"RelatedValue13": "(null)",

"RelatedValue14": "(null)",

"RelatedValue15": "(null)",

"RelatedValue16": "(null)",

"RelatedValue17": "(null)",

"RelatedValue18": "(null)",

"RelatedValue19": "(null)",

"RelatedValue20": "(null)",

"Severity": 500,

"DiagnosticTime": "2015-04-17T19:24:25.763-04:00",

"ActiveSymptoms": "a3;a4;",

"FaultRuleActivationVariables": "@sim64:Long.Static(\"StaticVar\").Value = 10 (4/17/2015 7:24:22 PM) (Good);@sim64:Long.Static(\"StaticThreshold\").Value = 11 (4/17/2015 7:04:00 PM) (Good);",

"FaultRuleDeactivationVariables": "",

"Quality": "Good",

"FaultCostValue": "0",

"Legacy": 0,

"AssetSource": null

{

"AssetName": "Company",

"AssetFullName": "Company",

"AssetLevelName": "Enterprise",

"FaultName": "FaultCom",

"FaultActiveTime": "2015-04-17T19:12:28.373-04:00",

"Active": false,

"FaultDeactivationTime": "2015-04-17T19:23:52.583-04:00",

"ActiveDuration": 684.0,

"Acknowledged": false,

"Resolved": false,

"RelatedValue1": "",

"RelatedValue2": "",

"RelatedValue3": "",

"RelatedValue4": "(null)",

"RelatedValue5": "(null)",

"RelatedValue6": "(null)",

"RelatedValue7": "(null)",

"RelatedValue8": "(null)",

"RelatedValue9": "(null)",

"RelatedValue10": "(null)",

"RelatedValue11": "(null)",

"RelatedValue12": "(null)",

"RelatedValue13": "(null)",

"RelatedValue14": "(null)",

"RelatedValue15": "(null)",

"RelatedValue16": "(null)",

"RelatedValue17": "(null)",

"RelatedValue18": "(null)",

"RelatedValue19": "(null)",

"RelatedValue20": "(null)",

"Severity": 500,

"DiagnosticTime": "2015-04-17T19:12:32.69-04:00",

"ActiveSymptoms": "All Symptoms are inactive",

"FaultRuleActivationVariables": "@sim64:Long.Static(\"StaticVar\").Value = 10 (4/17/2015 7:09:20 PM) (Good);@sim64:Long.Static(\"StaticThreshold\").Value = 11 (4/17/2015 7:04:00 PM) (Good);",

"FaultRuleDeactivationVariables": "@sim64:Long.Static(\"StaticVar\").Value = 13 (4/17/2015 7:23:52 PM) (Good);@sim64:Long.Static(\"StaticThreshold\").Value = 11 (4/17/2015 7:04:00 PM) (Good);",

"Quality": "Good",

"FaultCostValue": "0",

"Legacy": 0,

"AssetSource": null

}

]