CoreService

<back to all web services

GetCollectionCost

Collection - CRUD

Get collections costs

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
All Verbs/api/collections/{Id}/cost
All Verbs/collections/{Id}/cost
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')


# @Api(Description="Get collections costs")
# @ApiResponse(Description="The request ended successful", IsDefaultResponse=true, ResponseType=typeof(UnitValueDto), StatusCode=200)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCollectionCost(IBaseRequest, IGet, IHasId, IHasTenantName):
    """
    Get collections costs
    """

    # @ApiMember(DataType="string", Description="The unique id of the collection", Format="guid", IsRequired=true, ParameterType="path")
    id: Optional[str] = None
    """
    The unique id of the collection
    """


    # @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
    # @Validate(Validator="NotEmpty")
    tenant_name: Optional[str] = None

    # @ApiMember(DataType="int", Description="By default only the current months cost are returned. Specify how many previous months should be included", ParameterType="query")
    # @Validate(Validator="InclusiveBetween(0,14)")
    include_previous_months: int = 0
    """
    By default only the current months cost are returned. Specify how many previous months should be included
    """


class ValueDataType(str, Enum):
    STRING = 'String'
    NUMBER = 'Number'
    BOOLEAN = 'Boolean'
    LIST = 'List'


class Environments(str, Enum):
    LAB = 'Lab'
    POC = 'Poc'
    DEV = 'Dev'
    TEST = 'Test'
    INT_ = 'Int'
    UAT = 'Uat'
    PROD = 'Prod'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VariableDto:
    name: Optional[str] = None
    value: Optional[str] = None
    """
    Value in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false, List = [1,2,3,4]). Note: string values need extra quotes
    """

    type: Optional[ValueDataType] = None
    """
    The data type of the value property
    """

    description: Optional[str] = None
    is_inherited: bool = False
    environment: Optional[Environments] = None


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ItemsResponse(Generic[T]):
    items: Optional[IList[VariableDto]] = None
    offset: int = 0
    total: int = 0
    is_grouped: bool = False
    response_status: Optional[ResponseStatus] = None
    meta: Optional[Dict[str, str]] = None

Python GetCollectionCost 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.

POST /api/collections/{Id}/cost HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":"00000000-0000-0000-0000-000000000000","tenantName":"String","includePreviousMonths":0,"txId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"items":null,"offset":0,"total":0,"isGrouped":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"meta":{"String":"String"}}