Downloads |
  
|
Downloads |
|
In diesem Bereich können Beispielprogramme für die Portal-API runtergeladen werden.
In den Beispielen sind Quellcodes von Klassen und Funktionen zu finden:
- login() - listCompanies() - listUsers() - getUser() - getLicenseInfo() - listGroups() - createUser() - createNotification() - createPermissionGroup() - editUserIncremental() - deleteUser() - changePassword() - listComponents() - viewComponent() - viewComponent() - createComponent() - editComponent() - editComponentIncremental() - deleteComponent() - listObjects() - viewObject() - createObject() - editObject() - editObjectIncremental() - deleteObject() - listAddresses() - viewAddress() - createAddress() - editAddress() - editAddressIncremental() - deleteAddress() - listExternalUser() - viewExternalUser() - createExternalUser() - editExternalUser() - editExternalUserIncremental() - deleteExternalUser() |
- listMeasuredSensors() - viewMeasuredSensor() - createMeasuredSensor() - editMeasuredSensor() - editMeasuredSensorIncremental() - deleteMeasuredSensor() - updateMeasuredSensor() - getMeasuredSensorRawData() - getMeasuredSensorCleanData() - listVirtualSensors() - viewVirtualSensor() - createVirtualSensor() - editVirtualSensor() - editVirtualSensorIncremental() - deleteVirtualSensor() - updateVirtualSensor() - getVirtualSensorData() - listMaxPermissibleError() - listEavFields() - listTickets() - listTicketsHistoric() - viewTicket() - createTicketInternal() - editTicketIncremental() - deleteTicket() - createTicketMessage() - editTicketMessage() - exportEavFields() - importEavFields() - getStatus()
- sendAlarm() - sendData() - pullAcknowledgedAlarm() - readLiveData() - writeLiveData()
|
Beispiel in PHP:
/**
* Create new object.
*
* @param string $abbreviation
* The RDS
* @param string $name
* The object name
* @param string $common_name
* The common object name
* @param string $notice
* The object notice
* @param int $address_id
* Related address id
* @param int[] $user_groups
* Usergroup ids that are allowed to see this object
* @param array $components
* The components for this object.
* @param int $logo
* File id of logo
* @param array $additional
* Additional options that depends on choosen software.
*
* @return array
* The new object
* For example @see listObject()
*
* @throws Exception
*/
public function createObject($abbreviation, $name, $common_name, $notice,
$address_id, array $user_groups, array $components,
$logo = null, array $additional = array()) {
return $this->createAbstract('/object/add', 'object', 'object', array(
'abbreviation' => $abbreviation,
'name' => $name,
'common_name' => $common_name,
'notice' => $notice,
'address_id' => $address_id,
'user_groups' => $user_groups,
'components' => $components,
'logo' => $logo,
) + $additional);
}
Über die Portal-API können die meisten Funktionen des Portal ausgeführt werden. Dies erlaubt z.B. auch das Einlesen von externen Daten inkl. automatische Erstellung der Sensoren. Oder den Import von Objekt-Listen, Daten in EAV-Felder usw..
Damit ist es möglich, von einem externen Programm die Funktionen und/oder die Daten des Portals zu nutzen. Die Rechte für diesen programmtechnischen Zugang können im Portal verwaltet werden.