TAG LINE
SMALL TITLE

Usage / Bucket / Refill Type

(API Version v4)


System defined list of refill types for a Bucket. Such as recurring, recuring with rollover and non-recurring.


What can you do with UsageBucketRefillType?


Properties

Property Details
identity
READ-ONLY
"identity": 5
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.


End Points

DELETEapi/v4/Usage/Bucket/RefillType/{id}
Delete an instance of the UsageBucketRefillType object. Upon successful delete, this API will return a record of all of the reelated 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 api/v4/Usage/Bucket/RefillType/{id}
View Sample Response
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"
            }
        ]
    }
}
GETapi/v4/Usage/Bucket/RefillType/
Retrieve all of the UsageBucketRefillType objects.
Retrieve all of the UsageBucketRefillType objects.
GET api/v4/Usage/Bucket/RefillType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Recurring"
        }
    ]
}
GETapi/v4/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 api/v4/Usage/Bucket/RefillType/Paged
View Sample Response
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"
            }
        ]
    }
}
GETapi/v4/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 api/v4/Usage/Bucket/RefillType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Recurring"
    }
}
POSTapi/v4/Usage/Bucket/RefillType/Search
Retreive a list of UsageBucketRefillType objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of UsageBucketRefillType objects based on search criteria.
POST api/v4/Usage/Bucket/RefillType/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Recurring"
        }
    ]
}