TAG LINE
SMALL TITLE

Usage / Base Unit

(API Version v2)


What can you do with UsageBaseUnit?


Properties

Property Details
id
"id": 5
Type: Number
This is the unique numeric identifier for the UsageBaseUnit
name
"name": "Hello World"
Type: String
description
"description": "Hello World"
Type: String
baseUnit
"baseUnit": "Hello World"
Type: String
baseUnitDescription
"baseUnitDescription": "Hello World"
Type: String
sortOrder
"sortOrder": 5
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:

  • name
  • description
  • baseUnit
  • baseUnitDescription
  • sortOrder
  • visible

DataFlow PATCH objects:


End Points

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