TAG LINE
TAG LINE
SMALL TITLE
System defined list of refill types for a Bucket. Such as recurring, recuring with rollover and non-recurring.
identity READ-ONLY | "identity": 9 Type: Number This is the unique numeric identifier for the UsageBucketRefillType |
name READ-ONLY | "name": "Recurring" Type: String System defined name for the Refill Type. |
| DELETE | Usage/Bucket/RefillType/{id} |
| Delete an instance of the UsageBucketRefillType object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the UsageBucketRefillType object. |
Delete an instance of the UsageBucketRefillType object. DELETE Usage/Bucket/RefillType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "usageBucketRefillType"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | Usage/Bucket/RefillType/ |
| Retrieve all of the UsageBucketRefillType objects. | |
Retrieve all of the UsageBucketRefillType objects. GET Usage/Bucket/RefillType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Recurring"
}
]
} | |
| GET | Usage/Bucket/RefillType/Paged |
| Retrieve all of the UsageBucketRefillType objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the UsageBucketRefillType objects in a paged fashion. GET Usage/Bucket/RefillType/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Recurring"
}
]
}
} | |
| GET | Usage/Bucket/RefillType/{id} |
| Retrieve an instance of the UsageBucketRefillType object by its ID. | |
| {id} | Unique identifier for the UsageBucketRefillType object. |
Retrieve an instance of the UsageBucketRefillType object by its ID. GET Usage/Bucket/RefillType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Recurring"
}
} | |