TAG LINE
TAG LINE
SMALL TITLE
System defined unit of counting in a Base Bucket such as Count, Data or Time.
identity READ-ONLY | "identity": 14 Type: Number This is the unique numeric identifier for the UsageBucketBaseUnit |
usageBaseUnitId | "usageBaseUnitId": 9 Type: Number Unique identifier for the associated UsageBaseUnit object. |
usageBaseUnitName | "usageBaseUnitName": "Sample Name" Type: String The name of the object associated with the usageBaseUnitId property. |
name READ-ONLY | "name": "Count" Type: String System defined name for the Base Unit. |
description READ-ONLY | "description": "Counting items" Type: String System defined description for the Base Unit. |
sortOrder READ-ONLY | "sortOrder": 12 Type: Number Unused |
visible READ-ONLY | "visible": true Type: Boolean Whether or not this Base Unit is visible in the user interface. |
isBaseBucketEligible | "isBaseBucketEligible": true Type: Boolean TBC. |
GET | Usage/Bucket/BaseUnit/ |
Retrieve all of the UsageBucketBaseUnit objects. | |
Retrieve all of the UsageBucketBaseUnit objects. GET Usage/Bucket/BaseUnit/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "usageBaseUnitId": 22, "usageBaseUnitName": "Sample Text Data", "name": "Count", "description": "Counting items", "sortOrder": 3, "visible": true, "isBaseBucketEligible": true } ] } |
GET | Usage/Bucket/BaseUnit/Paged |
Retrieve all of the UsageBucketBaseUnit 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 UsageBucketBaseUnit objects in a paged fashion. GET Usage/Bucket/BaseUnit/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, "usageBaseUnitId": 12, "usageBaseUnitName": "Sample Text Data", "name": "Count", "description": "Counting items", "sortOrder": 1, "visible": true, "isBaseBucketEligible": true } ] } } |
GET | Usage/Bucket/BaseUnit/{id} |
Retrieve an instance of the UsageBucketBaseUnit object by its ID. | |
{id} | Unique identifier for the UsageBucketBaseUnit object. |
Retrieve an instance of the UsageBucketBaseUnit object by its ID. GET Usage/Bucket/BaseUnit/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "usageBaseUnitId": 3, "usageBaseUnitName": "Sample Text Data", "name": "Count", "description": "Counting items", "sortOrder": 3, "visible": true, "isBaseBucketEligible": true } } |