TAG LINE
SMALL TITLE
System defined unit of counting in a Base Bucket such as Count, Data or Time.
identity READ-ONLY | "identity": 4 Type: Number This is the unique numeric identifier for the UsageBucketBaseUnit |
usageBaseUnitId | "usageBaseUnitId": 11 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": 2 Type: Number Unused |
visible READ-ONLY | "visible": true Type: Boolean Whether or not this Base Unit is visible in the user interface. |
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:
| GET | api/v3/Usage/Bucket/BaseUnit/ |
| Retrieve all of the UsageBucketBaseUnit objects. | |
Retrieve all of the UsageBucketBaseUnit objects. GET api/v3/Usage/Bucket/BaseUnit/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"usageBaseUnitId": 23,
"usageBaseUnitName": "Sample Text Data",
"name": "Count",
"description": "Counting items",
"sortOrder": 1,
"visible": true
}
]
} | |
| GET | api/v3/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 api/v3/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": 18,
"usageBaseUnitName": "Sample Text Data",
"name": "Count",
"description": "Counting items",
"sortOrder": 10,
"visible": true
}
]
}
} | |
| GET | api/v3/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 api/v3/Usage/Bucket/BaseUnit/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"usageBaseUnitId": 15,
"usageBaseUnitName": "Sample Text Data",
"name": "Count",
"description": "Counting items",
"sortOrder": 17,
"visible": true
}
} | |