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.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* 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)
open class GetStatisticsSummary : IBaseRequest, IHasTenantName, IGet
{
    @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
    @Validate(Validator="NotEmpty")
    override var tenantName:String? = null
}

open class StatisticsSummaryDto
{
    open var generatedOn:Date? = null
    open var statistics:HashMap<String,IStatisticsData> = HashMap<String,IStatisticsData>()
}

interface IStatisticsData
{
    var name:String?
    @SerializedName("type") var Type:StatisticsDataType?
}

enum class StatisticsDataType
{
    SingleDatapoint,
    SingleDataset,
    MultiDataset,
}

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