Übersicht der Parameterfunktionen
Bevor Parameter übergeben oder abgefragt werden können, ist es notwendig den Cursor auf das entsprechende Objekt (Bauteil) zu setzen. Weitere Informationen finden Sie bei den Navigationsfunktionen.
Parameter übergeben
Method Details
HTTP Method: POST
Method URI: API/SetVar
Response Format: JSON
Example POST URL:
http://localhost/CustomXApp/Api/SetVar
Example POST body:
{
"sessionid": "c009f9dc",
"varname": "Breite",
"varvalue": "3000"
}
Example response:
"true"
Erforderliche Parameter
| Parameter | Beschreibung |
| sessionid | ID einer aktiven Sitzung |
| varname | Name des Parameters, dessen Wert übergeben werden soll |
| varvalue | Wert des Parameters, der übergeben werden soll. Zahlen müssen in der invarianten culture (1.23) übergeben werden |
Antwort
Die Antwort lautet true für eine einfolgreiche Übergabe und false für einen Fehlschlag.
Parameter abfragen
Method Details
HTTP Method: POST
Method URI: API/GetVar
Response Format: JSON
Example POST URL:
http://localhost/CustomXApp/Api/GetVar
Example POST body:
{
"sessionid": "c009f9dc",
"varname": "Breite",
"searchparent": "false"
}
Example response:
"true"
Erforderliche Parameter
| Parameter | Beschreibung |
| sessionid | ID einer aktiven Sitzung |
| varname | Name des Parameters, dessen Wert abgefragt wird |
| searchparent | true: Parameter wird am aktuellen Objekt (Bauteil) und übergeordneten Objekten gesucht false: Parameter wird nur am aktuellen Objekt (Bauteil) gesucht |
Antwort
Die Antwort ist der Inhalt des Parameters und null falls der Parameter nicht gefunden wurde.