North API

If you need information about common resources please visit following links:

Organizations

Join with the Domains, the organization is the concept to allow multitenantcy oin the platform. An Organization represent the owner of one or more IoT solutions.

Method Operation URI Description

POST

/north/v80/provision/organizations

Create a new Organization

GET

/north/v80/provision/organizations/{id}

Get an existing Organization Info

search (*)

POST

/north/v80/search/organizations

Search on the Organization List

PUT

/north/v80/provision/organizations/{id}

Update an existing Organization

DELETE

/north/v80/provision/organizations/{id}

Delete an existing Organization

Domains

Used to manage the permissions on the internal resources managed by the platform (Users, Organizations, Certificates, Bundles, …​). This is a powerful concept that well used allows to create the required hierarchy for large an complex organizations

Method Operation URI Description

POST

/north/v80/provision/domains

Create a new Domain

GET

/north/v80/provision/domains/{id}

Get an existing Domain Info

POST

/north/v80/search/domains

Search on the Domain List

PUT

/north/v80/provision/domains/{id}

Update an existing Domain

DELETE

/north/v80/provision/domains/{id}

Delete an existing Domain

Channels

Channels are group of Devices that belongs to a same IoT solution into an Organization

Method Operation URI Description

POST

/north/v80/provision/organizations/{org_id}/channels

Create a new Channel

GET

/north/v80/provision/organizations/{org_id}/channels/{id}

Get an existing Channel Info

POST

/north/v80/search/channels

Search on the Channel List

PUT

/north/v80/provision/organizations/{org_id}/channels/{id}

Update an existing Channel

DELETE

/north/v80/provision/organizations/{org_id}/channels/{id}

Delete an existing Channel

Devices

Represent Sensors, machines, communication gateways that are part of an IoT solution.

Method Operation URI Description

POST

/north/v80/provision/organizations/{org_id}/entities/devices

Create a new Device

GET

/north/v80/provision/organizations/{org_id}/entities/devices/{id}

Get an existing Device Info

POST

/north/v80/search/entities/devices

Search on the Devices List

POST

/north/v80/search/devices

Search on the Devices List fitlering by the Scoring values

PUT

/north/v80/provision/organizations/{org_id}/entities/devices/{id}

Update an existing Device

DELETE

/north/v80/provision/organizations/{org_id}/entities/devices/{id}

Delete an existing Device

Subscriptions

Represent different techonogies communications resources as the Line in Mobile 2G/3G/4G networks, token in Sigfox, SSID in Wifi, …​

Method Operation URI Description

POST

/north/v80/provision/organizations/{org_id}/entities/subscriptions

Create a new Subscription

GET

/north/v80/provision/organizations/{org_id}/entities/subscriptions/{id}

Get an existing Subscription Info

POST

/north/v80/search/entities/subscriptions

Search on the Subscriptions List

PUT

/north/v80/provision/organizations/{org_id}/entities/subscriptions/{id}

Update an existing Subscription

DELETE

/north/v80/provision/organizations/{org_id}/entities/subscriptions/{id}

Delete an existing Subscription

Subscribers

Join to the Subscription, represent the resource associated to some Network technologies (i.e. the SIM in Mobile 2G/3G/4G)

Method Operation URI Description

POST

/north/v80/provision/organizations/{org_id}/entities/subscribers

Create a new Subscriber

GET

/north/v80/provision/organizations/{org_id}/entities/subscribers/{id}

Get an existing Subscriber Info

POST

/north/v80/search/entities/subscribers

Search on the Subscribers List

PUT

/north/v80/provision/organizations/{org_id}/entities/subscribers/{id}

Update an existing Subscriber

DELETE

/north/v80/provision/organizations/{org_id}/entities/subscribers/{id}

Delete an existing Subscriber

Communications Modules

Represent the Communications interfaces that are part of a Device (i.e. Mobile 2G/3G/4G, Wifi, Ethernet, Serial Port, …​)

Method Operation URI Description

POST

/north/v80/provision/organizations/{org_id}/entities/communicationsModules

Create a new Communications Module

GET

/north/v80/provision/organizations/{org_id}/entities/communicationsModules/{id}

Get an existing Communications Module Info

POST

/north/v80/search/entities/communicationModules

Search on the Communication Modules List

PUT

/north/v80/provision/organizations/{org_id}/entities/communicationsModules/{id}

Update an existing Communications Module

DELETE

/north/v80/provision/organizations/{org_id}/entities/communicationsModules/{id}

Delete an existing Communications Module

Entity Relations

Represent the association between devices and the other entities as Subsctiptions, Subscribers and Communications Modules

Method Operation URI Description

POST

/north/v80/provision/organizations/{org_id}/entities/relations

Create a new Relation

GET

/north/v80/provision/organizations/{org_id}/entities/relations/{entity_id}

Get an existing Relation Info

PUT

/north/v80/provision/organizations/{org_id}/entities/relations/{entity_id}

Update an existing Relation

DELETE

/north/v80/provision/organizations/{org_id}/entities/relations/{entity_id}

Delete an existing Relation

Bulk Entities Provision

Allows to make massive entities provision

Method Operation URI Description

POST

/north/v80/provision/organizations/{org_id}/bulk/entities

Create a Bulk of Entities

PUT

/north/v80/provision/organizations/{org_id}/bulk/entities

Update an existing Bulk of Entities

DELETE FCertifi

/north/v80/provision/organizations/{org_id}/bulk/entities

Delete an existing Bulk of Entities

Software Bundles

Represent the software/firmware/configuration packages to be updated on the IoT device

Method Operation URI Description

POST

/north/v80/provision/bundles

Create a new Bundle

GET

/north/v80/provision/bundles/{id}

Get an existing Bundle Info

POST

/north/v80/search/catalog/softwares

Search on the Software List

PUT

/north/v80/provision/bundles/{id}

Update an existing Bundle

DELETE

/north/v80/provision/bundles/{id}

Delete an existing Bundle

POST

/north/v80/provision/bundles/{bundle_id}/versions/{version_id}/deploymentElements

Create a new Deployment Element

GET

/north/v80/provision/bundles/{bundle_id}/versions/{version_id}/deploymentElements/{id}

Get an Deployment Element Info

PUT

/north/v80/provision/bundles/{bundle_id}/versions/{version_id}/deploymentElements/{id}

Update an existing Deployment Element

DELETE

/north/v80/provision/bundles/{bundle_id}/versions/{version_id}/deploymentElements/{id}

Delete an existing Deployment Element

Tags

Allows to tag a set of entities (devices, subscriptions, subscribers, communications modules) to be used for filtering purposes on search and operation APIs

Method Operation URI Description

POST

/north/v80/provision/tags

Create a new Tag

GET

/north/v80/provision/tags/{id}

Get an existing Tag Info

GET

/north/v80/provision/tags/{tag_id}/entities

Get the entities associated to a Tag

PUT

/north/v80/provision/tags/{id}

Update an existing Tag

DELETE

/north/v80/provision/tags/{id}

Delete an existing Tag

Automation Rules

The Rules allow automate actions (launch operations, notifying, arise alarms, …​) when some specified conditions are given

Method Operation URI Description

GET

/north/v80/provision/organizations/{org_id}/channels/{channel_id}/ruleconfigurations

Get an existing Automation Rule Info

PUT

/north/v80/provision/organizations/{org_id}/channels/{channel_id}/ruleconfigurations

Update an existing Automation Rule

Acces Point Names (APNs)

Method Operation URI Description

POST

/north/v80/provision/apns

Create a new Relation

GET

/north/v80/provision/apns/{id}

Get an existing Relation Info

DELETE

/north/v80/provision/apns/{id}

Delete an existing Relation

Workgroups

This concept allows creating specific views of a subset of the entire list of devices belonging to one or many organization to be accessible to specific users

Method Operation URI Description

POST

/north/v80/provision/domains/{domain_id}/workgroups

Create a new Workgroup

GET

/north/v80/provision/domains/{domain_id}/workgroups/{id}

Get an existing Workgroup Info

POST

/north/v80/search/workgroups

Search on the Workgroup List

PUT

/north/v80/provision/domains/{domain_id}/workgroups/{id}

Update an existing Workgroup

DELETE

/north/v80/provision/domains/{domain_id}/workgroups/{id}

Delete an existing Workgroup

POST

/north/v80/provision/domains/{domain_id}/workgroups/{workgroup_id}/relations

Add a Channel to an existing Workgroup

GET

/north/v80/provision/domains/{domain_id}/workgroups/{workgroup_id}/relations

Get Channels associated an existing Workgroup

DELETE

/north/v80/provision/domains/{domain_id}/workgroups/{workgroup_id}/relations

Delete Channels from an existing Workgroup

Users

Method Operation URI Description

POST

/north/v80/provision/users

Create a new User

GET

/north/v80/provision/users/{id}

Get an existing User Info

POST

/north/v80/search/users

Search on the User List

PUT

/north/v80/provision/users/{id}

Update an existing User

DELETE

/north/v80/provision/users/{id}

Delete an existing User

Radius Clients

This concept allows an organization to configure the integration with radius servers that are part of the IoT solution

Method Operation URI Description

POST

/north/v80/provision/radiusClients

Create a new Radius Client

GET

/north/v80/provision/radiusClients/{id}

Get an existing Radius Client Info

PUT

/north/v80/provision/radiusClients/{id}

Update an existing Radius Client

DELETE

/north/v80/provision/radiusClients/{id}

Delete an existing Radius Client

Certificates

Allows managing the certificates used for the different features of the OpenGate security framework

Method Operation URI Description

add

POST

/north/v80/provision/security/certificates

Add a new Certificate

GET

/north/v80/provision/security/certificates/{id}

Get an existing Certificate Info

POST

/north/v80/search/certificates

Search on the Certificate List

PUT

/north/v80/provision/security/certificates/{id}

Update an existing Certificate

DELETE

/north/v80/provision/security/certificates/{id}

Remove an existing Certificate

Datamodels

Allows managing the datamodels defining the list of parameters supported in a IoT solution. For more information about profles, please visit link:../api-north/opengate-api-north-provision-iot-datamodels.html

Method Operation URI Description

POST

/north/v80/provision/organizations/{org_id}/datamodels

Create a new IoT Datamodel

GET

/north/v80/provision/organizations/{org_id}/datamodels/{id}

Get an existing IoT Datamodel

POST

/north/v80/search/datamodels

Search on the Datamodel List

PUT

/north/v80/provision/organizations/{org_id}/datamodels/{id}

Update an existing IoT Datamodel

DELETE

/north/v80/provision/organizations/{org_id}/datamodels/{id}

Remove an existing IoT Datamodel

Manufacturers

Allows manage the list of Hardware and Software Manufacturers catalogued by the platform

Method Operation URI Description

add

POST

/north/v80/provision/manufacturers

Add a new Manufacturer

GET

/north/v80/provision/manufacturers/{id}

Get an existing Manufacturer Info

POST

/north/v80/search/hardwares

Search on the Hardware List

PUT

/north/v80/provision/manufacturers/{id}

Update an existing Manufacturer

DELETE

/north/v80/provision/manufacturers/{id}

Remove an existing Manufacturer

POST

/north/v80/provision/manufacturers/{manufacturerId}/media

Add a new Manufacturer Media File

GET

/north/v80/provision/manufacturers/{manufacturerId}/media/{id}

Get an existing Manufacturer Media File

DELETE

/north/v80/provision/manufacturers/{manufacturerId}/media/{id}

Remove an existing Manufacturer Media File

Hardware Models

Allows manage the list of Hardware Models catalogued by the platform

Method Operation URI Description

add

POST

/north/v80/provision/models

Add a new Manufacturer

GET

/north/v80/provision/models/{id}

Get an existing Manufacturer Info

POST

/north/v80/search/hardwares

Search on the Hardware List

PUT

/north/v80/provision/models/{id}

Update an existing Manufacturer

DELETE

/north/v80/provision/models/{id}

Remove an existing Manufacturer

POST

/north/v80/provision/models/{modelId}/media

Add a new Model Media File

GET

/north/v80/provision/models/{modelId}/media/{id}

Get an existing Model Media File

DELETE

/north/v80/provision/models/{modelId}/media/{id}

Remove an existing Model Media File

Areas

Used to manage the permissions on the internal resources managed by the platform (Users, Organizations, Certificates, Bundles, …​). This is a powerful concept that well used allows to create the required hierarchy for large an complex organizations

Method Operation URI Description

POST

/north/v80/provision/organizations/{organizationName}/areas

Create a new Area

GET

/north/v80/provision/organizations/{organizationName}/areas/{identifier}

Get an existing Area Info

PUT

/north/v80/provision/organizations/{organizationName}/areas/{identifier}

Update an existing Area

DELETE

/north/v80/provision/organizations/{organizationName}/areas/{identifier}

Delete an existing Area

Software

Allows manage the list of Software catalogued by the platform

Method Operation URI Description

POST

/north/v80/search/catalog/softwares

Search on the Software List

Operation - Operations

Allows manage the list of operations executed on devices by the platform

Method Operation URI Description

POST

/north/v80/search/entities/devices/operations

Search on the Operation List on devices

Operation - Jobs

Allows operate the IoT resources managed by the platform (devices, ..). This is a powerful set of methods that allow execute sigle or massive operations on devices or other managed resources

Method Operation URI Description

POST

/north/v80/operation/jobs

Create and Execute a new Job

PUT

/north/v80/operation/jobs/{id}

See update operation

GET

/north/v80/operation/jobs/{id}

Get an existing Job Info

GET

/north/v80/operation/jobs/{jobId}/operations

Get operations on an existing Job

GET

/north/v80/operation/jobs/{jobId}/operations/{id}

Get result of an exsiting operation

POST

/north/v80/search/jobs

Search on the Job List

PUT

/north/v80/operation/jobs/{id}

Update an existing Job

DELETE

/north/v80/operation/jobs/{id}

Cancel & Delete an existing Job

Operation - Tasks

Allows manage repetitive Jobs

Method Operation URI Description

POST

/north/v80/operation/tasks

Create a new Task

GET

/north/v80/operation/tasks/{id}

Get an existing Task Info

GET

/north/v80/operation/tasks/{task_id}/jobs

Get the Jobs of an existing Task

search (*)

POST

/north/v80/search/tasks

Search on the Tasks List

PUT

/north/v80/operation/tasks/{id}

Update an existing Task

DELETE

/north/v80/operation/tasks/{id}

Remove an existing Task

Alarms

Specific operations on raised alarms

Method Operation URI Description

POST

/north/v80/search/entities/devices/alarms

Search on the raised alarm list

POST

/north/v80/operation/alarms

Change Status

IoT - Datastreams

Allows the management of IoT Business data and other adhoc information that requires an IoT solution. The Datastream concept represents the current value and summary of a parameter in the Datamodel

Method Operation URI Description

POST

/north/v80/search/datastreams

Search Datastreams

IoT - Datapoints

Allows the management of IoT Business data and other adhoc information that requires an IoT solution. The Datapoint concept represents the history data of a parameter in the Datamodel

Method Operation URI Description

POST

/north/v80/search/datapoints

Search Datapoints of one o different Datastreams

IoT - Feeds

Allows the management of IoT Business data and other adhoc information that requires an IoT solution. The Feed concept allows to track the datastreams information through the different elements (i.e. users) that has been used a device when a meassure has been taken

Method Operation URI Description

POST

/north/v80/search/feeds

Search Feeds

Coming soon

The next search services will be available soon:

  • Search Organizations

  • Search Tasks