Projektfunktionen - customX REST-Schnittstelle

Übersicht der Projektfunktionen

Neues Projekt anlegen

Method Details

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

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

Example POST body:
{
"sessionid": "c009f9dc",
"newprojectno": "4712",
"sourceprojectno": "4711"
}

Example response:
"4712"

Error response:
null

Erforderliche Parameter

Parameter Beschreibung
sessionid ID einer aktiven Sitzung

Optionale Parameter

Parameter Beschreibung
newprojectno Neue Projekt-ID, wenn ID selbst vergeben werden soll. Ist der Parameter leer, vergibt customX die ID automatisch.
sourceprojectno Projekt-ID eines Projekts, das als Vorlage dupliziert wird.

Antwortdetails

Die Antwort enthält entweder die Projekt-ID des neu angelegten Projekts oder null im Falle eines Fehlschlags.


Projekt laden

 

Method Details

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

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

Example POST body:
{
"sessionid": "c009f9dc",
"projectno": "4711"
}

Example response:
true

Erforderliche Parameter

Parameter Beschreibung
sessionid ID einer aktiven Sitzung
projectno ID des Projekts, das geladen werden soll

Antwortdetails

Die Antwort lautet true für ein einfolgreiches Laden und false für einen Fehlschlag.


Projekt neu berechnen

Method Details

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

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

Example POST body:
{
"sessionid": "c009f9dc"
}

Example response:
true

Erforderliche Parameter

Parameter Beschreibung
sessionid ID einer aktiven Sitzung

Antwortdetails

Die Antwort lautet true für ein einfolgreiches Berechnen und false für einen Fehlschlag.


Projekt speichern

Method Details

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

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

Example POST body:
{
"sessionid": "c009f9dc"
}

Example response:
true

Erforderliche Parameter

Parameter Beschreibung
sessionid ID einer aktiven Sitzung

Antwortdetails

Die Antwort lautet true für ein einfolgreiches Speichern und false für einen Fehlschlag.


Projekt löschen

Method Details

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

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

Example POST body:
{
"sessionid": "c009f9dc"
"projectno": "4711"
}

Example response:
true

Erforderliche Parameter

Parameter Beschreibung
sessionid ID einer aktiven Sitzung
projectno ID des Projekts, das gelöscht werden soll

Antwortdetails

Die Antwort lautet true für ein einfolgreiches Löschen und false für einen Fehlschlag.