CoreService

<back to all web services

GetDeploymentCost

Deployment - CRUD

Get deployments costs

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
All Verbs/api/deployments/{Id}/cost
All Verbs/deployments/{Id}/cost
import Foundation
import ServiceStack

/**
* Get deployments costs
*/
// @Api(Description="Get deployments costs")
// @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(UnitValueDto), StatusCode=200)
public class GetDeploymentCost : IBaseRequest, IGet, IHasId, IHasTenantName, Codable
{
    /**
    * The unique id of the deployment
    */
    // @ApiMember(DataType="string", Description="The unique id of the deployment", Format="guid", IsRequired=true, ParameterType="path")
    public var id:String

    // @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
    // @Validate(Validator="NotEmpty")
    public var tenantName:String

    /**
    * By default only the current months cost are returned. Specify how many previous months should be included
    */
    // @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)")
    public var includePreviousMonths:Int

    required public init(){}
}

public class ItemsResponse<T : Codable> : Codable
{
    public var items:IList<VariableDto>
    public var offset:Int
    public var total:Int
    public var isGrouped:Bool
    public var responseStatus:ResponseStatus
    public var meta:[String:String]

    required public init(){}
}

public class VariableDto : Codable
{
    public var name:String
    /**
    * 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
    */
    public var value:String
    /**
    * The data type of the value property
    */
    public var type:ValueDataType
    public var Description:String
    public var isInherited:Bool
    public var environment:Environments?

    required public init(){}
}

public enum ValueDataType : String, Codable
{
    case String
    case Number
    case Boolean
    case List
}

public enum Environments : String, Codable
{
    case Lab
    case Poc
    case Dev
    case Test
    case Int
    case Uat
    case Prod
}


Swift GetDeploymentCost 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/deployments/{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"}}