Skip to main content

Mind Maps

The MindMap entity set provides endpoints for managing mind maps, their hierarchical nodes, and reusable templates. Mind maps enable visual brainstorming and idea structuring within a project context.


MindMap

A mind map represents a visual brainstorming diagram associated with a project. Each mind map contains a tree of nodes and supports conversion of ideas into actionable task items.

Properties

PropertyTypeDescription
MindMapIdGuidPrimary key. Unique identifier for the mind map.
NamestringDisplay name of the mind map.
ProjectIdGuidForeign key to the associated project.
OrdinalPositionintSort order position within the project.

Endpoints

List Mind Maps

GET/odata/MindMap

Returns all mind maps. Supports OData query options.

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

Create Mind Map

POST/odata/MindMap

Creates a new mind map.

{
"Name": "Feature Brainstorm",
"ProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"OrdinalPosition": 0
}

Get Mind Map

GET/odata/MindMap({key})

Returns a single mind map by its ID.

ParameterTypeRequiredDescription
keyGuidThe MindMapId.

Update Mind Map

PATCH/odata/MindMap({key})

Partially updates an existing mind map.

ParameterTypeRequiredDescription
keyGuidThe MindMapId.

Delete Mind Map

DELETE/odata/MindMap({key})

Deletes a mind map and all its nodes.

ParameterTypeRequiredDescription
keyGuidThe MindMapId.

Count Mind Maps

GET/odata/MindMap/$count

Returns the total number of mind maps.

Actions

Copy All Uncopied Nodes to Task Items

POST/odata/MindMap({key})/CopyAllUncopiedNodesToTaskItems

Converts all uncopied mind map nodes into task items.

ParameterTypeRequiredDescription
keyGuidThe MindMapId.

Copy Uncopied Leaf Nodes to Task Items

POST/odata/MindMap({key})/CopyUncopiedLeafNodesToTaskItems

Converts only uncopied leaf nodes (nodes without children) into task items.

ParameterTypeRequiredDescription
keyGuidThe MindMapId.
tip

Use CopyAllUncopiedNodesToTaskItems and CopyUncopiedLeafNodesToTaskItems to convert brainstorming nodes into actionable task items. The leaf-node variant is useful when parent nodes serve as categories rather than discrete tasks.

Copy to Timeline

POST/odata/MindMap({key})/CopyToTimeline

Copies the mind map structure to the project timeline.

ParameterTypeRequiredDescription
keyGuidThe MindMapId.

MindMapNode

A mind map node represents a single idea or topic within a mind map. Nodes form a hierarchical tree via ParentNodeId and support rich formatting, positioning, and document attachments.

Properties

PropertyTypeDescription
MindMapNodeIdGuidPrimary key. Unique identifier for the node.
ParentNodeIdGuid?Foreign key to the parent node. Null for root nodes.
MindMapIdGuidForeign key to the parent mind map.
DescriptionstringPlain text description of the node.
DescriptionHTMLstringHTML-formatted description of the node.
OrdinalPositionintSort order position among sibling nodes.
LocationXdoubleX coordinate for node positioning on the canvas.
LocationYdoubleY coordinate for node positioning on the canvas.
FontTypestringFont family for the node label.
FontSizeintFont size in points.
IsBoldboolWhether the node label is bold.
IsItalicboolWhether the node label is italic.
IsUnderlineboolWhether the node label is underlined.
FontColorstringHex color code for the node label text.
NodeColorstringHex color code for the node background.
FrameColorstringHex color code for the node border.
IsCollapsedboolWhether child nodes are hidden in the UI.
ProgressdoubleCompletion progress (0.0 – 1.0).
ColorFlagstringColor flag for categorization.

Endpoints

List Mind Map Nodes

GET/odata/MindMapNode

Returns all mind map nodes. Supports OData query options.

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

Create Mind Map Node

POST/odata/MindMapNode

Creates a new mind map node.

{
"MindMapId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ParentNodeId": null,
"Description": "Central Idea",
"OrdinalPosition": 0,
"LocationX": 400.0,
"LocationY": 300.0,
"NodeColor": "#4A90D9",
"FontSize": 14,
"IsBold": true
}

Get Mind Map Node

GET/odata/MindMapNode({key})

Returns a single mind map node by its ID.

ParameterTypeRequiredDescription
keyGuidThe MindMapNodeId.

Update Mind Map Node

PATCH/odata/MindMapNode({key})

Partially updates an existing mind map node.

ParameterTypeRequiredDescription
keyGuidThe MindMapNodeId.

Delete Mind Map Node

DELETE/odata/MindMapNode({key})

Deletes a mind map node.

ParameterTypeRequiredDescription
keyGuidThe MindMapNodeId.

Count Mind Map Nodes

GET/odata/MindMapNode/$count

Returns the total number of mind map nodes.

Actions

Add Document to Mind Map Node

POST/odata/MindMapNode({key})/AddDocumentToMindMapNode

Attaches a document to the mind map node.

ParameterTypeRequiredDescription
keyGuidThe MindMapNodeId.

Remove Document from Mind Map Node

POST/odata/MindMapNode({key})/RemoveDocumentFromMindMapNode

Removes a document attachment from the mind map node.

ParameterTypeRequiredDescription
keyGuidThe MindMapNodeId.

Add Relation

POST/odata/MindMapNode({key})/AddRelation

Creates a relation between the mind map node and another entity.

ParameterTypeRequiredDescription
keyGuidThe MindMapNodeId.

Remove Relation

POST/odata/MindMapNode({key})/RemoveRelation

Removes a relation from the mind map node.

ParameterTypeRequiredDescription
keyGuidThe MindMapNodeId.

MindMapTemplate

Mind map templates store reusable mind map structures. Templates can be saved from existing mind maps, loaded into projects, and downloaded as files.

Properties

PropertyTypeDescription
MindMapTemplateIdguidUnique identifier of the template.
NamestringName of the template.

Endpoints

GET/odata/MindMapTemplate

Returns all mind map templates.

POST/odata/MindMapTemplate

Creates a new mind map template.

GET/odata/MindMapTemplate({key})

Returns a single mind map template by its ID.

ParameterTypeRequiredDescription
keyGuidThe MindMapTemplate ID.
PATCH/odata/MindMapTemplate({key})

Updates an existing mind map template.

ParameterTypeRequiredDescription
keyGuidThe MindMapTemplate ID.
DELETE/odata/MindMapTemplate({key})

Deletes a mind map template.

ParameterTypeRequiredDescription
keyGuidThe MindMapTemplate ID.
GET/odata/MindMapTemplate/$count

Returns the total number of mind map templates.

Actions

Save Template for Mind Map

POST/odata/MindMapTemplate/SaveTemplateForMindMap

Saves an existing mind map as a reusable template.

Load Template for Project

POST/odata/MindMapTemplate({key})/LoadTemplateForProject

Applies a mind map template to a project, creating the defined structure.

Existing Data

Loading a template into a project may create additional mind map elements. Verify the target project before applying.

Download Template

GET/odata/MindMapTemplate({key})/DownloadTemplate()

Downloads a mind map template as a file.

ParameterTypeRequiredDescription
keyGuidThe MindMapTemplate ID.

Download Mind Map Template

GET/odata/MindMapTemplate({key})/DownloadMindMapTemplate()

Downloads an existing mind map as a template file.

ParameterTypeRequiredDescription
keyGuidThe MindMap ID to export as a template.
tip

Use DownloadMindMapTemplate to export a project's mind map directly without first saving it as a named template.