CoreService

<back to all web services

GetBillableResources

Statistics

Returns billable resource counts

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/statistics/billableresourcesReturns billable resource counts
GET/statistics/billableresourcesReturns billable resource counts
import 'package:servicestack/servicestack.dart';

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

class HeaderDto implements IHasIdName, IHasObjectType, IConvertible
{
    String id = "";
    String name = "";
    String displayName = "";
    ObjectTypes objectType;

    HeaderDto({this.id,this.name,this.displayName,this.objectType});
    HeaderDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        name = json['name'];
        displayName = json['displayName'];
        objectType = JsonConverters.fromJson(json['objectType'],'ObjectTypes',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'name': name,
        'displayName': displayName,
        'objectType': JsonConverters.toJson(objectType,'ObjectTypes',context!)
    };

    getTypeName() => "HeaderDto";
    TypeContext? context = _ctx;
}

class BillableResourceDto implements IConvertible
{
    ObjectTypes type;
    int totalCount = 0;
    int billableCount = 0;
    List<HeaderDto> billableResources = [];

    BillableResourceDto({this.type,this.totalCount,this.billableCount,this.billableResources});
    BillableResourceDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        type = JsonConverters.fromJson(json['type'],'ObjectTypes',context!);
        totalCount = json['totalCount'];
        billableCount = json['billableCount'];
        billableResources = JsonConverters.fromJson(json['billableResources'],'List<HeaderDto>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'type': JsonConverters.toJson(type,'ObjectTypes',context!),
        'totalCount': totalCount,
        'billableCount': billableCount,
        'billableResources': JsonConverters.toJson(billableResources,'List<HeaderDto>',context!)
    };

    getTypeName() => "BillableResourceDto";
    TypeContext? context = _ctx;
}

class BillableResourceSummaryDto implements IConvertible
{
    DateTime generatedOn = DateTime(0);
    Map<String,BillableResourceDto?> billableResources = {};

    BillableResourceSummaryDto({this.generatedOn,this.billableResources});
    BillableResourceSummaryDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        generatedOn = JsonConverters.fromJson(json['generatedOn'],'DateTime',context!);
        billableResources = JsonConverters.fromJson(json['billableResources'],'Map<String,BillableResourceDto?>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'generatedOn': JsonConverters.toJson(generatedOn,'DateTime',context!),
        'billableResources': JsonConverters.toJson(billableResources,'Map<String,BillableResourceDto?>',context!)
    };

    getTypeName() => "BillableResourceSummaryDto";
    TypeContext? context = _ctx;
}

/**
* Returns billable resource counts
*/
// @Api(Description="Returns billable resource counts")
// @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(BillableResourceSummaryDto), StatusCode=200)
class GetBillableResources implements IBaseRequest, IHasTenantName, IGet, IConvertible
{
    // @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
    // @Validate(Validator="NotEmpty")
    String tenantName = "";

    GetBillableResources({this.tenantName});
    GetBillableResources.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        tenantName = json['tenantName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'tenantName': tenantName
    };

    getTypeName() => "GetBillableResources";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'duneframework.com', types: <String, TypeInfo> {
    'ObjectTypes': TypeInfo(TypeOf.Enum, enumValues:ObjectTypes.values),
    'HeaderDto': TypeInfo(TypeOf.Class, create:() => HeaderDto()),
    'BillableResourceDto': TypeInfo(TypeOf.Class, create:() => BillableResourceDto()),
    'List<HeaderDto>': TypeInfo(TypeOf.Class, create:() => <HeaderDto>[]),
    'BillableResourceSummaryDto': TypeInfo(TypeOf.Class, create:() => BillableResourceSummaryDto()),
    'Map<String,BillableResourceDto?>': TypeInfo(TypeOf.Class, create:() => Map<String,BillableResourceDto?>()),
    'GetBillableResources': TypeInfo(TypeOf.Class, create:() => GetBillableResources()),
});

Dart GetBillableResources 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/billableresources 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","billableResources":{"String":{"type":"None","totalCount":0,"billableCount":0,"billableResources":[{"id":"00000000-0000-0000-0000-000000000000","name":"String","displayName":"String","objectType":"None"}]}}}