Each organization has its own hardware manufacturers and model catalogue. This information can be related to entities like devices.
Limited access API
Limited access
The provisioning API of this feature is only available to admin_domain and super_admin_domain profiles; on the other hand, anyone can use the searching API. Ask your administrator for proper user role profiling.
Some information of interest
Unique manufacturer name restriction
When a manufacturer is created, this can be assigned to entities in the same organization, including this one’s children; the non-name repeating restriction applies to the entire tree where that organization is located.
Hardware models and their relationships with entities
Entities such as devices can have their hardware model stored as part of their information. These models will be the ones belonging to the manufacturers available for the organization where the entity is.
When you edit or delete manufacturers’ or models’ information, you can choose whether you want this reflected in the entity’s information.
Follow the following links to check out the OpenAPI specs:
This is an API that allow to provide and manage the list of hardware models
and manufacturers used in an organization. Here you can register manufacturers and
models data to be referenced in devices information.
See Manufacturer object bellow on schemas.
Comprehensive API actions
Updating a manufacturer
‘UpdateDevices’ parameter
It is possible that entities may contain references to models that were previously manufactured by a now-deleted manufacturer. Consequently, deleting the manufacturer may result in a new discrepancy between its information and that of the entities. The updateDevices parameter allows the user to choose whether this action should be reflected or not. However, this only affects the manufacturer’s information; models remain unaffected.
Deleting Manufacturer
Warning
In the event that a manufacturer has already deployed models within the OpenGate framework, it is not possible to remove them.
‘UpdateDevices’ parameter
It is possible that entities may contain references to models that were previously manufactured by a now-deleted manufacturer. Consequently, deleting the manufacturer may result in a new discrepancy between its information and that of the entities. The updateDevices parameter allows the user to choose whether this action should be reflected or not. However, this only affects the manufacturer’s information; models remain unaffected.
Reading the organization manufacturer list
Visibility parameter
There are multiple methods for retrieving manufacturer lists, which are controlled by the “visibility” parameter. This parameter has the following possible values:
default: In the event that the aforementioned parameter is not transmitted, or if it is transmitted with the default value, the list of manufacturers that are part of the specified organisation, as indicated in the URL, will be returned.
assignable: The aforementioned value will yield a list of manufacturers that can be assigned to entities within the specified organisational structure, as indicated by the URL. This list comprises the manufacturers within the aforementioned organisational structure, along with their respective parents.
administrable: Upon transmission of this value, a list of manufacturers that can be managed will be returned. In the event that permissions are lacking for the specified action, or if the manufacturer is part of the organisation indicated in the URL and its subsidiaries, the list will be empty.
API specification
Models
Introduction
This API enables the provisioning and management of hardware models that are utilized to associate with the entities within an organizational structure.
Comprehensive API actions
Reading a model
It is possible that entities may contain references to models that were previously manufactured by a now-deleted manufacturer. Consequently, deleting the manufacturer may result in a new discrepancy between its information and that of the entities. The updateDevices parameter allows the user to choose whether this action should be reflected or not. However, this only affects the manufacturer’s information; models remain unaffected.
Deleting a model
It is possible that entities may contain references to models that were previously manufactured by a now-deleted manufacturer. Consequently, deleting the manufacturer may result in a new discrepancy between its information and that of the entities. The updateDevices parameter allows the user to choose whether this action should be reflected or not. However, this only affects the manufacturer’s information; models remain unaffected.