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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CoreService.ServiceModel.Dtos.TimeSeries.Crud
Imports CoreService.ServiceModel.Dtos.TimeSeries.Reponses
Imports YCO.Dune.Models.Enums

Namespace Global

    Namespace CoreService.ServiceModel.Dtos.TimeSeries.Crud

        '''<Summary>
        '''Returns a timeseries definition by its ID
        '''</Summary>
        <Api(Description:="Returns a timeseries definition by its ID")>
        <ApiResponse(Description:="Success", IsDefaultResponse:=true, ResponseType:=GetType(TimeSeriesDefinitionDto), StatusCode:=200)>
        Public Partial Class GetTimeSeriesDefinition
            Implements IGetSingleRequest
            Implements IHasTenantName
            Implements IGet
            <ApiMember(DataType:="string", Format:="guid", ParameterType:="path")>
            Public Overridable Property Id As Guid?

            <ApiMember(DataType:="string", ParameterType:="path")>
            Public Overridable Property Name As String

            <ApiMember(DataType:="string", IsRequired:=true, ParameterType:="header")>
            <Validate(Validator:="NotEmpty")>
            Public Overridable Property TenantName As String Implements IHasTenantName.TenantName

            <ApiMember(ParameterType:="query", Verb:="GET")>
            Public Overridable Property IncludeReferencedObjects As Boolean? Implements IGetSingleRequest.IncludeReferencedObjects

            '''<Summary>
            '''If true, also soft deleted items will be returned
            '''</Summary>
            <ApiMember(Description:="If true, also soft deleted items will be returned", ParameterType:="query")>
            Public Overridable Property IncludeDeleted As Boolean? Implements IGetSingleRequest.IncludeDeleted
        End Class
    End Namespace

    Namespace CoreService.ServiceModel.Dtos.TimeSeries.Reponses

        Public Partial Class TimeSeriesDefinitionDto
            Public Overridable Property Id As Guid
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property SourceType As ObjectTypes
            Public Overridable Property AutoCollectionQuery As String
            Public Overridable Property AutoCollectionInterval As Double?
            Public Overridable Property AutoCollectionIntervalUnit As IntervalUnits?
            Public Overridable Property AutoCollectionTime As TimeOnly?
            Public Overridable Property LastAutoCollected As Date?
            Public Overridable Property AutoCollection As Boolean
            Public Overridable Property RetentionTimeMonths As Integer?
        End Class
    End Namespace

    Namespace YCO.Dune.Models.Enums

        Public Enum IntervalUnits
            Second
            Minute
            Hour
            Day
            Week
            Month
            Year
        End Enum

        Public Enum ObjectTypes
            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
        End Enum
    End Namespace
End Namespace

VB.NET GetTimeSeriesDefinition DTOs

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}