CoreService

<back to all web services

GetStatisticsSummary

Statistics

Gets statistic like Resources by OsTypes, etc.

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/statistics/summaryGets statistics like Resources by OsTypes, etc.
GET/statistics/summaryGets statistics like Resources by OsTypes, etc.
namespace CoreService.ServiceModel.Dtos.Statistics.Crud

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

    type StatisticsDataType =
        | SingleDatapoint = 0
        | SingleDataset = 1
        | MultiDataset = 2

    [<AllowNullLiteral>]
    type IStatisticsData = 
        abstract Name:String with get,set
        abstract Type:StatisticsDataType with get,set

    [<AllowNullLiteral>]
    type StatisticsSummaryDto() = 
        member val GeneratedOn:DateTime = new DateTime() with get,set
        member val Statistics:Dictionary<String, IStatisticsData> = null with get,set

    ///<summary>
    ///Gets statistic like Resources by OsTypes, etc.
    ///</summary>
    [<Api(Description="Gets statistic like Resources by OsTypes, etc.")>]
    [<ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof<StatisticsSummaryDto>, StatusCode=200)>]
    [<AllowNullLiteral>]
    type GetStatisticsSummary() = 
        interface IGet
        [<ApiMember(DataType="string", IsRequired=true, ParameterType="header")>]
        [<Validate(Validator="NotEmpty")>]
        member val TenantName:String = null with get,set

F# GetStatisticsSummary 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 /api/statistics/summary HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"generatedOn":"0001-01-01T00:00:00.0000000Z","statistics":{"String":null}}