Organizations

• Channels - Device Groups
• Work groups
• Geo-areas
• Manufacturers & Models
• Data models
• Tags
• Tickets

Introduction

This document presents a comprehensive overview of the OpenGate Organization API, a pivotal component of the OpenGate IoT platform. As defined in the OpenAPI 3.0.0 specification, this API plays a crucial role in the holistic management of OpenGate organizations, which represent the highest-level and most crucial entities within the OpenGate platform.

The Role of Organizations in OpenGate

• Foundation of the IoT Ecosystem: In the OpenGate system, an organisation is the fundamental unit from which all other entities are derived. The aforementioned entities comprise users, devices, assets, channels (i.e., device groups), work groups, and sub-organizations.
• Central Control and Coordination Point: The utilisation of this API enables the effective control and coordination of the entire spectrum of an organisation’s IoT infrastructure within the OpenGate ecosystem.

Key Functionalities

• Comprehensive API Endpoints
  • /north/v80/search/organizations: Facilitates organization searches with customizable formats and filters.
  • /north/v80/search/organizations/summary: Offers summarised data about organisations for quick overviews.
  • /north/v80/provision/organizations: Enables the creation of new organisations with detailed JSON requests.
  • /north/v80/provision/organizations/{organizationId}: Manages specific organisation details, including retrieval, updates, and deletion.

Security and Access

• Secured Access: Employs the use of “ApiKeyAmplia” and “BearerAuthJWT” for the purpose of ensuring secure interactions with the API, thereby guaranteeing the integrity and confidentiality of the data.
• Consistent Endpoint: The API services are accessible at https://api.opengate.es, providing a stable and efficient gateway for organizational management.

This application programming interface (API) serves as the central nervous system of the OpenGate platform, offering sophisticated tools and interfaces for the administration of organisations. By mastering this API, users can effectively orchestrate the diverse components of their Internet of Things (IoT) solutions, ensuring seamless integration and optimal performance of their IoT ecosystem.

Plan feature

The Plan feature is a fundamental component of OpenGate, the function of which is to define the organisational usage limits. Each organization will have a specific plan setting, which may take the following forms:

• The maximum number of devices, gateways or assets the organization can have.
• The maximum time the collected data will be stored until it is evicted.
• The maximum number of events collected by the platform in a period.

Comprehensive API actions

Updating an organization

It should be noted that the domain is not an updatable field; therefore, its inclusion in the put will result in an error.

Searching organizations summary

In its default state, the summary displays the total counter, the counter for the organisational grouping, and the counter for the channel grouping.

API specification