Logo.CortexAG

Anmelden +

Allgemeine Funktionen

In den allgemeinen Funktionen stehen globale Methoden zur Verfügung, die nicht an UniPlex-Funktionen gekoppelt sind. Diese können daher ohne Benutzerkontext aufgerufen werden und liefern beispielsweise Server- oder Schnittstellen-Angaben zurück.

Hierzu gehören:

  • getVersion
  • getLogin
  • getLogout
  • getInfo
  • clearCache

Das Rückgabe-Objekt liefert grundsätzlich einen Fehlercode (0=ok) und den eigentlichen Rückgabewert (im "data"-Feld).

{
    "rc": int RetCode,
    "error": string ShortErrorDesc,
    "data": 
    {
      .....
    }
}

In den nachfolgenden Beschreibungen wird nur das "data"-Objekt erläutert. Etwaige Fehlercodes können Sie aus der Liste der Fehlercodes ablesen.

 

getVersion

Liefert die aktuelle Versionskennung des DataService und benötigt keinen Login.

Anfrageobjekt

{
  "method": "getVersion",
  "requestid": int RequestId,
  "param": {}
}
 

Rückgabeobjekt (result-object)

{
  'requesterror': int RequestStatus,
  'requestmethod': string MethodName,
  'requestid': int RequestId,
  'requestduration': float Duration,
  'result': {
-result-data-
} }

 

result-data

{
    "rc": int RetCode,
    "error": string ShortErrorDesc,
"data": {
"version": int Version,
"versionstr": strin VersionStr,
"versionmain": int MainVersion,
"versionsub": int SubVersion,
"releasedate": string Date
}
}
 
data
  • version - Versionskennung (ohne Unterteilung; z.B.: 21001)
  • versionstr - Versionskennung (mit Unterteilung z.B.: "2.1.001")
  • versionmain - Versionskennung (Hauptversion und Release; z.B.: 21)
  • versionsub - Versionskennung (Release/Subversion; z.B.: 1)
  • releasedate - letzte Aktualisierung (z.B.: "03.06.2014")
 

getLogin

Führt einen Login in der CortexDB durch und liefert bei Erfolg ein Login-Handle (UpdJsrHdl).

Anfrageobjekt

{
  "method": "getLogin",
  "requestid": int RequestId,
  "param": {
    "user": string Username,
    "pass": string Password,
    "app": string AppName
  }
}
  • user - Benutzername
  • pass - Benutzerpasswort
  • app - App mit der der Login erfolgen soll → immer "UniplexDataservice" !

Rückgabe  (result)

 

{
  'requesterror': int RequestStatus,
  'requestmethod': string MethodName,
  'requestid': int RequestId,
  'requestduration': float Duration,
  'result': {
-result-data-
} }

 

result-data

{
    "rc": int RetCode,
    "error": string ShortErrorDesc,
    "data": {
"UpdJsrHdl": string Login-Handle,
"UserName": string UserName,
"UserDisplayName": string UserDisplayName,
"UserID": int UserId,
"lic": string Licensee,
"licnr": string LicenseNumber
}
}
 
data:
  • UpdJsrHdl - bei erfolgreichem Login der Login-Handle
    (z.B. "267361e2a8e94be6b611c8f0b3a54f52")
  • UserName - Benutzername des Logins
  • UserDisplayName - angezeigter Benutzername (Konfiguration im UniPlex)
  • UserID - Id des Benutzers (Konfiguration über RemoteAdmin)
  • lic - Lizenznehmer der Datenbank
  • licnr - Lizenznummer der Datenbank

 

getLogout

Nur nach vorherigem Login möglich! Führt einen Logout des Benutzers mit dem übergebenen Login-Handle durch.

Anfrageobjekt

{
  "method": "getLogout",
  "requestid": int RequestId,
  "param": {
    "UpdJsrHdl": string LoginHandle
  }
}
  • UpdJsrHdl - Login-Handle, der über getLogin zurückgeliefert wurde
    (z.B. "267361e2a8e94be6b611c8f0b3a54f52")

Rückgabeobjekt

Es werden nur die generellen Angaben zurückgegeben, das "data"-Objekt bleibt leer.

Beispiel:

{
  "requesterror": 0,
  "requestid": 18,
  "requestmethod": "getLogout",
  "requestduration": 0.0009,
  "result": {
    "rc": 0,
    "error": "",
    "data": []
  }
}

 

getInfo

Nur nach vorherigem Login möglich! Liefert erweiterte Angaben.

Anfrageobjekt

{
  "method": "getInfo",
  "requestid": int RequestId,
  "param": {
    "UpdJsrHdl": string LoginHandle
  }
}
  • UpdJsrHdl - Login-Handle, das über getLogin zurückgeliefert wurde

 

Rückgabeobjekt (result-object)

 

{
  'requesterror': int RequestStatus,
  'requestmethod': string MethodName,
  'requestid': int RequestId,
  'requestduration': float Duration,
  'result': {
-result-data-
} }

 

result-data

{
  "rc": int RetCode, "error": string ShortErrorDesc,
  "data": {
    "lic_nam": string Licensee,
    "lic_nr": string LicenseNumber,
    "ctx_interfaceversion": int ServerInterfaceVersion,
    "ctx_serverversion": int ServerVersion,
   "UserName": string UserName,
    "UserDisplayName": string UserDisplayName,
    "UserID": string UserId,
    "UserAdmin": int UserIsWebAdmin,
    "upd_version": int DataServiceVersion,
    "upd_versionstr": string DataServiceVersion,
    "upd_versionmain": int DataServiceVersionMainRelease,
    "upd_versionsub": int DataServiceVersionSub,
    "upd_releasedate": string DataServiceReleaseDate
  }
}

 

data

  • lic_nam - Name des Lizenznehmers,
  • lic_nr - Lizenznummer,
  • ctx_interfaceversion - CortexDB Schnittstellen-Version,
  • ctx_serverversion - CortexDB Server-Version,
  • UserName - eingelogger Benutzername,
  • UserDisplayName - angezeigter Benutzername,
  • UserID - ID des Benutzers,
  • UserAdmin - wenn Benutzer Webadmin ist, dann 1, sonst 0,
  • upd_version - Versionsangabe des DataService,
  • upd_versionstr - Versionsangabe des DataService,
  • upd_versionmain - Hauptversion und Release,
  • upd_versionsub - Unterversion,
  • upd_releasedate - Release-Datum

 

clearCache

Löscht den internen Puffer/Cache.

Anfrageobjekt

{
  "method": "clearCache",
  "requestid": int RequestID,
  "param": {
    "UpdJsrHdl": "string LoginHandle"
  }
}

Rückgabeobjekt

{
    "rc": int RetCode,
    "error": string ShortErrorDesc,
"data": [ ]
}

Bei dieser Funktion werden keine Daten zurückgegeben.

 

 Hinweise zur Online-Hilfe
 

© 2017 Cortex AG
(letzte Aktualisierung: 12.04.2017)

 Haftungsausschluss 

Impressum    AGB