Usage / Unit

(API Version v8)

Defines a system defined unit of measure based on time, data or counting such as seconds, minutes, hours, bytes, counts etc.

What can you do with UsageUnit?

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

Properties

Property Details

identity READ-ONLY	"identity": 4 Type: Number This is the unique numeric identifier for the UsageUnit
usageBaseUnitId	"usageBaseUnitId": 13 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": "Seconds" Type: String The system defined name for the Unit
description READ-ONLY	"description": "Seconds" Type: String The system description for the Unit.
multiplierToBaseUnitType READ-ONLY	"multiplierToBaseUnitType": "1024" Type: String The multiplier to be used to convert the base type for example bytes to MB.
sortOrder READ-ONLY	"sortOrder": 5 Type: Number Unused
visible READ-ONLY	"visible": true Type: Boolean Whether or not this unit is visible in the user interface.
isBytesInBinaryUnit	"isBytesInBinaryUnit": true Type: Boolean Indicates if bytes are in binary (true) or decimal (false).

End Points

Retrieve all of the UsageUnit objects.

GET Usage/Unit/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "usageBaseUnitId": 18,
            "usageBaseUnitName": "Sample Text Data",
            "name": "Seconds",
            "description": "Seconds",
            "multiplierToBaseUnitType": "1024",
            "sortOrder": 16,
            "visible": true,
            "isBytesInBinaryUnit": true
        }
    ]
}

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

GET Usage/Unit/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,
                "usageBaseUnitId": 2,
                "usageBaseUnitName": "Sample Text Data",
                "name": "Seconds",
                "description": "Seconds",
                "multiplierToBaseUnitType": "1024",
                "sortOrder": 26,
                "visible": true,
                "isBytesInBinaryUnit": true
            }
        ]
    }
}

GET	Usage/Unit/{id}
Retrieve an instance of the UsageUnit object by its ID.
{id}	Unique identifier for the UsageUnit object.
Retrieve an instance of the UsageUnit object by its ID. GET Usage/Unit/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "usageBaseUnitId": 14, "usageBaseUnitName": "Sample Text Data", "name": "Seconds", "description": "Seconds", "multiplierToBaseUnitType": "1024", "sortOrder": 11, "visible": true, "isBytesInBinaryUnit": true } }