Logo.CortexAG

Anmelden +

Portal-Funktionen

Mit Hilfe dieser Methoden ist es möglich, die Konfigurationen der Bereiche und Zeilen eines Portals auszulesen. Auch diese Informationen sind abhängig von den Benutzerrechten und können daher auch für weitere Anwendungen weiterverarbeitet werden.

Zu den Portal-Funktionen gehören:

  • getPortalList - Liefert eine Liste der verfügbaren Portale

  • getPortalRows - Liefert die Definition (Gruppen und Zeilen) eines Portals.

  • getPortalResult - Liefert eine Portaldefinition und die Ergebnisse

 

getPortalList

Liefert eine Liste der verfügbaren Portale für den angemeldeten Benutzer.

Anfrageobjekt

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

Rückgabeobjekt

{
"rc": int RetCode, "error": string ShortErrorDesc, "data": [ {
"i": string PortalId,
"n": string PortalName
},
... ]
}
 

data:

Es wird ein Array mit Objekten zurückgegeben.
Dabei steht im Feld "i" die interne ID des Portals; "n" liefert den Bezeichner des Portals.

Beispiel:

[
  {
    "i": "2068ddbc7a20202020212027",
    "n": "Kontakte"
  }
]

 

getPortalRows

Liefert die Definition (Gruppen und Zeilen) einer Portalkonfiguration. Auch hier gelten die Berechtigungen des Benutzers, so dass nur zugewiesene Portale abgefragt werden können.

Anfrageobjekt

{
  "method": "getPortalRows",
  "requestid": int RequestId,
  "param": {
    "portaliid": string PortalId,
    "UpdJsrHdl": string LoginHandle,
 
    //optional
    "pivotlist": string GetPivotInfo
  }
}

oder

{
  "method": "getPortalRows",
  "requestid": int RequestId,
  "param": {
    "portal": string PortalName,
    "UpdJsrHdl": string LoginHandle,

//optional
"pivotlist": string GetPivotInfo } }
  • UpdJsrHdl - Gültiges Login-Handle aus GetLogin
  • portaliid - Die interne ID des betreffenden Portals
  • portal - Name der Portal-Definition
  • pivotlist - Mit der optionalen Angabe "pivotlist":"1" wird die Information der in der Liste konfigurierten Pivottabellengeliefert.
 

Rückgabeobjekt

{
    "rc": int RetCode,
    "error": string ShortErrorDesc,
    "data": {
      "i": string PortalId,
      "n": string PortalName,
      "LastBearbId": string IntHandlingId,
      "r": string ReloadSeconds,
      "g": [
        {
          "n": string GroupName,
          "id": "",
          "groupnr": string GroupNumber,
          "z": [
            {
              "n": string RowName,
              "b": string RowInfoText,
              "id": "",
              "rownr": string RowNumber,
              "list": string ResultList,
              "listiid": string IntListId,

              //optional
              "pivot": string PivotNameToStart,

              //if request "pivotlist":"1"
              "listpivot":
              [
                string PivotName,
                string PivotName,
                ...
              ],
              //if reference date in row
              "listreldate": string RefDate
            }
          ]
        }
      ]
    }
}

 

data:

  • i - interne ID des Portals
  • n - Name des Portals
  • LastBearbId - interne ID zum letzten Bearbeitungsstand
  • r - Automatische Reloadzeit des Portals (in Sek.)
  • g - Ein Array mit Objekten, die die einzelnen Gruppendefinitionen des Portals enthalten
    • n - Name der Portalgruppe
    • id - derzeitig ungenutzt; in Folgeversionen genutzt
    • groupnr - Nummer der Gruppe (beginnend mit 0)
    • z - Ein Array mit Objekten, das die einzelnen Zeilendefinitionen der Gruppe enthält
      • n - Name der Zeile
      • b - Infotext der Zeile
      • id - derzeitig ungenutzt; in Folgeversionen genutzt
      • rownr - Nummer der Zeile → Nummerierung ist fortlaufend und gruppenübergreifend, also eine fortlaufende Nummerierung aller Zeilen unabhängig von der Gruppenzugehörigkeit
      • list - Name der aufzurufenden Liste
      • listiid - interne ID der aufzurufenden Liste
      • pivot - optional Name der Pivottabelle die beim Aufruf der Liste automatisch geöffnet werden soll
      • listpivot - wenn der optionale Parameter "pivotlist":"1" bei der Anfrage gesetzt wurde, dann erfolgt die Ausgabe der in der Liste konfigurierten Pivottabellen als Array
      • listreldate - optional, wenn für die Portalzeile ein Bezugsdatum gesetzt wurde

 

getPortalResult

Liefert die Ergebnisse eines Portals. Es wird nur die Selektion ausgeführt, ohne die Ergebnisse in eine Liste zu überführen.

Anfrageobjekt

{
  "method": "getPortalResult",
  "requestid": 3,
  "param": {
    "UpdJsrHdl": string LoginHandle,
 
    //Angabe Portal über ID
    "portaliid": string PortalId,
//oder: über name "portal": string PortalName,  
/* Aternativ zum Abruf des gesamten Portals besteht die Möglichkeit, nur Teile des Portals abzurufen */   //Variante 1: Gruppen-Nummern als Array (beliebig viele) //Abruf bestimmter Gruppen z.B. Abruf der 1. und 2. Gruppe "groupnr": ["0", "1"],   //Variante 2: Zeilen-Nummern als Array (beliebig viele) //Abruf bestimmter Portalzeilen z.B. Abruf der 3. und 5. Zeile "rownr": ["2", "4"],   //Variante 3: genau eine Zeile einer Gruppe //Abruf einer Portalzeile über Gruppen- und Zeilenname "group": "Projekte", "row": "Projekte mit PD",   //Variante 4: Kreuzmatrix mehrerer Gruppen (beliebig viele) //siehe Beispiel zu dieser Variante "groupmatrix": ["0", "1"], } }
  • UpdJsrHdl - Gültiges UpdJsrHdl

  • portaliid - Die interene Cortex-ID der betreffenden Portdefinition

  • portal - Name der Portdefinition

  •  

    Variante 1

     

    • groupnr - Array mit den Gruppennummern (als String)
  •  

    Variante 2

     

    • rownr - Array mit den Zeilennummern (als String)
  •  

    Variante 3

     

    • group - Name der Gruppe
    • row - Name der Zeile
  •  

    Variante 4

     

    • groupmatrix - Array mit den Gruppennummern (als String) die als Matrix verschachtelt werden sollen.
      Beispiel: In einer Portalgruppe werden Produkte selektiert; in einer anderen Gruppe Altersgruppen. Über eine Gruppenmatrix werden nun die Schnittmengen der Produkte zu Altergruppen ermittelt.

 

Rückgabeobjekt

{ 
  "n": "Projekte mit PD",
  "b": "Projekte die eine PD hinterlegt haben.",
  "id": "",
  "rownr": "2",
  "list": "Projekt",
  "listiid": "2066b15bf520202020212022",
  "pivot": "",
  "result": 23,
  "dur": 0.0005
}

Das Rückgabe-Objekt besitzt den identischen Aufbau wie die Funktion getPortalRows. Zusätzlich zur Rückgabe wurden zwei Angaben ergänzt.

  • result - Anzahl der Fundstellen

  • dur - Zeit (in Sekunden) die zum Ermitteln der Fundstellen benötigt wurde

Sollen nur bestimmte Gruppen oder Zeilen abgefragt werden, so werden auch nur die Definitionen dieser angefragten Teile zurückgegeben.

 

 Hinweise zur Online-Hilfe
 

© 2017 Cortex AG
(letzte Aktualisierung: 12.04.2017)

 Haftungsausschluss 

Impressum    AGB