Verticals

The 'verticals' API allows viewing, creating, modifying, and deleting verticals associated with the devices in the system. Administrator or super administrator permissions are required.

GET /verticals

The GET /verticals endpoint provides a paginated list of verticals, which can be filtered by the following fields:

  • 'page' (optional): page number to display.
  • 'size' (optional): number of elements per page.
  • 'sort' (optional): sorting order of the elements; can be ascending (ASC) or descending (DESC) and is based on any of the attributes by which to filter.
  • 'id' (optional): vertical identifier.
  • 'name' (optional): vertical name.
  • 'description' (optional): vertical description.
  • 'dashboards.id' (optional): id of an associated dashboard.
  • 'dashboards.title' (optional): title of an associated dashboard.
  • 'dashboards.url' (optional): url of an associated dashboard.
  • 'dashboards.folderId' (optional): id of the folder containing an associated dashboard.
  • 'dashboards.folderTitle' (optional): title of the folder containing an associated dashboard.
  • 'dashboards.folderUid' (optional): uid of the folder containing an associated dashboard.
  • 'dashboards.folderUrl' (optional): url of the folder containing an associated dashboard.

GET /verticals/{id}

The GET /verticals/{id} endpoint provides the vertical by its id.

POST /verticals

The POST /verticals endpoint creates a new vertical and must have the following format:

{
  "name": "SmartCities",
  "description": "Vertical for Smart City devices"
}
  • 'name' (required): name of the vertical.
  • 'description' (optional): description of the vertical.

PUT /verticals/{id}

The PUT /verticals/{id} endpoint serves to modify a vertical by its id. The data that can be modified are as follows:

  • 'name' (required): name of the vertical.
  • 'description' (optional): description of the vertical.

PUT /verticals/{id}/addDashboard

The PUT /verticals/{id}/addDashboard endpoint is used to add a dashboard to a vertical by its ID. It expects the following:

  • 'id' (optional): ID of an associated dashboard.
  • 'title' (optional): title of an associated dashboard.
  • 'url' (optional): URL of an associated dashboard.
  • 'folderId' (optional): ID of the folder containing an associated dashboard.
  • 'folderTitle' (optional): title of the folder containing an associated dashboard.
  • 'folderUid' (optional): user identifier of the folder containing an associated dashboard.
  • 'folderUrl' (optional): URL of the folder containing an associated dashboard.

PUT /verticals/{id}/removeDashboard

The PUT /verticals/{id}/removeDashboard endpoint is used to remove an associated dashboard from a vertical by its ID. It expects the following:

  • 'id' (optional): ID of an associated dashboard.
  • 'title' (optional): title of an associated dashboard.
  • 'url' (optional): URL of an associated dashboard.
  • 'folderId' (optional): ID of the folder containing an associated dashboard.
  • 'folderTitle' (optional): title of the folder containing an associated dashboard.
  • 'folderUid' (optional): user identifier of the folder containing an associated dashboard.
  • 'folderUrl' (optional): URL of the folder containing an associated dashboard.

DELETE /verticals/{id} (Delete a vertical by its id)

The DELETE /verticals/{id} endpoint deletes the vertical by its id.