TAG LINE
SMALL TITLE

Usage / Unit

(API Version v3)


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?


Properties

Property Details
identity
READ-ONLY
"identity": 13
Type: Number
This is the unique numeric identifier for the UsageUnit
usageBaseUnitId
"usageBaseUnitId": 2
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": 18
Type: Number
Unused
visible
READ-ONLY
"visible": true
Type: Boolean
Whether or not this unit is visible in the user interface.


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

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:

  • usageBaseUnitId
  • name
  • description
  • multiplierToBaseUnitType
  • sortOrder
  • visible

End Points

GETapi/v3/Usage/Unit/
Retrieve all of the UsageUnit objects.
Retrieve all of the UsageUnit objects.
GET api/v3/Usage/Unit/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "usageBaseUnitId": 26,
            "usageBaseUnitName": "Sample Text Data",
            "name": "Seconds",
            "description": "Seconds",
            "multiplierToBaseUnitType": "1024",
            "sortOrder": 26,
            "visible": true
        }
    ]
}
GETapi/v3/Usage/Unit/Paged
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 api/v3/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": 19,
                "usageBaseUnitName": "Sample Text Data",
                "name": "Seconds",
                "description": "Seconds",
                "multiplierToBaseUnitType": "1024",
                "sortOrder": 12,
                "visible": true
            }
        ]
    }
}
GETapi/v3/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 api/v3/Usage/Unit/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageBaseUnitId": 1,
        "usageBaseUnitName": "Sample Text Data",
        "name": "Seconds",
        "description": "Seconds",
        "multiplierToBaseUnitType": "1024",
        "sortOrder": 3,
        "visible": true
    }
}