Usage / Unit

What can you do with UsageUnit?


Properties

Property Details
id
"id": 364
Type: Number
This is the unique numeric identifier for the UsageUnit
usageBaseUnitId
"usageBaseUnitId": 427
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": 341
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

DELETEapi/v1/Usage/Unit/{id:int}
Delete an instance of the UsageUnit object.
GETapi/v1/Usage/Unit
Retrieve all of the UsageUnit objects.
GETapi/v1/Usage/Unit/Metadata
Retrieve all of the meta data details of the UsageUnit object.
GETapi/v1/Usage/Unit/Metadata/{option}
Retrieve all the meta data details of the UsageUnit object based on provided options.
{option}Metadata options for the UsageUnit object.
GETapi/v1/Usage/Unit/Paged
Retreive all of the UsageUnit objects in a paged fashion.
GETapi/v1/Usage/Unit/{id:int}
Retrieve an instance of the UsageUnit object by it's ID.
{id:int}Unique identifier for the UsageUnit object.
POSTapi/v1/Usage/Unit
Create a new instance of the UsageUnit object.
PUTapi/v1/Usage/Unit/{id:int}
Update an existing instance of the UsageUnit object.