TAG LINE
SMALL TITLE

Usage / Bucket

(API Version v3)


What can you do with UsageBucket?


Properties

Property Details
id
"id": 3
Type: Number
This is the unique numeric identifier for the UsageBucket
ownerId
"ownerId": 13
Type: Number
Unique identifier for the associated Owner object.
usageBucketBaseId
"usageBucketBaseId": 25
Type: Number
Unique identifier for the associated UsageBucketBase object.
name
"name": "Hello World"
Type: String
prorate
"prorate": true
Type: Boolean
isInfiniteLastTier
"isInfiniteLastTier": true
Type: Boolean
isThresholdPerAccountService
"isThresholdPerAccountService": true
Type: Boolean
usageBucketRefillTypeId
"usageBucketRefillTypeId": 12
Type: Number
Unique identifier for the associated UsageBucketRefillType object.
refillFrequency
"refillFrequency": 2
Type: Number
refillFrequencyTypeId
"refillFrequencyTypeId": 12
Type: Number
Unique identifier for the associated FrequencyType object.
expireAfterFrequency
"expireAfterFrequency": 11
Type: Number
expireAfterFrequencyTypeId
"expireAfterFrequencyTypeId": 20
Type: Number
Unique identifier for the associated FrequencyType object.
isAssociatedWithSharePlan
"isAssociatedWithSharePlan": true
Type: Boolean
expireAfterRecurrence
"expireAfterRecurrence": 14
Type: Number
accountPackageActivation
"accountPackageActivation": true
Type: Boolean


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • identity
  • usageBucketBaseId
  • name
  • prorate
  • isInfiniteLastTier
  • isThresholdPerAccountService
  • usageBucketRefillTypeId
  • refillFrequency
  • refillFrequencyTypeId
  • expireAfterFrequency
  • expireAfterFrequencyTypeId
  • expireAfterRecurrence
  • isAssociatedWithSharePlan
  • accountPackageActivation

DataFlow PATCH objects:


End Points

DELETEapi/v3/Usage/Bucket/{id:int}
Delete an instance of the UsageBucket object.
GETapi/v3/Usage/Bucket
Retrieve all of the UsageBucket objects.
GETapi/v3/Usage/Bucket/Paged
Retreive all of the UsageBucket objects in a paged fashion.
GETapi/v3/Usage/Bucket/Paged/Detail
Retreive all of the UsageBucket objects in a paged fashion with all object details.
GETapi/v3/Usage/Bucket/{id:int}
Retrieve an instance of the UsageBucket object by it's ID.
{id:int}Unique identifier for the UsageBucket object.
GETapi/v3/Usage/Bucket/{id:int}/Detail
Retreive all of the Detail objects for the specified UsageBucket.
{id:int}Unique identifier for the UsageBucket object.
PATCHapi/v3/Usage/Bucket/{id:int}
Update the UsageBucket object and optionally make changes to any child objects.
POSTapi/v3/Usage/Bucket
Create a new instance of the UsageBucket object.
PUTapi/v3/Usage/Bucket/{id:int}
Update an existing instance of the UsageBucket object.