REST APIs : REST API documentation changes
  
REST API documentation changes
The list below describes the changes made to the REST API content since the last publication.
 
March 30, 2018 (17.4.0.0)
Updated the Apex endpoints and OMS endpoints with the new widget type SITE_STATUS_MAP and other site-related features.
Updated the Observer/GigaStor REST API with new Connection Dynamics functionality.
Added information about the new filter patterns, including numerous examples.
Added details about what happens to Unicode characters used in the filter expression to Parameters used to extract GigaStor data.
 
 
February 8, 2018 (17.3.3.0)
Published 17.3.3.0 release notes for the Observer Platform.
 
 
November 27, 2017 (17.3.2.0)
Published 17.3.2.0 release notes for the Observer Platform.
 
 
September 15, 2017 (17.3.1.0)
Published 17.3.1.0 release notes for the Observer Platform.
Improved the search algorithm to provide better results by giving greater importance to terms found in titles, introduction paragraphs, and keywords.
 
 
August 22, 2017
Added maximum length or maximum characters to many parameters for Apex endpoints and OMS endpoints where possible.
Added missing fieldId parameter to /dashboardResults, /printDashboardResults, and /widgetResults in Apex endpoints .
Added missing intervals parameter to /dashboardResults and /widgetResults in Apex endpoints .
 
 
July 13, 2017 (17.3.0.0)
Published 17.3.0.0 release notes for the Observer Platform.
The Apex endpoints changed in the following ways:
Added 1MINUTE to executionFrequency and LAST1MINUTE to executionPeriod for /alarms and /scheduledReports.
Added BAR_HORIZONTAL, BAR_THRESHOLD, and BAR_THRESHOLD_HORIZONTAL to graphType parameter.
Deprecated DIAL, GAUGE, ARC, and ICON from the statusType parameter. They have been replaced by a single new option DUAL_DIAL_TCB.
Deprecated both forceStream and forceStreamId in fields in /dashboardResults and /widgets.
Added widgetSettings object to printDashboardResults.
Deprecated numberOfPeriods from schedule in /settings/baselineSchedule.
Removed disableObsInfr from /softwareserver/settings.
Added /widgetResults endpoint (added in 17.2.0.0).
The OMS endpoints changed in the following ways. These changes occurred in 17.2.0.0.
Added minimizedstatelogin option to flags in /assetPolicies.
Added minTlsVersion in /assetPolicies to check the TLS version.
Removed disableObsInfr from /softwareserver/settings.
The Observer Analyzer endpoints changed in the following ways.
Added /gs/cdx endpoint for Connection Dynamics.
Added /filters endpoint for filters. Added in 17.2.0.0 (API version 1.1).
Added /instances endpoint for probe instances. Added in 17.2.0.0 (API version 1.1).
Added pcapng option to traceFormat in /gs/traces to save to the PCAPNG file format. This change affects parameters documented in Parameters used to extract GigaStor data. This occurred in 17.2.3.0.
Added the app filter for trace extractions. This feature was added in 17.2.0.0.
 
 
May 5, 2017 (17.2.3.0)
Published 17.2.3.0 release notes for the Observer Platform.
 
 
March 10, 2017 (17.2.2.0)
Published 17.2.2.0 release notes for the Observer Platform.
 
 
January 17, 2017 (17.2.1.1)
Published 17.2.1.1 release notes for the Observer Platform.
 
 
January 11, 2017 (17.2.1.0)
Published 17.2.1.0 release notes for the Observer Platform.
 
 
December 2, 2016 (17.2.0.0)
Published 17.2.0.0 release notes for the Observer Platform.
 
 
November 22, 2016 (17.1.1.4)
Published 17.1.1.4 release notes for the Observer Platform.
 
 
September 23, 2016 (17.1.1.3)
Published 17.1.1.3 release notes for the Observer Platform.
 
 
September 20, 2016 (17.1.1.2)
Published 17.1.1.2 release notes for the Observer Platform.
 
 
July 29, 2016 (17.1.1.1)
Published 17.1.1.1 release notes for the Observer Platform.
 
 
June 27, 2016
Added MAC addresses and MAC Pairs examples to Understanding the filter syntax.
Added CIDR details to IP Addresses and IP Pairs.
 
 
June 16, 2016
Added details about how the Windows user account affects where you can write trace extraction files.
Added session time out information.
 
 
May 31, 2016 (17.1.1.0)
Added details about the differences in login procedures between Observer Apex and Observer Apex Lite. This can be seen at the end of Figure 1: Select All.
Added instanceId as a parameter to the methods for these Apex endpoints: /alarms, /scheduledreports, /adms, and /admDiscoveries. Use instanceId to generate an alarm for a specific probe instance or to create a PDF or other report on a recurring basis.
Added intervalDurationSeconds value to the response object for these Apex endpoints: /dashboardResults and /printdashboardResults.
Added upgradeApexLite as a parameter to the methods for this Observer Management Server (OMS) endpoint: /upgradepolicies.
Deprecated and removed the GET, PUT, and DELETE methods from /dashboardResults. These methods are no longer available. POST is the only supported method.
 
 
April 1, 2016
Updated the list of Apex endpoints and OMS endpoints, including adding parameter models for each method.
 
 
February 29, 2016
Corrected the Base structure URI for Observer. The correct base URI is https://hostname/obs/api/v1/.
 
 
February 9, 2016 (17.1.0.0)
Added Observer URIs and endpoints.
Added How to extract data to a temporary file using the Observer REST API.
Added Understanding the filter syntax for the Observer REST API.
 
 
August 4, 2015
Added the list of Matrix URIs.
Added clarification that the API uses UTC, not GMT, in and .
 
 
April 15, 2015
Added a video for Parsing the extracted data from a dashboard.
 
 
April 14, 2015
Added the main landing page.
Added a topic about How to retrieve data from a dashboard.
Added a detail about GMT vs. system time for API requests in .
 
 
April 13, 2015
Changed the minimum Python version in Supported REST API environments.
 
 
April 10, 2015
Embedded a video for How to create a REST API session.
Added a video for How to retrieve an object's internal ID.
Added status code 412 to REST API status codes.
Added the ability to select code in figures by clicking the Select All text. Right-click to copy the text to your clipboard.