Raritan PX2/PX3 JSON-RPC API
DataPushService.idl
1 #include <UserEvent.idl>
2 
4 module event {
5 
8 
12  enumeration EntryType {
17  AUDITLOG
18  };
19 
21  constant int ERR_NO_SUCH_ID = 1;
22  constant int ERR_INVALID_PARAMS = 2;
23  constant int ERR_MAX_ENTRIES_REACHED = 3;
24 
28  structure EntrySettings {
29  string url;
31  string caCertChain;
32  boolean useAuth;
33  string username;
34  string password;
36  vector<string> items;
37  };
38 
42  structure EntryStatus {
43  boolean busy;
44  boolean rescheduled;
45  time lastAttemptTime;
48  };
49 
53  valueobject EntryAddedEvent extends UserEvent {
54  int entryId;
56  };
57 
61  valueobject EntryModifiedEvent extends UserEvent {
62  int entryId;
65  };
66 
70  valueobject EntryDeletedEvent extends UserEvent {
71  int entryId;
72  };
73 
77  valueobject EntryStatusChangedEvent extends idl.Event {
78  int entryId;
80  };
81 
92  int addEntry(out int entryId, in EntrySettings entrySettings);
93 
104  int modifyEntry(in int entryId, in EntrySettings entrySettings);
105 
114  int deleteEntry(in int entryId);
115 
125  int getEntry(out EntrySettings entrySettings, in int entryId);
126 
132  map<int, EntrySettings> listEntries();
133 
143  int pushData(in int entryId);
144 
154  int getEntryStatus(out EntryStatus entryStatus, in int entryId);
155 
156  };
157 
158 }
EntrySettings oldSettings
Settings before change.
Definition: DataPushService.idl:63
boolean allowOffTimeRangeCerts
allow expired and not yet valid TLS certificates
Definition: DataPushService.idl:30
EntryStatus newStatus
New status.
Definition: DataPushService.idl:79
string caCertChain
TLS CA certificate chain.
Definition: DataPushService.idl:31
Asset Management information for a set of AMS strips.
Definition: DataPushService.idl:15
Data Push Entry Status.
Definition: DataPushService.idl:42
string username
Authentication user name.
Definition: DataPushService.idl:33
Sensor values for a set of sensors.
Definition: DataPushService.idl:13
Basic IDL definitions.
Definition: Event.idl:6
vector< string > items
Included items (e.g. list of sensors) depending on type.
Definition: DataPushService.idl:36
EntryType
Data Push Entry Types.
Definition: DataPushService.idl:12
boolean useAuth
true to use HTTP basic authentication
Definition: DataPushService.idl:32
boolean rescheduled
true if the entry is set to be pushed again immediately after completion
Definition: DataPushService.idl:44
EntrySettings newSettings
Settings after change.
Definition: DataPushService.idl:64
Sensor log.
Definition: DataPushService.idl:14
time lastSuccessTime
Timestamp of last successful push (0 = never)
Definition: DataPushService.idl:47
EntrySettings settings
New entry settings.
Definition: DataPushService.idl:55
EntryType type
Type of data.
Definition: DataPushService.idl:35
string password
Password; write-only, empty to leave unchanged.
Definition: DataPushService.idl:34
boolean busy
true if the entry is currently being pushed
Definition: DataPushService.idl:43
Data push service configuration interface.
Definition: DataPushService.idl:7
valueobject UserEvent
This UserEvent may be used as base valueobject for all concrete events that are triggered because of ...
Definition: UserEvent.idl:16
Data Push Entry Settings.
Definition: DataPushService.idl:28
Asset Management log.
Definition: DataPushService.idl:16
string url
Destination host.
Definition: DataPushService.idl:29