REST-Schnittstelle
      Zurück zur Startseite
      1. Service-Portal
      2. Schnittstellen
      3. REST-Schnittstelle

      Navigationsfunktionen - customX REST-Schnittstelle

      Übersicht der Navigationsfunktionen

      ⚙️ Verfügbar ab: Release 6

      ❗ Wichtige Änderung: Release 8.29

      🧩 Dieser Artikel enthält Funktionalitäten einer oder mehr Zusatzoptionen

      In customX gibt es zwei Eingabemarker (Cursor). Einen Cursor zum Schreiben und einen zum Lesen von Parametern. Der Schreibcursor wählt ein Objekt (Bauteil) aus, an welches Parameter geschrieben werden, der Lesecursor selektiert das Objekt, von dem Parameter abgefragt werden. Die Navigationsfunktionen werden in Verbindung mit Bauteil- oder Parameterfunktionen genutzt.

      Objekt auswählen

      Method Details

      HTTP Method: POST
      Method URI: API/SetCurrentObject
      Response Format: JSON

      Example POST URL:
      http://localhost/CustomXApp/Api/SetCurrentObject

      Example POST body:
      {
      "sessionid": "c009f9dc",
      "readobject": "true",
      "selectobjectmode": "0"
      }

      Example response:
      e5ed02c1946f435bb165c072f91ef54a

      Error response:
      null

      Erforderliche Parameter

      Parameter Beschreibung
      sessionid ID einer aktiven Sitzung
      readobject true: Lesecursor ist ausgewählt
      false: Schreibcursor ist ausgewählt
      selectobjectmode Möglichkeiten zur Auswahl eines Objektes:
      0: Root
      1: Parent
      2: Bestimmtes Objekt
      objectidentno ID des Objektes, das ausgewählt werden soll im Falle von selectobjectmode=2

      Antwort

      ID des Objektes (objectidentno) bei Erfolg, ansonsten null.

      Liste an untergordneten Objekten

      Method Details

      HTTP Method: POST
      Method URI: API/GetChildList
      Response Format: JSON

      Example POST URL:
      http://localhost/CustomXApp/Api/GetChildList

      Example POST body:
      {
      "sessionid": "c009f9dc",
      "readobject": "true",
      "childListType": "0"
      }

      Example response:
      [
          "82ee9768b69d400d8146205ccbf8cca0",
          "a3b878bd5fe6418084ecbf1cef7c927b",
          "583b7936a1d947f99f8028315e29bcda",
          "1d9bf267ac14489c8f0a6758bb39d164",
          "859df4809e454b8b9adecb83c61296e6",
          "f1c899f4e5fa476c93ea530a72cc6be1"
      ]

      Error response:
      null

      Erforderliche Parameter

      Parameter Beschreibung
      sessionid ID einer aktiven Sitzung
      readObject true: Lesecursor ist ausgewählt
      false: Schreibcursor ist ausgewählt
      childListType 0: Produktstruktur
      1: Fertigungsstruktur
      2: Benutzerstruktur
      3: Angebotsstruktur

      Antwort

      Liste von Objektnummern (ObjectIdentNo) in Form eines Arrays. Im Falle eines Fehlschlags null.