Retrieve

To retrieve the current information about an Attribute as a JSON document, send a GET request with the following URL format:

http://localhost:38050/web_services/...2.15&name=ping

Note: Don’t forget to change the (localhost) and query parameter values (account, edge_device, ci, and name) to match your environment and data.

Query Parameter Descriptions

Search

Searching provides for the ability to return multiple results in a single call using various filter criteria. To accomplish this, a GET request is sent with a parameter search=true. Every other field besides account is optional and is used to further filter the results. Pagination is mandatory and accomplished using the page and size parameters. The JSON response will wrap the result list and also display the page and the size. The size in the response represents the number of results actually returned, not the size in the request. The response does not contain a count of the total number of pages or the total number of records for performance reasons. The client is expected to keep querying, increasing the page each time, until the result size is less than the requested size, indicating no more results.

http://localhost:38050/web_services/...age=0&size=100

Note: Don’t forget to change the (localhost) and query parameter values (account, edge_device, ci, and name) to match your environment and data.

{
   "account_id": "firescope",
   "entity": "attribute",
   "page": 0,
   "size": 2,
   "results": [
      {
         "account_id": "firescope",
         "edge_device_id": "edge2",
         "description": "Host ping",
         "ciid": "10.0.6.11",
         "operation": "ping"
      },
      {
         "account_id": "firescope",
         "edge_device_id": "edge1",
         "description": "Host ping",
         "ciid": "10.0.2.15",
         "operation": "ping"
      }
   ]
}

Create or Update

To create an Attribute, send a POST operation with a JSON document to the following URL:

http://[SPM IP address]:38050/web_services/attribute

Note: Don’t forget to change the (SPM IP address)

Use the following example as a guide.

{
   "account_id":"firescope",
   "edge_device_id":"Edge 1",
   "asset_name":null,
   "ciid":"REST Created 1",
   "delay":60,
   "delta":0,
   "description":"test PING 1",
   "formula":"1",
   "logtimefmt":"",
   "metadata":"STATUS,,,PING,53177150e4b011a3f27f25d2,test PING 1",
   "multiplier":0,
   "operation":"ping",
   "snmp_oid":"interfaces.ifTable.ifEntry.ifInOctets.1",
   "snmp_port":161,
   "status":0,
   "translationid":null,
   "trapper_hosts":"",
   "type":3,
   "units":"",
   "value_type":3,
   "fs_attribute_type":{
      "attribute_major":"80",
      "attribute_max":"1",
      "attribute_warning":"60",
      "avail":0,
      "kpi":0,
      "def_graph":"none",
      "perf":1,
      "sec":0
   },
   "attributeset":["Ping attributes"]
}

Delete

To delete an Attribute, send an HTTP DELETE request with the same query parameters as the GET request.See the Retrieve for the URL format and query parameter descriptions.

Note: Deleting an Attribute will have a cascading delete effect. All elements that are based on this Attribute will be effected (for e.g. Dashboards, AEDs, ED, Policies etc. Data collected by this Attribute will be lost for good.)