2016-06-30 08:55:47 +00:00
|
|
|
Notifications
|
|
|
|
|
=============
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
Notifications can be received from the controller, they can be used to update your local data.
|
2016-06-30 08:55:47 +00:00
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
Notification endpoints
|
|
|
|
|
**********************
|
2016-06-30 08:55:47 +00:00
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
Listen to the HTTP stream endpoint or to the Websocket endpoint.
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
* :doc:`api/v2/controller/project/projectsprojectidnotifications`
|
|
|
|
|
* :doc:`api/v2/controller/project/projectsprojectidnotificationsws`
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
It is recommended to use the Websocket endpoint.
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
Available notifications
|
|
|
|
|
***********************
|
|
|
|
|
|
|
|
|
|
.. contents::
|
|
|
|
|
:local:
|
|
|
|
|
|
|
|
|
|
ping
|
|
|
|
|
----
|
2018-01-31 16:37:02 +00:00
|
|
|
Keep-alive between client and controller. Also used to receive the current CPU and memory usage.
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/ping.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
compute.created
|
|
|
|
|
----------------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
A compute has been created.
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/compute.created.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
compute.updated
|
|
|
|
|
----------------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
A compute has been updated.
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/compute.updated.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
compute.deleted
|
|
|
|
|
---------------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
A compute has been deleted.
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/compute.deleted.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
node.created
|
|
|
|
|
------------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
A node has been created.
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/node.created.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
node.updated
|
|
|
|
|
------------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
A node has been updated.
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/node.updated.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
node.deleted
|
|
|
|
|
------------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
A node has been deleted.
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/node.deleted.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
link.created
|
|
|
|
|
------------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
A link has been created. Note that a link is not connected
|
|
|
|
|
to any node when it is created.
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/link.created.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
link.updated
|
|
|
|
|
------------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
A link has been updated.
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/link.updated.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
link.deleted
|
|
|
|
|
------------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
A link has been deleted.
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/link.deleted.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
drawing.created
|
|
|
|
|
---------------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
A drawing has been created.
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/drawing.created.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
drawing.updated
|
|
|
|
|
---------------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
A drawing has been updated. The svg field is only included if it
|
|
|
|
|
has changed in order to reduce data transfer.
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/drawing.updated.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
drawing.deleted
|
|
|
|
|
---------------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
A drawing has been deleted.
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/drawing.deleted.json
|
|
|
|
|
|
|
|
|
|
|
2016-08-15 14:44:09 +00:00
|
|
|
project.updated
|
|
|
|
|
---------------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
A project has been updated.
|
2016-08-15 14:44:09 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/project.updated.json
|
|
|
|
|
|
|
|
|
|
|
2016-08-15 10:06:26 +00:00
|
|
|
project.closed
|
|
|
|
|
---------------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
A project has been closed.
|
2016-08-15 10:06:26 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/project.closed.json
|
|
|
|
|
|
|
|
|
|
|
2016-08-19 15:05:28 +00:00
|
|
|
snapshot.restored
|
|
|
|
|
--------------------------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
A snapshot has been restored
|
2016-08-19 15:05:28 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/project.snapshot_restored.json
|
2016-08-15 10:06:26 +00:00
|
|
|
|
2016-06-30 08:55:47 +00:00
|
|
|
log.error
|
|
|
|
|
---------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
Sends an error
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/log.error.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
log.warning
|
|
|
|
|
------------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
Sends a warning
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/log.warning.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
log.info
|
|
|
|
|
---------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
Sends an information
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/log.info.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
settings.updated
|
|
|
|
|
-----------------
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
GUI settings have been updated. Will be removed in a later release.
|
2016-06-30 08:55:47 +00:00
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/settings.updated.json
|
