SectorAnnotation Data Type

POST method should have the following parameters: { "resolution": //"hour"/"day"/"month" the resolution of the given data point "date": //timestamp for the given data point, "created": //timestamp for when the note itself is created, "text": //String containing the note, "affected": //[observerId] - array with ids of the observers in a sector that the note concerns - this could maybe be optional. "author" : { name: //full name of the author of the note, mail: //email to the author of the note }, "createdBy": //userId of the account that was used when note was created. }.

Properties
name data type constraints description
id number required
resolution Resolution  
date object  
created object  
text string  
author Author  
createdBy string  
observerIds array of number  
kpiIds array of number  

Example

{
  "id" : 12345,
  "resolution" : "MONTH",
  "date" : { },
  "created" : { },
  "text" : "...",
  "author" : {
    "name" : "...",
    "email" : "..."
  },
  "createdBy" : "...",
  "observerIds" : [ 12345, 12345 ],
  "kpiIds" : [ 12345, 12345 ]
}