Zum Hauptinhalt springen

Mindmaps

Mindmaps in InLoox ermöglichen die visuelle Strukturierung von Ideen und Aufgaben innerhalb eines Projekts. Jede Mindmap besteht aus hierarchisch angeordneten Knoten, die in Aufgaben oder Zeitplanelemente konvertiert werden können.

info

Mindmaps sind stets einem Projekt zugeordnet. Verwenden Sie ProjectId beim Filtern, um nur Mindmaps eines bestimmten Projekts abzurufen.


MindMap

Die MindMap-Entität repräsentiert eine einzelne Mindmap innerhalb eines Projekts.

Datenmodell

EigenschaftTypBeschreibung
MindMapIdguidEindeutige ID der Mindmap.
NamestringName der Mindmap.
ProjectIdguidID des zugehörigen Projekts.
OrdinalPositionintSortierposition der Mindmap im Projekt.

Endpunkte

CRUD-Operationen

Alle Mindmaps aller Projekte abrufen

GET/odata/MindMap

Unterstützt OData-Abfrageoptionen.


Eine einzelne Mindmap nach ID abrufen

GET/odata/MindMap({key})
ParameterTypErforderlichBeschreibung
keyguidDie MindMapId.

Eine neue Mindmap erstellen

POST/odata/MindMap

Eine bestehende Mindmap aktualisieren

PATCH/odata/MindMap({key})
ParameterTypErforderlichBeschreibung
keyguidDie MindMapId.
BodyDelta<ApiMindMap>JSON-Objekt mit den zu aktualisierenden Feldern.

Eine Mindmap löschen

DELETE/odata/MindMap({key})
ParameterTypErforderlichBeschreibung
keyguidDie MindMapId.
warnung

Das Löschen einer Mindmap entfernt auch alle zugehörigen Knoten. Diese Aktion kann nicht rückgängig gemacht werden.

Gibt 204 No Content bei Erfolg zurück.


Knoten in Aufgaben/Zeitplan überführen

Alle noch nicht kopierten Knoten als Aufgaben erstellen

POST/odata/MindMap({key})/CopyAllUncopiedNodesToTaskItems
ParameterTypErforderlichBeschreibung
keyguidDie MindMapId.

Erstellt für jeden Knoten, der noch nicht als Aufgabe kopiert wurde, eine neue Projektaufgabe.


Nur Blattknoten als Aufgaben erstellen

POST/odata/MindMap({key})/CopyUncopiedLeafNodesToTaskItems
ParameterTypErforderlichBeschreibung
keyguidDie MindMapId.

Erstellt nur für Blattknoten (Knoten ohne Unterknoten), die noch nicht kopiert wurden, neue Projektaufgaben.


Knoten als Vorgänge und Sammelvorgänge in die Planung kopieren

POST/odata/MindMap({key})/CopyToTimeline
ParameterTypErforderlichBeschreibung
keyguidDie MindMapId.

Überführt die Mindmap-Struktur in Planungselemente des Projektzeitplans.


MindMapNode

Die MindMapNode-Entität repräsentiert einen einzelnen Knoten innerhalb einer Mindmap. Knoten können hierarchisch verschachtelt werden und verfügen über umfangreiche Formatierungsoptionen.

Datenmodell

EigenschaftTypBeschreibung
MindMapNodeIdguidEindeutige ID des Knotens.
ParentNodeIdguid?ID des übergeordneten Knotens (null für Stammknoten).
MindMapIdguid?ID der zugehörigen Mindmap.
DescriptionstringTextbeschreibung des Knotens (Klartext).
DescriptionHTMLstringBeschreibung als HTML.
OrdinalPositionintSortierposition unter den Geschwisterknoten.
LocationXintHorizontale Position (X-Koordinate).
LocationYintVertikale Position (Y-Koordinate).
FontTypestringSchriftart.
FontSizedecimal?Schriftgröße.
IsBoldboolFettschrift aktiviert.
IsItalicboolKursivschrift aktiviert.
IsUnderlineboolUnterstreichung aktiviert.
FontColorstringHTML-Farbwert für die Schriftfarbe (z.B. #FF0000).
NodeColorstringHTML-Farbwert für die Hintergrundfarbe des Knotens (z.B. #FFFFFF).
FrameColorstringHTML-Farbwert für die Rahmenfarbe des Knotens (z.B. #000000).
IsCollapsedboolOb der Knoten eingeklappt dargestellt wird.
ProgressintFortschritt in Prozent (0–100).
ColorFlagint?Farbmarkierung des Knotens. Werte: null = nicht gesetzt, 0 = grau (Standard), 1 = grün, 2 = gelb (#f0b000), 3 = rot.

Endpunkte

CRUD-Operationen

Alle Mindmap-Knoten abrufen

GET/odata/MindMapNode

Unterstützt OData-Abfrageoptionen.


Einen einzelnen Knoten nach ID abrufen

GET/odata/MindMapNode({key})
ParameterTypErforderlichBeschreibung
keyguidDie MindMapNodeId.

Einen neuen Knoten erstellen

POST/odata/MindMapNode
tipp

Setzen Sie ParentNodeId, um einen Unterknoten zu erstellen. Ohne ParentNodeId wird ein Stammknoten erzeugt.


Einen Knoten aktualisieren

PATCH/odata/MindMapNode({key})
ParameterTypErforderlichBeschreibung
keyguidDie MindMapNodeId.
BodyDelta<ApiMindMapNode>JSON-Objekt mit den zu aktualisierenden Feldern.

Einen Knoten löschen

DELETE/odata/MindMapNode({key})
ParameterTypErforderlichBeschreibung
keyguidDie MindMapNodeId.
warnung

Das Löschen eines Knotens entfernt auch alle Unterknoten. Diese Aktion kann nicht rückgängig gemacht werden.

Gibt 204 No Content bei Erfolg zurück.


Dokumente

Ein Dokument an einen Knoten anhängen

POST/odata/MindMapNode({key})/AddDocumentToMindMapNode
ParameterTypErforderlichBeschreibung
keyguidDie MindMapNodeId.
BodyobjectJSON-Objekt mit folgenden Feldern:

documentIds (guid[], erforderlich) — Array von Dokument-IDs, die mit dem Mindmap-Knoten verknüpft werden sollen.

Ein Dokument von einem Knoten entfernen

POST/odata/MindMapNode({key})/RemoveDocumentFromMindMapNode
ParameterTypErforderlichBeschreibung
keyguidDie MindMapNodeId.
BodyobjectJSON-Objekt mit folgenden Feldern:

documentId (guid, erforderlich) — Die ID des Dokuments, das vom Mindmap-Knoten entfernt werden soll.

Verknüpfungen

Eine Verknüpfung zu einem Knoten hinzufügen

POST/odata/MindMapNode({key})/AddRelation
ParameterTypErforderlichBeschreibung
keyguidDie MindMapNodeId.
BodyobjectJSON-Objekt mit folgenden Feldern:

itemId (guid, erforderlich) — Die ID des zu verknüpfenden Elements.

Eine Verknüpfung von einem Knoten entfernen

POST/odata/MindMapNode({key})/RemoveRelation
ParameterTypErforderlichBeschreibung
keyguidDie MindMapNodeId.
BodyobjectJSON-Objekt mit folgenden Feldern:

itemId (guid, erforderlich) — Die ID des zu entfernenden verknüpften Elements.

MindMapTemplate

Die MindMapTemplate-Entität ermöglicht das Speichern und Laden von Mindmap-Vorlagen. Vorlagen können aus bestehenden Mindmaps erstellt und in andere Projekte geladen werden.

Datenmodell

EigenschaftTypBeschreibung
MindMapTemplateIdguidEindeutige ID der Vorlage.
NamestringName der Vorlage.

Endpunkte

CRUD-Operationen

Alle Mindmap-Vorlagen abrufen

GET/odata/MindMapTemplate

Unterstützt OData-Abfrageoptionen.


Eine Vorlage nach ID abrufen

GET/odata/MindMapTemplate({key})
ParameterTypErforderlichBeschreibung
keyguidDie MindMapTemplateId.

Eine neue Vorlage erstellen

POST/odata/MindMapTemplate

Eine Vorlage aktualisieren

PATCH/odata/MindMapTemplate({key})
ParameterTypErforderlichBeschreibung
keyguidDie MindMapTemplateId.
BodyDelta<ApiMindMapTemplate>JSON-Objekt mit den zu aktualisierenden Feldern.

Eine Vorlage löschen

DELETE/odata/MindMapTemplate({key})
ParameterTypErforderlichBeschreibung
keyguidDie MindMapTemplateId.
warnung

Das Löschen einer Vorlage kann nicht rückgängig gemacht werden.

Gibt 204 No Content bei Erfolg zurück.


Vorlagenverwaltung

Eine Vorlage aus einer bestehenden Mindmap speichern

POST/odata/MindMapTemplate/SaveTemplateForMindMap
ParameterTypErforderlichBeschreibung
BodyobjectJSON-Objekt mit folgenden Feldern:

mindMapId (guid, erforderlich) — Die ID der Mindmap, die als Vorlage gespeichert werden soll.
name (string, erforderlich) — Name für die neue Vorlage.

Eine Vorlage in ein Projekt laden

POST/odata/MindMapTemplate({key})/LoadTemplateForProject
ParameterTypErforderlichBeschreibung
keyguidDie MindMapTemplateId.
BodyobjectJSON-Objekt mit folgenden Feldern:

projectId (guid, erforderlich) — Die ID des Projekts, in das die Vorlage geladen werden soll.

Erstellt eine neue Mindmap im angegebenen Projekt basierend auf der Vorlage.


Eine Vorlage herunterladen

GET/odata/MindMapTemplate({key})/DownloadTemplate()
ParameterTypErforderlichBeschreibung
keyguidDie MindMapTemplateId.

Gibt einen Dateidownload mit dem Inhaltstyp application/xml und der Dateiendung .json zurück.


OData-Abfragebeispiele

Mindmaps eines Projekts abrufen

GET /odata/MindMap?$filter=ProjectId eq {projectId}&$orderby=OrdinalPosition

Eine Mindmap erstellen

POST /odata/MindMap
Content-Type: application/json

{
"ProjectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"Name": "Projektstrukturplanung",
"OrdinalPosition": 0
}

Eine Mindmap umbenennen

PATCH /odata/MindMap({key})
Content-Type: application/json

{
"Name": "Projektstrukturplanung – Überarbeitet"
}

Knoten einer Mindmap abrufen

GET /odata/MindMapNode?$filter=MindMapId eq {mindMapId}&$orderby=OrdinalPosition

Einen Knoten erstellen

POST /odata/MindMapNode
Content-Type: application/json

{
"MindMapId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"Description": "Neuer Ideenknoten",
"OrdinalPosition": 0,
"FontSize": 12.0,
"IsBold": false,
"IsCollapsed": false,
"Progress": 0
}

Einen Knoten aktualisieren

PATCH /odata/MindMapNode({key})
Content-Type: application/json

{
"Description": "Aktualisierter Knotentext",
"Progress": 50,
"NodeColor": "#FFD700"
}

Dokument an einen Knoten anhängen

POST /odata/MindMapNode({key})/AddDocumentToMindMapNode
Content-Type: application/json

{
"documentIds": ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]
}

Dokument von einem Knoten entfernen

POST /odata/MindMapNode({key})/RemoveDocumentFromMindMapNode
Content-Type: application/json

{
"documentId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Verknüpfung zu einem Knoten hinzufügen

POST /odata/MindMapNode({key})/AddRelation
Content-Type: application/json

{
"itemId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Verknüpfung von einem Knoten entfernen

POST /odata/MindMapNode({key})/RemoveRelation
Content-Type: application/json

{
"itemId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Vorlagen auflisten

GET /odata/MindMapTemplate?$orderby=Name

Eine Vorlage erstellen

POST /odata/MindMapTemplate
Content-Type: application/json

{
"Name": "Standard-Projektstruktur"
}

Eine Vorlage umbenennen

PATCH /odata/MindMapTemplate({key})
Content-Type: application/json

{
"Name": "Projektstruktur v2"
}

Mindmap als Vorlage speichern

POST /odata/MindMapTemplate/SaveTemplateForMindMap
Content-Type: application/json

{
"mindMapId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Vorlage aus Projektstruktur"
}

Vorlage in ein Projekt laden

POST /odata/MindMapTemplate({key})/LoadTemplateForProject
Content-Type: application/json

{
"projectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
tipp

Kombinieren Sie $filter mit $orderby, um Mindmaps und Knoten in der korrekten Anzeigereihenfolge abzurufen. Das Filtern nach ProjectId oder MindMapId ist das häufigste Muster.