TAG LINE
SMALL TITLE

Usage / Unit

(API Version v2)


What can you do with UsageUnit?


Properties

Property Details
id
"id": 8
Type: Number
This is the unique numeric identifier for the UsageUnit
usageBaseUnitId
"usageBaseUnitId": 27
Type: Number
Unique identifier for the associated UsageBaseUnit object.
name
"name": "Hello World"
Type: String
description
"description": "Hello World"
Type: String
multiplierToBaseUnitType
"multiplierToBaseUnitType": "Hello World"
Type: String
sortOrder
"sortOrder": 8
Type: Number
visible
"visible": true
Type: Boolean


Update Request Filters

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

DataFlow PATCH objects:


End Points

GETapi/v2/Usage/Unit
Retrieve all of the UsageUnit objects.
GETapi/v2/Usage/Unit/Paged
Retreive all of the UsageUnit objects in a paged fashion.
GETapi/v2/Usage/Unit/{id:int}
Retrieve an instance of the UsageUnit object by it's ID.
{id:int}Unique identifier for the UsageUnit object.