Joinpoints Structure API V1

Joinpoints Developer

Mit der Structure API kannst du die Konfiguration des Joinpoints Accounts abrufen. Mit dem Befehl "listDirectories" kannst du alle Pipelines & Listen abrufen. Mit dem Befehl "getJoinpointTemplateMeta" bekommst du die Details des Templates hinter einer Pipeline/Liste.

Datentypen der Template-Felder

Die aufgelisteten Datentypen entsprechen werden beim Befehl "getJoinpointTemplateMeta" für einzelne Felder im Template zurück geliefert. Sie beschreiben den Typen den sich die Joinpoints Plattform bei Befehle in der Joinpoints API wie "create" und "update" erwarten.

Zeichenketten:

default - Normaler Zeichenkette als String
phone_number - Normale Zeichenkette als String
link - Normale Zeichenkette als String
multi_text - Mehrzeilige Zeichenkette als String
boolean - Zeichenkette mit den Werten true, false
gender - Zeichenkette mit den Werten male, female

date - Zeichenkette mit Formatierung yyyy-mm-dd hh:🇲🇲:ss.sss
email - Normale Zeichenkette als String

Numerische Typen:

number - Dezimalzahl (float)
consecutive_number - Dezimalzahl (float), Fortlaufende Nummer
percent - Dezimalzahl (float), Formatierung als Prozent in Joinpoints
amount - Dezimalzahl (float), Formatierung als Währungsbetrag in Joinpoints
duration_hours - Dezimalzahl (float), Formatierung als Stundenanzahl (Dauer)


Relation Typen:

Die Relations-Typen sind Verbindungsfelder zu anderen Joinpoints. 

status - ID als Integer, Auswahlmöglichkeit wird mit "getJoinpointTemplateMeta" mitgeliefert.
single_jp - ID als Integer des verbundenen Joinpoints.

multi_jp - Verbindung zu mehreren Joinpoints. 
Achtung: In der Joinpoints API wird für diesen Typen der Befehl "updateJoinpointRelation" verwendet, um neue Relationen hinzuzufügen oder bestehende zu entfernen.

dropdown_jp - ID als Integer des verbundenen Joinpoints. Gleich wie single_jp nur mit einer anderen Darstellung in Joinpoints.

user_jp - ID als Integer, Nutzerrolle, ID eines Nutzers. 

Ein Nutzer ist auch ein Joinpoint und kann über die E-Mail Adresse und den simpleType "user" gefunden werden.

customer - ID als Integer, ID des verbundenen Kontaktes. Kann ein Unternehmen ("company") oder ein Personenkontakt ("contact") sein.
phase - ID der aktuellen Prozess-Phase. 

Achtung: Dieser Typ kann nicht über "update" oder "create" verwendet werden!



API Befehle