Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
Last revisionBoth sides next revision
documentation:api-data-types [2014-01-15 12:30] – created nkukarddocumentation:api-data-types [2014-01-15 12:35] – [Structure definition] nkukard
Line 5: Line 5:
 ===== Type: OTSJsonStats ===== ===== Type: OTSJsonStats =====
  
-See below example of the json format for this type.+See below example of the JSON format for this type.
  
 ==== Structure definition ==== ==== Structure definition ====
Line 28: Line 28:
   },   },
   ...   ...
 +}
 +</code>
 +
 +===== Type: OTSStreamedJsonStats =====
 +
 +See below example of the JSON format for this type. This type builds on the OTSJsonStats above by allowing tagging of stats to accomplish streaming of multiple items at unknown time intervals.
 +
 +==== Structure definition ====
 +
 +All definitions hold true as with OTSJsonStats, with the addition of the following...
 +
 +  - $tag is the tag given to the statistical item reported during the subscription process
 + 
 +It must be noted there may be multiple tags depending on what data is subscribed to.
 +
 +==== Example ====
 +<code>
 +{
 +  $tag: {
 +    $identifier: {
 +      label: $label,
 +      data: [
 +        [$timestamp, $value],
 +        ...
 +      ]
 +    },
 +    ...
 +   },
 +   ...
 } }
 </code> </code>