| Required role: | TenantReader |
| GET | /timeseries/{Id} | Returns a timeseries definition | |
|---|---|---|---|
| GET | /api/timeseries/{Id} | Returns a timeseries definition | |
| GET | /timeseries/{Name}/byname | Returns a timeseries definition | |
| GET | /api/timeseries/{Name}/byname | Returns a timeseries definition |
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CoreService.ServiceModel.Dtos.TimeSeries.Crud;
using CoreService.ServiceModel.Dtos.TimeSeries.Reponses;
using YCO.Dune.Models.Enums;
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=typeof(CoreService.ServiceModel.Dtos.TimeSeries.Reponses.TimeSeriesDefinitionDto), StatusCode=200)]
public partial class GetTimeSeriesDefinition
: IGetSingleRequest, IHasTenantName, IGet
{
[ApiMember(DataType="string", Format="guid", ParameterType="path")]
public virtual Guid? Id { get; set; }
[ApiMember(DataType="string", ParameterType="path")]
public virtual string? Name { get; set; }
[ApiMember(DataType="string", IsRequired=true, ParameterType="header")]
[Validate("NotEmpty")]
public virtual string TenantName { get; set; }
[ApiMember(ParameterType="query", Verb="GET")]
public virtual bool? IncludeReferencedObjects { get; set; }
///<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 virtual bool? IncludeDeleted { get; set; }
}
}
namespace CoreService.ServiceModel.Dtos.TimeSeries.Reponses
{
public partial class TimeSeriesDefinitionDto
{
public virtual Guid Id { get; set; }
public virtual string Name { get; set; }
public virtual string? Description { get; set; }
public virtual ObjectTypes SourceType { get; set; }
public virtual string? AutoCollectionQuery { get; set; }
public virtual double? AutoCollectionInterval { get; set; }
public virtual IntervalUnits? AutoCollectionIntervalUnit { get; set; }
public virtual TimeOnly? AutoCollectionTime { get; set; }
public virtual DateTime? LastAutoCollected { get; set; }
public virtual bool AutoCollection { get; set; }
public virtual int? RetentionTimeMonths { get; set; }
}
}
namespace YCO.Dune.Models.Enums
{
public enum IntervalUnits
{
Second,
Minute,
Hour,
Day,
Week,
Month,
Year,
}
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,
}
}
C# 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
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}