TAG LINE
TAG LINE
SMALL TITLE
Defines a system defined unit of measure based on time, data or counting such as seconds, minutes, hours, bytes, counts etc.
identity READ-ONLY | "identity": 22 Type: Number This is the unique numeric identifier for the UsageUnit |
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": "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": 15 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). |
GET | Usage/Unit/ |
Retrieve all of the UsageUnit objects. | |
Retrieve all of the UsageUnit objects. GET Usage/Unit/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "usageBaseUnitId": 25, "usageBaseUnitName": "Sample Text Data", "name": "Seconds", "description": "Seconds", "multiplierToBaseUnitType": "1024", "sortOrder": 25, "visible": true, "isBytesInBinaryUnit": true } ] } |
GET | 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 Usage/Unit/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": 15, "usageBaseUnitName": "Sample Text Data", "name": "Seconds", "description": "Seconds", "multiplierToBaseUnitType": "1024", "sortOrder": 21, "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} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "usageBaseUnitId": 6, "usageBaseUnitName": "Sample Text Data", "name": "Seconds", "description": "Seconds", "multiplierToBaseUnitType": "1024", "sortOrder": 6, "visible": true, "isBytesInBinaryUnit": true } } |