Vertec Python Modul "vtcrest"
Das Vertec Python Modul "vtcrest" für den REST API Webservice
Betriebsart
Cloud Abo
On-Premises
Module
Alle
Die Definitionen der als Webservice ausgelieferten Vertec REST API Schnittstelle befinden sich im Modul "vtcrest".
Dieses enthält folgende Klassen und Methoden:
Klasse MemberInformation
| Members | Beschreibung |
|---|---|
member_name |
Name des Members (String) |
class_name |
Klassenname (String) |
member_type |
Typ des Members (String), z.B. 'core attribute', 'core association', 'custom attribute', 'custom association' |
data_type |
Datentyp (String), z.B. 'object', 'date', 'datetime' |
default_value |
Passender Standardwert für den Datentyp, z.B. "", False, 0, None |
persistent |
Gibt an, ob es sich um ein persistentes Member handelt (Boolean). |
single_link |
Gibt an, ob es sich beim Member um die 1-Seite einer Association handelt (Boolean). |
sql_columnname |
Name des Members in der Datenbank (String. Ab Vertec 6.8 immer in Englisch) |
custom_member_definition |
Kann die Definition eines Zusatzfelds oder eines Link-Typs enthalten. |
All diese Werte können gesetzt und im weiteren Code abgefragt werden.
Die Funktion set_data_type(data_type) setzt den Datentyp des Members und damit auch den Standardwert.
Klasse VertecREST
Definiert die Funktionalitäten für den REST API Webservice.
| Methoden | Beschreibung |
|---|---|
onrequest |
Wird am Anfang jedes Methodenaufrufs aufgerufen. Kann verwendet werden, um ein Logging zu implementieren. |
currentuser_get |
Liefert den aktuell eingeloggten User zurück. |
objects_get |
Hier wird die Suche nach den Vertec Objekten implementiert, welche im Request-Pfad abgefragt werden. |
objects_put |
Hier werde die Änderungen von Vertec Objekten implementiert aufgrund der spezifizierten Werte im Request-Body. |
objects_post |
Erzeugt ein Vertec Objekt des Typs, der im Request-Pfad spezifiziert ist, mit den Werten, die im Request-Body spezifiziert sind. |
objects_delete |
Löscht das im Request-Pfad abgefragte Objekt. |
Eine (Beispiel-)Implementation wird mit dem Vertec REST API Webservice mitgeliefert.
Das Vertec Python Modul "vtcrest" ist auch als Stub File verfügbar.