CoreService

<back to all web services

GetTimeSeriesDefinition

TimeSeries - CRUD

Returns a timeseries definition by its ID

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/timeseries/{Id}Returns a timeseries definition
GET/api/timeseries/{Id}Returns a timeseries definition
GET/timeseries/{Name}/bynameReturns a timeseries definition
GET/api/timeseries/{Name}/bynameReturns a timeseries definition
GetTimeSeriesDefinition Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
NamepathstringNo
TenantNameheaderstringYes
IncludeReferencedObjectsquerybool?No
IncludeDeletedquerybool?NoIf true, also soft deleted items will be returned
TimeSeriesDefinitionDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringYes
DescriptionformstringNo
SourceTypeformObjectTypesNo
AutoCollectionQueryformstringNo
AutoCollectionIntervalformdouble?No
AutoCollectionIntervalUnitformIntervalUnits?No
AutoCollectionTimeformTimeOnly?No
LastAutoCollectedformDateTime?No
AutoCollectionformboolNo
RetentionTimeMonthsformint?No
ObjectTypes Enum:
None
ConfigItem
Tenant
Collection
Resource
ComputeNode
VirtualMachine
PhysicalMachine
Disk
Subnet
IPAddress
Job
JobEvent
FreezePeriod
ResourceGroup
Deployment
ResourceGroupTemplate
DeploymentTemplate
ResourceProvider
GenericResource
Role
Permission
User
PatchingWindow
Update
ReportDefinition
TimeSeries
DataPoint
Action
ActionAssignment
UserNote
IntervalUnits Enum:
Second
Minute
Hour
Day
Week
Month
Year

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /timeseries/{Id} HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":"00000000-0000-0000-0000-000000000000","name":"String","description":"String","sourceType":"None","autoCollectionQuery":"String","autoCollectionInterval":0,"autoCollectionIntervalUnit":"Second","autoCollectionTime":"00:00","lastAutoCollected":"0001-01-01T00:00:00.0000000Z","autoCollection":false,"retentionTimeMonths":0}