Übersicht der Bauteilfunktionen
Optionales Bauteil hinzufügen
Method Details
HTTP Method: POST
Method URI: API/AddObjectToCurrentObject
Response Format: JSON
Example POST URL:
http://localhost/CustomXApp/Api/AddObjectToCurrentObject
Example POST body:
{
"sessionid": "cjksdvcsk",
"objectId": "14711",
"readObject": "true",
"doconfig": "true"
}
Example response:
"14711"
Error response:
null
Erforderliche Parameter
| Parameter | Beschreibung |
| sessionid | ID einer aktiven Sitzung |
| objectId | Bauteilnummer (ObjectID) des einzufügenden Bauteils |
| readObject | true: Einfügen am Lesecursor false: Einfügen am Schreibcursor (mehr Informationen) |
| doconfig | true: Projekt wird berechnet false: Projekt wird nicht berechnet |
Antwort
Bauteilnummer (ObjectID) des eingefügten Bauteils oder null im Falle eines Fehlschlags.
Optionale Bauteile löschen
Method Details
HTTP Method: POST
Method URI: API/DeleteOptionalPart
Response Format: JSON
Example POST URL:
http://localhost/CustomXApp/Api/DeleteOptionalPart
Example POST body:
{
"sessionid": "cjksdvcsk",
"objectIdentNo": "14711",
"doconfig": "true"
}
Example response:
"14711"
Error response:
null
Erforderliche Parameter
| Parameter | Beschreibung |
| sessionid | ID einer aktiven Sitzung |
| objectIdentNo | ID eines Objektes (optionales Bauteil), das gelöscht werden soll |
| doconfig | true: Projekt wird berechnet false: Projekt wird nicht berechnet |
Antwort
Die Antwort lautet true für ein einfolgreiches Löschen und false für einen Fehlschlag.
Bauteile aus XML-Struktur zu Projekt hinzufügen
Method Details
HTTP Method: POST
Method URI: API/AddObjectsFromXmlStructureToProject
Response Format: JSON
Example POST URL:
http://localhost/CustomXApp/Api/AddObjectsFromXmlStructureToProject
Example POST body:
{
"sessionid": "cjksdvcsk",
"xmlStructure": "<XML Daten>",
"destProject": "4712",
"sourceProject": "4711"
}
Example response:
"cjksdvcsk"
Error response:
true
Erforderliche Parameter
| Parameter | Beschreibung |
| sessionid | ID einer aktiven Sitzung |
| xmlStructure | XML-Daten, die an customX übergeben werden. Die Struktur wird zusammen mit dem Regelwerksentwickler definiert |
| destProject | Neue Projekt-ID, wenn ID selbst vergeben werden soll. Ist der Parameter leer, vergibt customX die ID automatisch |
| sourceProject | Projekt-ID eines Projekts, das als Vorlage dupliziert wird |
Antwort
Die Antwort ist die übergebene ID der Sitzung oder null im Falle eines Fehlschlags.