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.
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Gets statistic like Resources by OsTypes, etc.
    */
    @Api(Description="Gets statistic like Resources by OsTypes, etc.")
    @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=StatisticsSummaryDto.class, StatusCode=200)
    public static class GetStatisticsSummary implements IBaseRequest, IHasTenantName, IGet
    {
        @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
        @Validate(Validator="NotEmpty")
        public String tenantName = null;
        
        public String getTenantName() { return tenantName; }
        public GetStatisticsSummary setTenantName(String value) { this.tenantName = value; return this; }
    }

    public static class StatisticsSummaryDto
    {
        public Date generatedOn = null;
        public HashMap<String,IStatisticsData> statistics = new HashMap<String,IStatisticsData>();
        
        public Date getGeneratedOn() { return generatedOn; }
        public StatisticsSummaryDto setGeneratedOn(Date value) { this.generatedOn = value; return this; }
        public HashMap<String,IStatisticsData> getStatistics() { return statistics; }
        public StatisticsSummaryDto setStatistics(HashMap<String,IStatisticsData> value) { this.statistics = value; return this; }
    }

    public static interface IStatisticsData
    {
        public String name = null;
        public StatisticsDataType type = null;
    }

    public static enum StatisticsDataType
    {
        SingleDatapoint,
        SingleDataset,
        MultiDataset;
    }

}

Java 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}}