Usage / Base Unit

(API Version v10)

Internal pick list for the different types of base usage that can be rated. Examples are count, data or time.

What can you do with UsageBaseUnit?

GET Usage/BaseUnit/
Retrieve all of the UsageBaseUnit objects.
GET Usage/BaseUnit/Paged
Retrieve all of the UsageBaseUnit objects in a paged fashion.
GET Usage/BaseUnit/{id}
Retrieve an instance of the UsageBaseUnit object by its ID.

Properties

Property Details

identity READ-ONLY	"identity": 0 Type: Number This is the unique numeric identifier for the UsageBaseUnit
name READ-ONLY	"name": "Data" Type: String System name for this Base Unit
description READ-ONLY	"description": "Data calculated rates" Type: String Description of the Base Unit.
baseUnit READ-ONLY	"baseUnit": "bytes" Type: String Different options for calculation such as bytes or seconds
baseUnitDescription READ-ONLY	"baseUnitDescription": "Calculated at the Byte level." Type: String System description for the baseUnit.
sortOrder READ-ONLY	"sortOrder": 5 Type: Number Unused
visible READ-ONLY	"visible": true Type: Boolean Whether or not this Base Unit is visible in the user interface.

End Points

Retrieve all of the UsageBaseUnit objects.

GET Usage/BaseUnit/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Data",
            "description": "Data calculated rates",
            "baseUnit": "bytes",
            "baseUnitDescription": "Calculated at the Byte level.",
            "sortOrder": 14,
            "visible": true
        }
    ]
}

Retrieve all of the UsageBaseUnit 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 UsageBaseUnit objects in a paged fashion.

GET Usage/BaseUnit/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": "Data",
                "description": "Data calculated rates",
                "baseUnit": "bytes",
                "baseUnitDescription": "Calculated at the Byte level.",
                "sortOrder": 12,
                "visible": true
            }
        ]
    }
}

GET	Usage/BaseUnit/{id}
Retrieve an instance of the UsageBaseUnit object by its ID.
{id}	Unique identifier for the UsageBaseUnit object.
Retrieve an instance of the UsageBaseUnit object by its ID. GET Usage/BaseUnit/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "name": "Data", "description": "Data calculated rates", "baseUnit": "bytes", "baseUnitDescription": "Calculated at the Byte level.", "sortOrder": 6, "visible": true } }