Skip to content

Product

Manage Products.


Create

Create a product definition

Endpoint

1
POST /product/create

Authorized Role

1
admin

JSON Body Fields

Field Type Required Notes
description string
name string Must be a unique name
agent string
meter boolean
scope string
type string
units number
url string

Response

A product object.


Get

Get a product definition by ID

Endpoint

1
POST /product/get

Authorized Role

1
user

JSON Body Fields

Field Type Required Notes
id string yes

Response

A product object.


Find

Endpoint

1
POST /product/find

Authorized Role

1
user

Response

A list of product objects.


Remove

Remove a product definition

Endpoint

1
POST /product/remove

Authorized Role

1
admin

JSON Body Fields

Field Type Required Notes
id string

Update

Update a product definition

Endpoint

1
POST /product/update

Authorized Role

1
admin

JSON Body Fields

Field Type Required Notes
description string
id string
name string
agent string Set to Ioto, GoAhead or Appweb
meter boolean Set to true to use automatic volume metering
planId string
scope string
type string
units number
url string