Rest API – Attribute History

Last updated
Save as PDF

How to retrieve historical data in FireScope SDDM for Attributes using the REST API.

Overview

The REST API allows you to retrieve historical data in FireScope SDDM for Attributes. You must specify two Attributes and a number of hours in the past–up to twelve–from the current time.

To retrieve Attribute history, send unique query parameters in a GET request to the following URL:

http://10.0.22.192:38050/web_service...?hours=[number of hours]&account=[your Account name]&operation1=[your first Attribute operation name]&operation2=[your second Attribute operation name]&logicalgroup=[your Logical Group name]&servicegroup=[your Service Group name]

Note: You can include a Logical Group name, Service Group name, or neither, but you cannot include both.

Example:

http://10.0.22.192:38050/web_services/attribute_history_query?hours=12&account=fsdallas&operation1=load&operation2=response_time&logicalgroup=Windows%20Servers

SDDM returns the historical data for the selected Attributes. The following example shows the response from a query.

{
  "ci" : [ {
    "ci_name" : "ci_name_0",
    "v1" : [ {
      "c" : 1372309200,
      "v" : "0"
    }, {
      "c" : 1372309201,
      "v" : "1"
    } ],
    "v2" : [ {
      "c" : 1372309200,
      "v" : "0"
    }, {
      "c" : 1372309201,
      "v" : "1"
    } ]
  }, {
    "ci_name" : "ci_name_1",
    "v1" : [ {
      "c" : 1372309200,
      "v" : "0"
    }, {
      "c" : 1372309201,
      "v" : "1"
    } ],
    "v2" : [ {
      "c" : 1372309200,
      "v" : "0"
    }, {
      "c" : 1372309201,
      "v" : "1"
    } ]
  } ],
  "operation1" : "operation1",
  "operation2" : "operation2"
}

Property Descriptions

Property	Description
ci	Details about the Configuration Item (CI): PropertyDescriptionci_nameName of the CI.v1Details about the value for the first Attribute. PropertyDescriptioncTime the value was collected in UNIX time.vValue collected for the Attribute.v2Details about value for the second Attribute. PropertyDescriptioncTime the value was collected in UNIX time.vValue collected for the Attribute.
operation1	Operation name for the first Attribute.
operation2	Operation name for the second Attribute.