Konfiguration & Berechtigungen

Diese Seite beschreibt die API-Endpunkte für Systemkonfiguration, Benutzer- und Rollenberechtigungen, gespeicherte Ansichten, Benachrichtigungseinstellungen sowie Domänenverwaltung.

warnung

Konfigurationsänderungen wirken sich auf alle Benutzer in der Organisation aus. Seien Sie vorsichtig, wenn Sie diese Einstellungen über die API ändern.

---

Configuration

Die Configuration-Entität speichert Schlüssel-Wert-Paare für die Systemkonfiguration. Über spezialisierte Funktionen können Sie zusammengefasste Einstellungsgruppen abrufen.

Eigenschaften

Property	Type	Description
ConfigurationId	Edm.Guid	Eindeutige ID des Konfigurationseintrags.
Key	Edm.String	Konfigurationsschlüssel.
Value	Edm.String	Konfigurationswert.

Endpunkte

CRUD-Operationen

GET/odata/Configuration

Alle Konfigurationseinträge abrufen

Unterstützt OData-Abfrageoptionen. Filtern Sie nach Schlüssel:

GET /odata/Configuration?$filter=Key eq 'DefaultCurrency'

---

GET/odata/Configuration({key})

Einen Konfigurationseintrag nach ID abrufen

Parameter	Type	Required	Description
key	Edm.Guid	✅	Die ConfigurationId.

---

POST/odata/Configuration

Einen neuen Konfigurationseintrag erstellen

{
  "Key": "CustomSetting",
  "Value": "Aktiviert"
}

---

PATCH/odata/Configuration({key})

Einen Konfigurationseintrag aktualisieren

Parameter	Type	Required	Description
key	Edm.Guid	✅	Die ConfigurationId.

{
  "Value": "Neuer Wert"
}

---

DELETE/odata/Configuration({key})

Einen Konfigurationseintrag löschen

Parameter	Type	Required	Description
key	Edm.Guid	✅	Die ConfigurationId.

Gibt 204 No Content bei Erfolg zurück.

---

GET/odata/Configuration/$count

Anzahl der Konfigurationseinträge abrufen

Gibt eine Ganzzahl zurück.

---

Einstellungsfunktionen

GET/odata/Configuration/GetOrganizationSettings()

Organisationseinstellungen abrufen

Gibt die zusammengefassten Organisationseinstellungen zurück.

---

GET/odata/Configuration/GetNotificationSettings()

Benachrichtigungseinstellungen abrufen

Gibt die globalen Benachrichtigungseinstellungen zurück.

---

GET/odata/Configuration/GetDocumentSettings()

Dokumenteneinstellungen abrufen

Gibt Einstellungen für die Dokumentenverwaltung zurück (z. B. Standardspeicherort).

---

GET/odata/Configuration/GetClientNumberSettings()

Kundennummern-Einstellungen abrufen

Gibt die Konfiguration für die automatische Kundennummerngenerierung zurück.

---

GET/odata/Configuration/GetProjectNumberSettings()

Projektnummern-Einstellungen abrufen

Gibt die Konfiguration für die automatische Projektnummerngenerierung zurück.

---

POST/odata/Configuration/UpdateConfigByKey

Einen Konfigurationseintrag anhand des Schlüssels aktualisieren

Aktualisiert einen Konfigurationswert direkt über den Schlüsselnamen (ohne ConfigurationId).

{
  "Key": "DefaultCurrency",
  "Value": "EUR"
}

---

POST/odata/Configuration/SetDocumentDefaultStore

Standarddokumentspeicher festlegen

Legt den Standardspeicherort für neue Dokumente fest.

---

POST/odata/Configuration/SetNotifyContactsWithoutLogin

Benachrichtigung für Kontakte ohne Anmeldung konfigurieren

Konfiguriert, ob Kontakte ohne Benutzerkonto Benachrichtigungen erhalten sollen.

---

UserPermission

Die UserPermission-Entität definiert die Berechtigungen einzelner Benutzer. Jeder Eintrag enthält eine umfangreiche Liste von Berechtigungsflags für verschiedene Bereiche.

Eigenschaften

Property	Type	Description
Id	Edm.Guid	Eindeutige ID.
UserPermissionId	Edm.Guid	Berechtigungs-ID.
ContactIds	Collection(Edm.Guid)	Liste der zugeordneten Kontakt-IDs.
DivisionIds	Collection(Edm.Guid)	Liste der zugeordneten Abteilungs-IDs.
ProjectRead	Edm.Boolean	Projekte lesen.
ProjectModify	Edm.Boolean	Projekte bearbeiten.
ProjectDelete	Edm.Boolean	Projekte löschen.
ProjectLock	Edm.Boolean	Projekte sperren.
ProjectMemberModify	Edm.Boolean	Projektmitglieder verwalten.
ProjectCreate	Edm.Boolean	Projekte erstellen.
TaskItemAccess	Edm.Boolean	Aufgaben anzeigen.
TaskItemModify	Edm.Boolean	Aufgaben bearbeiten.
TaskItemDelete	Edm.Boolean	Aufgaben löschen.
TimeEntryAccess	Edm.Boolean	Zeiterfassung anzeigen.
TimeEntryModify	Edm.Boolean	Zeiterfassung bearbeiten.
DocumentAccess	Edm.Boolean	Dokumente anzeigen.
DocumentModify	Edm.Boolean	Dokumente bearbeiten.
BudgetAccess	Edm.Boolean	Budget anzeigen.
BudgetModify	Edm.Boolean	Budget bearbeiten.
PlanningAccess	Edm.Boolean	Planung anzeigen.
PlanningModify	Edm.Boolean	Planung bearbeiten.
MindMapAccess	Edm.Boolean	Mindmaps anzeigen.
MindMapModify	Edm.Boolean	Mindmaps bearbeiten.
CheckListAccess	Edm.Boolean	Checklisten anzeigen.
CheckListModify	Edm.Boolean	Checklisten bearbeiten.
PermissionsAdministrate	Edm.Boolean	Berechtigungen verwalten.
ManageAccess	Edm.Boolean	Verwaltungszugriff.
ManageModify	Edm.Boolean	Verwaltungsrechte.
ReadOnlyLicense	Edm.Boolean	Nur-Lesen-Lizenz.
PrivateTasksCreate	Edm.Boolean	Private Aufgaben erstellen.
PATAccess	Edm.Boolean	Personal Access Token verwenden.
PortfoliosModify	Edm.Boolean	Portfolios bearbeiten.
RiskAccess	Edm.Boolean	Risiken anzeigen.
RiskModify	Edm.Boolean	Risiken bearbeiten.
DashboardsAccess	Edm.Boolean	Dashboards anzeigen.
DashboardsModify	Edm.Boolean	Dashboards bearbeiten.
ContactsModify	Edm.Boolean	Kontakte bearbeiten.

info

Die obige Tabelle zeigt eine Auswahl der wichtigsten Berechtigungsflags. Die vollständige Liste enthält weitere feingliedrige Berechtigungen wie OwnTaskItemAccess, TaskItemStateModify, TaskItemCommentAdd, ReportRead, ReportModify, FreeTimeEntryModify und andere.

Endpunkte

GET/odata/UserPermission

Alle Benutzerberechtigungen abrufen

Unterstützt OData-Abfrageoptionen.

GET /odata/UserPermission?$select=Id,ContactIds,ProjectRead,ProjectModify,TaskItemAccess

---

POST/odata/UserPermission

Neue Benutzerberechtigungen erstellen

{
  "ContactIds": ["3fa85f64-5717-4562-b3fc-2c963f66afa6"],
  "ProjectRead": true,
  "ProjectModify": true,
  "ProjectCreate": true,
  "TaskItemAccess": true,
  "TaskItemModify": true,
  "TimeEntryAccess": true,
  "TimeEntryModify": true,
  "ReadOnlyLicense": false
}

---

GET/odata/UserPermission/$count

Anzahl der Berechtigungseinträge abrufen

Gibt eine Ganzzahl zurück.

---

GET/odata/UserPermission/MyGlobalUserPermissionSet()

Eigene globale Berechtigungen abrufen

Gibt das vollständige Berechtigungsset des aktuell authentifizierten Benutzers zurück.

tipp

Verwenden Sie diesen Endpunkt, um zur Laufzeit zu prüfen, welche Aktionen dem aktuellen Benutzer zur Verfügung stehen.

---

RolePermission

Die RolePermission-Entität konfiguriert Berechtigungen auf Rollenebene. Rollen können aktiviert/deaktiviert und umbenannt werden.

Eigenschaften

Property	Type	Description
RoleType	Edm.Int32	Rollentyp-Identifikator.
RoleEnabled	Edm.Boolean	Ob die Rolle aktiviert ist.
CustomName	Edm.String	Benutzerdefinierter Rollenname.

Endpunkte

GET/odata/RolePermission

Alle Rollenberechtigungen abrufen

Gibt alle konfigurierten Rollendefinitionen zurück.

GET /odata/RolePermission

---

PATCH/odata/RolePermission({key})

Eine Rollenberechtigung aktualisieren

Parameter	Type	Required	Description
key	Edm.Int32	✅	Der RoleType der zu aktualisierenden Rolle.

{
  "RoleEnabled": true,
  "CustomName": "Projektleiter"
}

---

GET/odata/RolePermission/$count

Anzahl der Rollenberechtigungen abrufen

Gibt eine Ganzzahl zurück.

---

View

Die View-Entität verwaltet gespeicherte Ansichten und Dashboards. Ansichten speichern Filter-, Sortier- und Spalteneinstellungen, die von Benutzern wiederverwendet werden können.

Eigenschaften

Property	Type	Description
ViewId	Edm.Guid	Eindeutige ID der Ansicht.
ContactId	Edm.Guid	ID des Besitzers der Ansicht.
Name	Edm.String	Name der Ansicht.
IsGlobal	Edm.Boolean	Ob die Ansicht für alle Benutzer sichtbar ist.
Type	Edm.Int32	Ansichtstyp (z. B. Projektliste, Aufgabenliste).
DataSourceType	Edm.Int32	Datenquellentyp der Ansicht.
ProjectId	Edm.Guid?	Optionale Projekt-ID (für projektspezifische Ansichten).

Endpunkte

CRUD-Operationen

GET/odata/View

Alle Ansichten abrufen

Unterstützt OData-Abfrageoptionen.

GET /odata/View?$filter=IsGlobal eq true&$orderby=Name

---

GET/odata/View({key})

Eine Ansicht nach ID abrufen

Parameter	Type	Required	Description
key	Edm.Guid	✅	Die ViewId.

---

POST/odata/View

Eine neue Ansicht erstellen

{
  "Name": "Meine Projektübersicht",
  "IsGlobal": false,
  "Type": 0,
  "DataSourceType": 0
}

---

PATCH/odata/View({key})

Eine Ansicht aktualisieren

Parameter	Type	Required	Description
key	Edm.Guid	✅	Die ViewId.

{
  "Name": "Aktive Projekte – Q1 2025"
}

---

DELETE/odata/View({key})

Eine Ansicht löschen

Parameter	Type	Required	Description
key	Edm.Guid	✅	Die ViewId.

Gibt 204 No Content bei Erfolg zurück.

---

GET/odata/View/$count

Anzahl der Ansichten abrufen

Gibt eine Ganzzahl zurück.

---

Ansichtsfunktionen

GET/odata/View({key})/SelectView()

Eine Ansicht als aktiv markieren

Parameter	Type	Required	Description
key	Edm.Guid	✅	Die ViewId.

Setzt die angegebene Ansicht als aktive Ansicht für den aktuellen Benutzer.

---

GET/odata/View/RestoreDefaultViews(viewType={viewType})

Standardansichten wiederherstellen

Parameter	Type	Required	Description
viewType	Edm.Int32	✅	Der Ansichtstyp, für den Standardansichten wiederhergestellt werden sollen.

---

GET/odata/View/GetSelectedView(viewType={viewType})

Aktuell ausgewählte Ansicht abrufen

Parameter	Type	Required	Description
viewType	Edm.Int32	✅	Der Ansichtstyp.

---

GET/odata/View/GetSelectedViewByDatasourceType(viewType={viewType},viewDatasourceType={viewDatasourceType})

Ausgewählte Ansicht nach Datenquellentyp abrufen

Parameter	Type	Required	Description
viewType	Edm.Int32	✅	Der Ansichtstyp.
viewDatasourceType	Edm.Int32	✅	Der Datenquellentyp.

---

POST/odata/View({key})/SaveViewData

Ansichtsdaten speichern

Parameter	Type	Required	Description
key	Edm.Guid	✅	Die ViewId.

Speichert die aktuellen Filter-, Sortier- und Spalteneinstellungen für die Ansicht.

---

GET/odata/View({key})/DownloadView()

Ansichtsdaten herunterladen

Parameter	Type	Required	Description
key	Edm.Guid	✅	Die ViewId.

---

POST/odata/View/DeleteProjectDashboard

Ein Projekt-Dashboard löschen

Löscht ein projektspezifisches Dashboard.

---

POST/odata/View/DeleteOrganizationDefaultDashboard

Das Standard-Organisations-Dashboard löschen

Löscht das organisationsweite Standard-Dashboard.

warnung

Diese Aktion entfernt das Standard-Dashboard für alle Benutzer der Organisation.

---

NotificationFilterSetting

Die NotificationFilterSetting-Entität steuert die Benachrichtigungsfilter für einzelne Benutzer. Damit können Sie festlegen, welche Benachrichtigungen über welchen Kanal zugestellt werden.

Eigenschaften

Property	Type	Description
NotificationFilterSettingId	Edm.Guid	Eindeutige ID der Filtereinstellung.
EntityPath	Edm.String	Entitätspfad, für den der Filter gilt (z. B. Project, TaskItem).
Enabled	Edm.Boolean	Ob die Benachrichtigung aktiviert ist.
Channel	Edm.String	Benachrichtigungskanal (z. B. Email, Push).

Endpunkte

GET/odata/NotificationFilterSetting

Alle Benachrichtigungsfilter abrufen

Unterstützt OData-Abfrageoptionen.

GET /odata/NotificationFilterSetting?$filter=Channel eq 'Email'

---

GET/odata/NotificationFilterSetting({key})

Einen Benachrichtigungsfilter nach ID abrufen

Parameter	Type	Required	Description
key	Edm.Guid	✅	Die NotificationFilterSettingId.

---

GET/odata/NotificationFilterSetting/$count

Anzahl der Benachrichtigungsfilter abrufen

Gibt eine Ganzzahl zurück.

---

POST/odata/NotificationFilterSetting/CreateOrUpdate

Einen Benachrichtigungsfilter erstellen oder aktualisieren

Erstellt einen neuen Filter oder aktualisiert einen bestehenden, falls ein Filter für den angegebenen Pfad und Kanal bereits existiert.

{
  "EntityPath": "Project",
  "Enabled": true,
  "Channel": "Email"
}

---

NotificationObjectRelation

Die NotificationObjectRelation-Entität stellt die Verknüpfung zwischen Benachrichtigungseinstellungen und den zugehörigen Objekten dar (z. B. Projekte, Aufgaben).

info

NotificationObjectRelation ist eine schreibgeschützte Entität. Sie repräsentiert die Zuordnung zwischen Benachrichtigungseinstellungen und deren verknüpften Objekten und kann nicht direkt bearbeitet werden.

Endpunkte

GET/odata/NotificationObjectRelation

Alle Benachrichtigungsobjektverknüpfungen abrufen. Unterstützt OData-Abfrageoptionen.

GET/odata/NotificationObjectRelation/$count

Gesamtanzahl der Benachrichtigungsobjektverknüpfungen abrufen.

GET/odata/NotificationObjectRelation({key})

Eine einzelne Benachrichtigungsobjektverknüpfung nach ID abrufen.

Parameter	Type	Required	Description
key	Guid	✅	Die eindeutige ID der Benachrichtigungsobjektverknüpfung.

---

ValidInviteDomain

Die ValidInviteDomain-Entität verwaltet die erlaubten Domänen für Benutzereinladungen. Nur E-Mail-Adressen mit einer hier hinterlegten Domäne können eingeladen werden.

Eigenschaften

Property	Type	Description
ValidInviteDomainId	Edm.Guid	Eindeutige ID der Domäne.
DomainName	Edm.String	Der Domänenname (z. B. beispiel.de).

Endpunkte

GET/odata/ValidInviteDomain

Alle erlaubten Einladungsdomänen abrufen

GET /odata/ValidInviteDomain

---

GET/odata/ValidInviteDomain({key})

Eine Einladungsdomäne nach ID abrufen

Parameter	Type	Required	Description
key	Edm.Guid	✅	Die ValidInviteDomainId.

---

POST/odata/ValidInviteDomain

Eine neue Einladungsdomäne hinzufügen

{
  "DomainName": "neuedomaene.de"
}

---

PATCH/odata/ValidInviteDomain({key})

Eine Einladungsdomäne aktualisieren

Parameter	Type	Required	Description
key	Edm.Guid	✅	Die ValidInviteDomainId.

{
  "DomainName": "aktualisiert.de"
}

---

DELETE/odata/ValidInviteDomain({key})

Eine Einladungsdomäne löschen

Parameter	Type	Required	Description
key	Edm.Guid	✅	Die ValidInviteDomainId.

Gibt 204 No Content bei Erfolg zurück.

---

GET/odata/ValidInviteDomain/$count

Anzahl der Einladungsdomänen abrufen

Gibt eine Ganzzahl zurück.

---

ValidLoginDomain

Die ValidLoginDomain-Entität verwaltet die erlaubten Domänen für die Benutzeranmeldung. Nur Benutzer mit einer E-Mail-Adresse in einer dieser Domänen können sich anmelden.

Eigenschaften

Property	Type	Description
ValidLoginDomainId	Edm.Guid	Eindeutige ID der Domäne.
DomainName	Edm.String	Der Domänenname (z. B. firma.de).

Endpunkte

GET/odata/ValidLoginDomain

Alle erlaubten Anmeldedomänen abrufen

GET /odata/ValidLoginDomain

---

GET/odata/ValidLoginDomain({key})

Eine Anmeldedomäne nach ID abrufen

Parameter	Type	Required	Description
key	Edm.Guid	✅	Die ValidLoginDomainId.

---

POST/odata/ValidLoginDomain

Eine neue Anmeldedomäne hinzufügen

{
  "DomainName": "firma.de"
}

---

PATCH/odata/ValidLoginDomain({key})

Eine Anmeldedomäne aktualisieren

Parameter	Type	Required	Description
key	Edm.Guid	✅	Die ValidLoginDomainId.

{
  "DomainName": "neuefirma.de"
}

---

DELETE/odata/ValidLoginDomain({key})

Eine Anmeldedomäne löschen

Parameter	Type	Required	Description
key	Edm.Guid	✅	Die ValidLoginDomainId.

Gibt 204 No Content bei Erfolg zurück.

---

GET/odata/ValidLoginDomain/$count

Anzahl der Anmeldedomänen abrufen

Gibt eine Ganzzahl zurück.

tipp

Konfigurieren Sie sowohl ValidInviteDomain als auch ValidLoginDomain, um konsistente Domänenrichtlinien durchzusetzen. Einladungsdomänen steuern, wer hinzugefügt werden kann, während Anmeldedomänen steuern, wer sich authentifizieren kann.