| Required role: | TenantReader |
| All Verbs | /api/collections/{Id}/cost | ||
|---|---|---|---|
| All Verbs | /collections/{Id}/cost |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | string | Yes | The unique id of the collection |
| TenantName | header | string | Yes | |
| IncludePreviousMonths | query | int | No | By default only the current months cost are returned. Specify how many previous months should be included |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Items | form | IList<VariableDto> | Yes | |
| Offset | form | int | No | |
| Total | form | int | No | |
| IsGrouped | form | bool | No | |
| ResponseStatus | form | ResponseStatus | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Value | form | string | Yes | 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 | form | ValueDataType | No | The data type of the value property |
| Description | form | string | No | |
| IsInherited | form | bool | No | |
| Environment | form | Environments? | No |
| String | |
| Number | |
| Boolean | |
| List |
| Lab | |
| Poc | |
| Dev | |
| Test | |
| Int | |
| Uat | |
| Prod |
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
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"}}