Navigationsfunktionen - customX REST-Schnittstelle

Übersicht der Navigationsfunktionen

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:


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:
["c133d796cd354e21a289b9c34dac7c52", "d51a2b0fc3d046dfbab74a79658d79a2"]

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.