TAG LINE
SMALL TITLE

Usage / Base Unit

(API Version v4)


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?


Properties

Property Details
identity
READ-ONLY
"identity": 7
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": 25
Type: Number
Unused
visible
READ-ONLY
"visible": true
Type: Boolean
Whether or not this Base Unit is visible in the user interface.


End Points

GETapi/v4/Usage/BaseUnit/
Retrieve all of the UsageBaseUnit objects.
Retrieve all of the UsageBaseUnit objects.
GET api/v4/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": 2,
            "visible": true
        }
    ]
}
GETapi/v4/Usage/BaseUnit/Paged
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 api/v4/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": 8,
                "visible": true
            }
        ]
    }
}
GETapi/v4/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 api/v4/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": 27,
        "visible": true
    }
}
POSTapi/v4/Usage/BaseUnit/Search
Retreive a list of UsageBaseUnit objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of UsageBaseUnit objects based on search criteria.
POST api/v4/Usage/BaseUnit/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Data",
            "description": "Data calculated rates",
            "baseUnit": "bytes",
            "baseUnitDescription": "Calculated at the Byte level.",
            "sortOrder": 14,
            "visible": true
        }
    ]
}