Get Policies
Returns a paginated list of pricing cards
Request
URI
GET
https://{api_host}/price/api/private/pricing-cards
COPY
Query Parameters
integer
page
Optional
Constraints:
minimum: 0
default: 0
Zero-based page index (0..N)
integer
size
Optional
Constraints:
minimum: 1
default: 20
The size of the page to be returned
string of
array
sort
Optional
Constraints:
default: createdAt,DESC
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
string
search
Optional
Search by name and description
boolean
expandPricingCard
Optional
Whether or not returns detailed pricing card for each result.
boolean
expandAssignmentInfo
Optional
Whether or not returns count of assignments.
integer
$top
Optional
Number of records you want
$top example
1
integer
$skip
Optional
Number of records you want to skip
$skip example
1
string
$orderby
Optional
Sorting criteria in the format: property (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
string
$filter
Optional
A subset of records that satisfy the given predicate expression
$filter example
startswith(name, 'Act'), toupper(name) eq 'ACTIVATE', substringof('renameVM', name), name eq 'ABCD'Responses
200
OK
Returns
PageMeteringPolicy
of type(s)
application/json
{
"content": [
{
"chargeModel": "string",
"createdAt": "string",
"createdBy": "string",
"description": "string",
"fixedPrice": {
"chargePeriod": "string",
"rate": "number"
},
"id": "string",
"lastUpdatedAt": "string",
"meteringItems": [
{
"itemName": "string",
"metering": {
"baseRate": "number",
"chargeBasedOn": "string",
"chargeOnPowerState": "string",
"chargePeriod": "string",
"fixedPrice": "number",
"unit": "string"
}
}
],
"name": "string",
"namedMeteringItems": [
{
"itemName": "string",
"namedMeterings": [
{
"metering": {
"baseRate": "number",
"chargeBasedOn": "string",
"chargeOnPowerState": "string",
"chargePeriod": "string",
"fixedPrice": "number",
"unit": "string"
},
"name": "string"
}
]
}
],
"oneTimeMeteringItems": [
{
"itemName": "string",
"oneTimeMetering": {
"oneTimeFixedPrice": "number"
}
}
],
"orgId": "string",
"pricingCardAssignmentInfo": {
"count": 0,
"entityType": "string"
},
"tagBasedMeteringItems": [
{
"itemName": "string",
"tagBasedMeterings": [
{
"key": "string",
"metering": {
"baseRate": "number",
"chargeBasedOn": "string",
"chargeOnPowerState": "string",
"chargePeriod": "string",
"fixedPrice": "number",
"unit": "string"
},
"value": "string"
}
]
}
],
"tagBasedOneTimeMeteringItems": [
{
"itemName": "string",
"oneTimeMeterings": [
{
"key": "string",
"oneTimeMetering": {
"oneTimeFixedPrice": "number"
},
"value": "string"
}
]
}
],
"tagBasedRateFactorItems": [
{
"itemName": "string",
"rateFactors": [
{
"key": "string",
"rateFactor": {
"contextMeteringItem": "string",
"rateFactor": "number"
},
"value": "string"
}
]
}
]
}
],
"empty": false,
"first": false,
"last": false,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": false,
"sort": [
{
"ascending": false,
"direction": "string",
"ignoreCase": false,
"nullHandling": "string",
"property": "string"
}
],
"unpaged": false
},
"size": 0,
"sort": [
{
"ascending": false,
"direction": "string",
"ignoreCase": false,
"nullHandling": "string",
"property": "string"
}
],
"totalElements": 0,
"totalPages": 0
}
array of
object
content
Optional
The pricing card to be created
boolean
empty
Optional
empty
boolean
first
Optional
first
boolean
last
Optional
last
integer As int32
As int32
number
Optional
number
integer As int32
As int32
numberOfElements
Optional
numberOfElements
object
pageable
Optional
pageable
integer As int32
As int32
size
Optional
size
array of
object
sort
Optional
sort
integer As int64
As int64
totalElements
Optional
totalElements
integer As int32
As int32
totalPages
Optional
totalPages
401
Unauthorized
Returns
PageMeteringPolicy
of type(s)
application/json
"PageMeteringPolicy Object"
array of
object
content
Optional
The pricing card to be created
boolean
empty
Optional
empty
boolean
first
Optional
first
boolean
last
Optional
last
integer As int32
As int32
number
Optional
number
integer As int32
As int32
numberOfElements
Optional
numberOfElements
object
pageable
Optional
pageable
integer As int32
As int32
size
Optional
size
array of
object
sort
Optional
sort
integer As int64
As int64
totalElements
Optional
totalElements
integer As int32
As int32
totalPages
Optional
totalPages
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/price/api/private/pricing-cards
Pricing Cards Operations
GET
Get Policies
POST
Create Policy
DELETE
Delete Policy
GET
Get Policy
PUT
Update Policy