CoreService

<back to all web services

QueryTimeSeriesDataPoints

TimeSeries - CRUD

Returns a list of all timeseries data within a tenant

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/timeseries/{TimeSeriesId}/datapointsReturns all timeseries data
GET/api/timeseries/{TimeSeriesId}/datapointsReturns all timeseries data
namespace CoreService.ServiceModel.BusinessObjects.Audit

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type ObjectTypes =
        | None = 0
        | ConfigItem = 1
        | Tenant = 2
        | Collection = 3
        | Resource = 4
        | ComputeNode = 5
        | VirtualMachine = 6
        | PhysicalMachine = 7
        | Disk = 8
        | Subnet = 9
        | IPAddress = 10
        | Job = 11
        | JobEvent = 12
        | FreezePeriod = 13
        | ResourceGroup = 14
        | Deployment = 15
        | ResourceGroupTemplate = 16
        | DeploymentTemplate = 17
        | ResourceProvider = 18
        | GenericResource = 19
        | Role = 20
        | Permission = 21
        | User = 22
        | PatchingWindow = 23
        | Update = 24
        | ReportDefinition = 25
        | TimeSeries = 26
        | DataPoint = 27
        | Action = 28
        | ActionAssignment = 29
        | UserNote = 30

    [<AllowNullLiteral>]
    type TimeSeriesDataPoint() = 
        member val Id:Guid = new Guid() with get,set
        member val TimeStamp:DateTime = new DateTime() with get,set
        [<References(typeof<TimeSeriesDefinition>)>]
        member val TimeSeriesId:Guid = new Guid() with get,set

        member val ObjectType:ObjectTypes = new ObjectTypes() with get,set
        [<References(typeof<Resource>)>]
        member val ResourceId:Nullable<Guid> = new Nullable<Guid>() with get,set

        member val ResourceLabel:String = null with get,set
        [<References(typeof<ResourceGroup>)>]
        member val ResourceGroupId:Nullable<Guid> = new Nullable<Guid>() with get,set

        member val ResourceGroupLabel:String = null with get,set
        [<References(typeof<Deployment>)>]
        member val DeploymentId:Nullable<Guid> = new Nullable<Guid>() with get,set

        member val DeploymentLabel:String = null with get,set
        [<References(typeof<DeploymentCollection>)>]
        member val CollectionId:Nullable<Guid> = new Nullable<Guid>() with get,set

        member val CollectionLabel:String = null with get,set
        [<References(typeof<ResourceProvider>)>]
        member val ResourceProviderId:Nullable<Guid> = new Nullable<Guid>() with get,set

        member val ResourceProviderLabel:String = null with get,set
        member val Dimension3Id:String = null with get,set
        member val Dimension3Type:String = null with get,set
        member val Dimension3Label:String = null with get,set
        [<Ignore>]
        member val Dimension3:Object = null with get,set

        member val Dimension4Id:String = null with get,set
        member val Dimension4Type:String = null with get,set
        member val Dimension4Label:String = null with get,set
        [<Ignore>]
        member val Dimension4:Object = null with get,set

        member val Name:String = null with get,set
        member val Unit:String = null with get,set
        member val Value:Decimal = new Decimal() with get,set
        member val Enriched:Boolean = new Boolean() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryBase() = 
        [<DataMember(Order=1)>]
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=2)>]
        member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=3)>]
        member val OrderBy:String = null with get,set

        [<DataMember(Order=4)>]
        member val OrderByDesc:String = null with get,set

        [<DataMember(Order=5)>]
        member val Include:String = null with get,set

        [<DataMember(Order=6)>]
        member val Fields:String = null with get,set

        [<DataMember(Order=7)>]
        member val Meta:Dictionary<String, String> = null with get,set

    [<AllowNullLiteral>]
    type QueryDb<T>() = 
        inherit QueryBase()

    type Aggregations =
        | None = 0
        | Count = 1
        | DistinctCount = 2
        | Sum = 3
        | Min = 4
        | Max = 5
        | Avg = 6
        | First = 7

    ///<summary>
    ///Returns a list of all timeseries data within a tenant
    ///</summary>
    [<Api(Description="Returns a list of all timeseries data within a tenant")>]
    [<ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof<0, Culture=neutral, PublicKeyToken=null]]>, StatusCode=200)>]
    [<AllowNullLiteral>]
    type QueryTimeSeriesDataPoints() = 
        inherit QueryDb<TimeSeriesDataPoint>()
        interface IGet
        [<ApiMember(DataType="string", IsRequired=true, ParameterType="header")>]
        [<Validate(Validator="NotEmpty")>]
        member val TenantName:String = null with get,set

        [<ApiMember(DataType="string", IsRequired=true, ParameterType="path")>]
        member val TimeSeriesId:Guid = new Guid() with get,set

        ///<summary>
        ///The property, the data will be grouped on
        ///</summary>
        [<ApiMember(Description="The property, the data will be grouped on", ParameterType="query")>]
        member val GroupBy:String = null with get,set

        ///<summary>
        ///The property, used for aggregation
        ///</summary>
        [<ApiMember(Description="The property, used for aggregation", ParameterType="query")>]
        member val AggregateOn:String = null with get,set

        ///<summary>
        ///The aggregation function to use
        ///</summary>
        [<ApiMember(Description="The aggregation function to use", ParameterType="query")>]
        member val Aggregation:Nullable<Aggregations> = new Nullable<Aggregations>() with get,set

        ///<summary>
        ///Returns all referenced object
        ///</summary>
        [<ApiMember(Description="Returns all referenced object", ParameterType="query")>]
        member val IncludeReferencedObjects:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    [<AllowNullLiteral>]
    type Auditable() = 
        [<Required>]
        member val Created:DateTime = new DateTime() with get,set

        [<Required>]
        member val CreateUser:String = null with get,set

        [<Required>]
        member val CreateUserId:String = null with get,set

        [<Required>]
        member val Modified:DateTime = new DateTime() with get,set

        [<Required>]
        member val ModifyUser:String = null with get,set

        [<Required>]
        member val ModifyUserId:String = null with get,set

        [<Required>]
        member val IsDeleted:Boolean = new Boolean() with get,set

        member val Deleted:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DeleteUser:String = null with get,set
        member val DeleteUserId:String = null with get,set

    [<AllowNullLiteral>]
    type Tag() = 
        member val Name:String = null with get,set
        member val Value:String = null with get,set
        member val IsProtected:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type PathItem() = 
        member val Label:String = null with get,set
        member val Link:String = null with get,set
        member val ObjectType:ObjectTypes = new ObjectTypes() with get,set
        member val ObjectId:Guid = new Guid() with get,set

    [<AllowNullLiteral>]
    type ConfigItem() = 
        inherit Auditable()
        member val Id:Guid = new Guid() with get,set
        [<Required>]
        member val Name:String = null with get,set

        [<Required>]
        [<StringLength(250)>]
        member val DisplayName:String = null with get,set

        [<StringLength(8000)>]
        member val Description:String = null with get,set

        member val ObjectType:ObjectTypes = new ObjectTypes() with get,set
        [<Ignore>]
        member val SelfLink:String = null with get,set

        [<Required>]
        member val Tags:IList<Tag> = null with get,set

        [<Required>]
        member val Path:IList<PathItem> = null with get,set

    type ValueDataType =
        | String = 0
        | Number = 1
        | Boolean = 2
        | List = 3

    type Environments =
        | Lab = 0
        | Poc = 1
        | Dev = 2
        | Test = 3
        | Int = 4
        | Uat = 5
        | Prod = 6

    [<AllowNullLiteral>]
    type Variable() = 
        member val Name:String = null with get,set
        member val Value:String = null with get,set
        member val Type:ValueDataType = new ValueDataType() with get,set
        member val Description:String = null with get,set
        member val IsInherited:Boolean = new Boolean() with get,set
        member val Environment:Nullable<Environments> = new Nullable<Environments>() with get,set

    [<AllowNullLiteral>]
    type Tenant() = 
        inherit ConfigItem()
        [<Required>]
        [<StringLength(10)>]
        member val Name:String = null with get,set

        [<Required>]
        member val ObjectType:ObjectTypes = new ObjectTypes() with get,set

        [<Ignore>]
        member val SelfLink:String = null with get,set

        [<Required>]
        member val Variables:IList<Variable> = null with get,set

        [<Required>]
        member val AllowedMailDomains:IList<String> = null with get,set

        [<Required>]
        member val LicensedModules:IList<String> = null with get,set

        [<Required>]
        member val DefaultDeploymentLifetimeDays:Int16 = new Int16() with get,set

        [<Required>]
        member val MaxDeploymentLifetimeDays:Int16 = new Int16() with get,set

        [<Required>]
        member val SystemUnpatchedWarningDays:Int16 = new Int16() with get,set

        [<Required>]
        member val SystemBackupMissingWarningHours:Int16 = new Int16() with get,set

        [<Required>]
        member val StopVulnerableResourceAfterDays:Int16 = new Int16() with get,set

        [<Required>]
        member val DeploymentExpirationWarningDays:Int16 = new Int16() with get,set

        [<Required>]
        member val PatchNotificationDays:Int16 = new Int16() with get,set

        [<Required>]
        member val UseCustomHostnames:Boolean = new Boolean() with get,set

        [<Required>]
        member val RemoveInactiveVulnerabilitiesAfterDays:Int16 = new Int16() with get,set

    type IntervalUnits =
        | Second = 0
        | Minute = 1
        | Hour = 2
        | Day = 3
        | Week = 4
        | Month = 5
        | Year = 6

    [<AllowNullLiteral>]
    type TimeSeriesDefinition() = 
        inherit Auditable()
        member val Id:Guid = new Guid() with get,set
        [<References(typeof<Tenant>)>]
        member val TenantId:Guid = new Guid() with get,set

        member val Tenant:Tenant = null with get,set
        member val Name:String = null with get,set
        member val DisplayName:String = null with get,set
        [<Ignore>]
        member val SelfLink:String = null with get,set

        [<Required>]
        member val ObjectType:ObjectTypes = new ObjectTypes() with get,set

        member val Description:String = null with get,set
        member val SourceType:ObjectTypes = new ObjectTypes() with get,set
        member val AutoCollection:Boolean = new Boolean() with get,set
        member val AutoCollectionQuery:String = null with get,set
        member val AutoCollectionInterval:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val AutoCollectionIntervalUnit:Nullable<IntervalUnits> = new Nullable<IntervalUnits>() with get,set
        member val AutoCollectionTime:Nullable<TimeOnly> = new Nullable<TimeOnly>() with get,set
        member val LastAutoCollected:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val RetentionTimeMonths:Int32 = new Int32() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryResponse<T>() = 
        [<DataMember(Order=1)>]
        member val Offset:Int32 = new Int32() with get,set

        [<DataMember(Order=2)>]
        member val Total:Int32 = new Int32() with get,set

        [<DataMember(Order=3)>]
        member val Results:ResizeArray<TimeSeriesDefinition> = null with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = null with get,set

        [<DataMember(Order=5)>]
        member val ResponseStatus:ResponseStatus = null with get,set

F# QueryTimeSeriesDataPoints 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/{TimeSeriesId}/datapoints HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"offset":0,"total":0,"results":[{"id":"00000000-0000-0000-0000-000000000000","timeStamp":"0001-01-01T00:00:00.0000000Z","timeSeriesId":"00000000-0000-0000-0000-000000000000","objectType":"DataPoint","resourceId":"00000000-0000-0000-0000-000000000000","resourceLabel":"String","resourceGroupId":"00000000-0000-0000-0000-000000000000","resourceGroupLabel":"String","deploymentId":"00000000-0000-0000-0000-000000000000","deploymentLabel":"String","collectionId":"00000000-0000-0000-0000-000000000000","collectionLabel":"String","resourceProviderId":"00000000-0000-0000-0000-000000000000","resourceProviderLabel":"String","dimension3Id":"String","dimension3Type":"String","dimension3Label":"String","dimension3":{},"dimension4Id":"String","dimension4Type":"String","dimension4Label":"String","dimension4":{},"name":"String","unit":"String","value":0,"enriched":false}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}