Projekte

Die Project-Entität ist das zentrale Objekt in InLoox. Über die OData-API können Sie Projekte erstellen, aktualisieren, löschen und umfangreiche Aktionen wie Mitgliederverwaltung, Kategorisierung oder Planungsversionen durchführen.

OData-Endpunktbasis

Alle Endpunkte verwenden den Basispfad /odata/Project. Für die abgeflachte Listenansicht steht /odata/DynamicProject zur Verfügung.

---

Datenmodell

Die folgende Tabelle zeigt die wichtigsten Eigenschaften der ApiProject-Entität:

Property	Type	Description
ProjectId	Guid (UUID)	Eindeutiger Bezeichner des Projekts (Primärschlüssel).
Name	string	Name des Projekts.
NumberPrefix	string?	Präfix der Projektnummer.
NumberIncremential	int32?	Fortlaufende Nummer der Projektnummer.
NumberSuffix	string?	Suffix der Projektnummer.
Number	string?	Berechnete vollständige Projektnummer (Präfix + laufende Nummer + Suffix).
ClientId	Guid?	Verknüpfter Kunde (Kunden-ID).
DivisionId	Guid?	Zugehörige Abteilung.
ProjectStatusId	Guid?	Aktueller Projektstatus (Fremdschlüssel).
ComputedProgress	double?	Berechneter Fortschritt (0–1).
Priority	int32	Priorität des Projekts (ganzzahlig).
LockMode	int32	Sperrmodus (0 = nicht gesperrt).
IsLocked	boolean	Gibt an, ob das Projekt gesperrt ist.
StartDate	DateTimeOffset	Tatsächliches Startdatum.
EndDate	DateTimeOffset	Tatsächliches Enddatum.
PlannedStartDate	DateTimeOffset?	Geplantes Startdatum.
PlannedEndDate	DateTimeOffset?	Geplantes Enddatum.
IsEndDateFixed	boolean	Gibt an, ob das Enddatum fixiert ist.
BackwardScheduling	boolean	Rückwärtsterminierung aktiviert.
Private	boolean	Gibt an, ob das Projekt privat ist.
IsRecycled	boolean	Gibt an, ob das Projekt im Papierkorb liegt.
IsArchived	boolean	Gibt an, ob das Projekt archiviert ist.
IsRequest	boolean	Gibt an, ob es sich um einen Projektantrag handelt.
CreatedByContactId	Guid	Kontakt-ID des Erstellers.
ChangedByContactId	Guid?	Kontakt-ID des letzten Bearbeiters.
ImageId	Guid?	ID des Projektbilds.
PortfolioId	Guid?	Zugehöriges Portfolio.
DescriptionText	string?	Projektbeschreibung als Klartext.
DescriptionHTML	string?	Projektbeschreibung als HTML.
Categories	string?	Kommagetrennte Kategorien.
Note	string?	Projektnotiz.
NotificationsSuppressed	boolean	Benachrichtigungen unterdrückt.

Zusätzliche berechnete Felder

Die ApiProject-Entität enthält viele weitere berechnete Felder wie AmountPlannedCosts, AmountActualCosts, TotalEffort, ProjectDuration usw. Diese sind schreibgeschützt und werden serverseitig berechnet.

---

Endpunkte

CRUD-Operationen

GET/odata/Project

Alle Projekte abrufen. Unterstützt OData-Abfrageparameter ($filter, $select, $expand, $orderby, $top, $skip).

POST/odata/Project

Neues Projekt erstellen.

Parameter	Type	Required	Description
Body	Delta<ApiProject>	✅	JSON-Objekt mit den Projekteigenschaften.

GET/odata/Project({key})

Ein einzelnes Projekt anhand seiner ID abrufen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId des Projekts.

PATCH/odata/Project({key})

Projekt teilweise aktualisieren (Partial Update).

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId des Projekts.
Body	Delta<ApiProject>	✅	JSON-Objekt mit den zu aktualisierenden Feldern.

DELETE/odata/Project({key})

Projekt löschen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId des zu löschenden Projekts.

warnung

Das Löschen eines Projekts entfernt es und alle zugehörigen Daten (Aufgaben, Zeiteinträge, Dokumente usw.) dauerhaft. Diese Aktion kann nicht rückgängig gemacht werden.

GET/odata/Project/$count

Gesamtanzahl aller Projekte abrufen.

---

Mitglieder & Kontakte

POST/odata/Project({key})/AddMember

Ein Mitglied zum Projekt hinzufügen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
Body	object	✅	JSON-Objekt mit der Kontakt-ID und Rolle des neuen Mitglieds.

POST/odata/Project({key})/RemoveMember

Ein Mitglied aus dem Projekt entfernen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
Body	object	✅	JSON-Objekt mit der Kontakt-ID des zu entfernenden Mitglieds.

GET/odata/Project({key})/GetProjectContactRelations()

Alle Kontaktbeziehungen eines Projekts abrufen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.

---

Kategorien

GET/odata/Project({key})/GetAssignedCategories()

Zugewiesene Kategorien eines Projekts abrufen.

GET/odata/Project({key})/AssignCategory(categoryId={categoryId})

Eine Kategorie dem Projekt zuweisen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
categoryId	Guid	✅	Die ID der zuzuweisenden Kategorie.

GET/odata/Project({key})/UnAssignCategory(categoryId={categoryId})

Eine Kategorie vom Projekt entfernen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
categoryId	Guid	✅	Die ID der zu entfernenden Kategorie.

POST/odata/Project({key})/SetCategories

Alle Kategorien eines Projekts ersetzen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
Body	object	✅	JSON-Objekt mit der Liste der Kategorie-IDs.

---

Notizen

POST/odata/Project({key})/AddNote

Eine Notiz zum Projekt hinzufügen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
Body	object	✅	JSON-Objekt mit Notizinhalt.

POST/odata/Project({key})/DeleteNote

Eine Notiz vom Projekt entfernen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
Body	object	✅	JSON-Objekt mit der Notiz-ID.

---

Projektnummern

POST/odata/Project({key})/UpdateProjectNumber

Die Projektnummer aktualisieren.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
Body	object	✅	JSON-Objekt mit den neuen Nummernbestandteilen.

GET/odata/Project({key})/CheckIfProjectNumberExists(projectNumber={projectNumber})

Prüfen, ob eine Projektnummer bereits existiert.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
projectNumber	string	✅	Die zu prüfende Projektnummer.

GET/odata/Project({key})/CorrectIncrementIfNecessary(projectNumber={projectNumber})

Den Inkrement-Wert der Projektnummer korrigieren, falls erforderlich.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
projectNumber	string	✅	Die Projektnummer zum Abgleich.

---

Status & Aktionen

POST/odata/Project({key})/ApproveRequest

Einen Projektantrag genehmigen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId des Projektantrags.

POST/odata/Project({key})/RejectRequest

Einen Projektantrag ablehnen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId des Projektantrags.

GET/odata/Project({key})/ToggleFavorite(isFavorite={isFavorite})

Favoritenstatus eines Projekts umschalten.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
isFavorite	boolean	✅	true zum Markieren als Favorit, false zum Entfernen.

GET/odata/Project({key})/CopyProject()

Ein Projekt duplizieren.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId des zu kopierenden Projekts.

GET/odata/Project({key})/GenerateImage()

Ein Projektbild generieren (KI-gestützt).

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.

GET/odata/Project({key})/GenerateProjectDescription(language={language})

Eine Projektbeschreibung per KI generieren.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
language	string	—	Sprache der generierten Beschreibung (z. B. "de", "en").

---

Planungsversionen (Snapshots)

GET/odata/Project({key})/CreatePlanningSnapshot(name={name})

Einen Planungssnapshot erstellen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
name	string	✅	Name des Snapshots.

POST/odata/Project({key})/DeletePlanningSnapshot

Einen Planungssnapshot löschen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.

POST/odata/Project({key})/RenamePlanningSnapshot

Einen Planungssnapshot umbenennen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
Body	object	✅	JSON-Objekt mit dem neuen Namen.

---

Projektgruppen

POST/odata/Project({key})/AddProjectGroup

Eine Projektgruppe hinzufügen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
Body	object	✅	JSON-Objekt mit den Gruppendetails.

POST/odata/Project({key})/DeleteProjectGroup

Eine Projektgruppe löschen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
Body	object	✅	JSON-Objekt mit der Gruppen-ID.

POST/odata/Project({key})/SetProjectGroupColor

Die Farbe einer Projektgruppe setzen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
Body	object	✅	JSON-Objekt mit der Gruppen-ID und Farbe.

---

Verknüpfungen

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

Eine Verknüpfung zum Projekt hinzufügen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
Body	object	✅	JSON-Objekt mit den Verknüpfungsdetails.

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

Eine Verknüpfung vom Projekt entfernen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
Body	object	✅	JSON-Objekt mit der Verknüpfungs-ID.

---

Benachrichtigungen

POST/odata/Project({key})/AddNotificationFollowers

Benachrichtigungsabonnenten hinzufügen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
Body	object	✅	JSON-Objekt mit den Kontakt-IDs der Abonnenten.

POST/odata/Project({key})/RemoveNotificationFollower

Einen Benachrichtigungsabonnenten entfernen.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.
Body	object	✅	JSON-Objekt mit der Kontakt-ID.

GET/odata/Project({key})/GetNotificationFollowerContacts()

Alle Kontakte abrufen, die Benachrichtigungen für dieses Projekt abonniert haben.

Parameter	Type	Required	Description
key	Guid	✅	Die ProjectId.

---

DynamicProject

Der Endpunkt /odata/DynamicProject bietet eine schreibgeschützte, abgeflachte Ansicht, die Daten aus Projekt, Portfolio und Berechtigungen zusammenführt. Alle Eigenschaften sind mit einem Präfix versehen (z. B. Project_Name, Portfolio_Name, ProjectPermission_PermissionProjectRead).

GET/odata/DynamicProject

Abgeflachte Projektliste mit Portfolio- und Berechtigungsdaten abrufen.

GET/odata/DynamicProject/$count

Gesamtanzahl der DynamicProject-Einträge abrufen.

Nur lesender Zugriff

DynamicProject unterstützt ausschließlich GET-Anfragen. Zum Erstellen oder Bearbeiten verwenden Sie die regulären /odata/Project-Endpunkte.

---

OData-Abfragebeispiele

Alle aktiven Projekte abrufen

GET /odata/Project?$filter=IsArchived eq false and IsRecycled eq false

Projekte eines bestimmten Kunden filtern

GET /odata/Project?$filter=ClientId eq 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'

Projekte nach Priorität sortieren (absteigend)

GET /odata/Project?$orderby=Priority desc&$top=10

Nur bestimmte Felder auswählen

GET /odata/Project?$select=ProjectId,Name,Number,StartDate,EndDate,ComputedProgress

Projektanträge filtern

GET /odata/Project?$filter=IsRequest eq true

Projekt erstellen

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

{
  "Name": "Neues Projekt",
  "StartDate": "2025-01-15T00:00:00Z",
  "EndDate": "2025-06-30T00:00:00Z",
  "Priority": 2
}

Projekt aktualisieren

PATCH /odata/Project('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')
Content-Type: application/json

{
  "Name": "Aktualisierter Projektname",
  "ComputedProgress": 0.5
}

Paginierung

Verwenden Sie $top und $skip für die Paginierung großer Ergebnismengen:

GET /odata/Project?$top=50&$skip=100&$orderby=Name