Kategorien & Stammdaten

Diese Seite beschreibt die API-Endpunkte für Stammdaten, die in verschiedenen Bereichen von InLoox verwendet werden: Kategorien, Kunden, Projektstatus, Aufgabenstatus, Notizen, Vorlagen und weitere Hilfsentitäten.

---

Category

Die Category-Entität ermöglicht die Kategorisierung von Projekten und anderen Objekten. Kategorien können frei definiert und zugewiesen werden.

Eigenschaften

Property	Type	Description
CategoryId	Edm.Guid	Eindeutige ID der Kategorie.
Name	Edm.String	Name der Kategorie.

Endpunkte

GET/odata/Category

Alle Kategorien abrufen

Unterstützt OData-Abfrageoptionen.

GET /odata/Category?$orderby=Name

---

GET/odata/Category({key})

Eine Kategorie nach ID abrufen

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

---

POST/odata/Category

Eine neue Kategorie erstellen

{
  "Name": "Strategisch"
}

---

PATCH/odata/Category({key})

Eine Kategorie aktualisieren

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

{
  "Name": "Strategisch – Priorisiert"
}

---

DELETE/odata/Category({key})

Eine Kategorie löschen

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

Gibt 204 No Content bei Erfolg zurück.

---

GET/odata/Category/$count

Anzahl der Kategorien abrufen

Gibt eine Ganzzahl zurück.

---

Client

Die Client-Entität repräsentiert Kunden in InLoox. Kunden können Projekten zugeordnet werden und verfügen über eine automatische Nummerierung.

Eigenschaften

Property	Type	Description
ClientId	Edm.Guid	Eindeutige ID des Kunden.
Name	Edm.String	Kundenname.
NumberPrefix	Edm.String	Präfix der Kundennummer.
NumberIncremential	Edm.Int32?	Automatisch inkrementierter Teil der Kundennummer.
NumberSuffix	Edm.String	Suffix der Kundennummer.
Number	Edm.String	Vollständige Kundennummer (Präfix + Inkrement + Suffix).

Endpunkte

GET/odata/Client

Alle Kunden abrufen

Unterstützt OData-Abfrageoptionen.

GET /odata/Client?$orderby=Name&$select=ClientId,Name,Number

---

GET/odata/Client({key})

Einen Kunden nach ID abrufen

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

---

POST/odata/Client

Einen neuen Kunden erstellen

{
  "Name": "Musterfirma GmbH",
  "NumberPrefix": "KD-"
}

tipp

Die Kundennummer wird automatisch generiert, wenn die Nummerneinstellungen in der Konfiguration aktiviert sind. Verwenden Sie Configuration/GetClientNumberSettings(), um die aktuelle Konfiguration abzurufen.

---

PATCH/odata/Client({key})

Einen Kunden aktualisieren

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

{
  "Name": "Musterfirma AG"
}

---

DELETE/odata/Client({key})

Einen Kunden löschen

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

Gibt 204 No Content bei Erfolg zurück.

---

GET/odata/Client/$count

Anzahl der Kunden abrufen

Gibt eine Ganzzahl zurück.

---

ProjectStatus

Die ProjectStatus-Entität definiert die verfügbaren Statuswerte für Projekte. Jeder Status hat einen Namen, einen Fortschrittswert und eine Sortierposition.

Eigenschaften

Property	Type	Description
ProjectStatusId	Edm.Guid	Eindeutige ID des Projektstatus.
Name	Edm.String	Name des Status (z. B. Aktiv, Abgeschlossen, Pausiert).
Progress	Edm.Int32	Fortschrittswert in Prozent (0–100).
OrdinalPosition	Edm.Int32	Sortierposition.

Endpunkte

GET/odata/ProjectStatus

Alle Projektstatus abrufen

GET /odata/ProjectStatus?$orderby=OrdinalPosition

---

GET/odata/ProjectStatus({key})

Einen Projektstatus nach ID abrufen

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

---

POST/odata/ProjectStatus

Einen neuen Projektstatus erstellen

{
  "Name": "In Genehmigung",
  "Progress": 10,
  "OrdinalPosition": 2
}

---

PATCH/odata/ProjectStatus({key})

Einen Projektstatus aktualisieren

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

{
  "Name": "In Prüfung",
  "Progress": 15
}

---

DELETE/odata/ProjectStatus({key})

Einen Projektstatus löschen

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

Gibt 204 No Content bei Erfolg zurück.

---

GET/odata/ProjectStatus/$count

Anzahl der Projektstatus abrufen

Gibt eine Ganzzahl zurück.

---

ProjectNote

Die ProjectNote-Entität speichert Notizen zu einem Projekt. Jede Notiz wird mit dem Ersteller und dem Erstellungsdatum verknüpft.

Eigenschaften

Property	Type	Description
ProjectNoteId	Edm.Guid	Eindeutige ID der Notiz.
ProjectId	Edm.Guid	ID des zugehörigen Projekts.
Note	Edm.String	Notiztext (Klartext).
NoteHtml	Edm.String	Notiztext (HTML-formatiert).
ShortDescription	Edm.String	Kurzbeschreibung der Notiz.
CreateDateTime	Edm.DateTimeOffset	Erstellungszeitpunkt.
CreatedByContactId	Edm.Guid	ID des Erstellers.

Endpunkte

GET/odata/ProjectNote

Alle Projektnotizen abrufen

Filtern Sie nach Projekt:

GET /odata/ProjectNote?$filter=ProjectId eq 3fa85f64-5717-4562-b3fc-2c963f66afa6&$orderby=CreateDateTime desc

---

GET/odata/ProjectNote({key})

Eine Projektnotiz nach ID abrufen

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

---

POST/odata/ProjectNote

Eine neue Projektnotiz erstellen

{
  "ProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ShortDescription": "Statusbericht KW 12",
  "Note": "Das Projekt liegt im Zeitplan. Nächster Meilenstein am 28.03.",
  "NoteHtml": "<p>Das Projekt liegt im Zeitplan. Nächster Meilenstein am 28.03.</p>"
}

---

PATCH/odata/ProjectNote({key})

Eine Projektnotiz aktualisieren

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

{
  "Note": "Aktualisiert: Meilenstein auf 30.03. verschoben."
}

---

DELETE/odata/ProjectNote({key})

Eine Projektnotiz löschen

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

Gibt 204 No Content bei Erfolg zurück.

---

GET/odata/ProjectNote/$count

Anzahl der Projektnotizen abrufen

Gibt eine Ganzzahl zurück.

---

TaskStatus

Die TaskStatus-Entität definiert projektspezifische Aufgabenstatus. Jeder Status kann eine Farbe und eine Sortierposition haben.

Eigenschaften

Property	Type	Description
TaskItemStatusId	Edm.Guid	Eindeutige ID des Aufgabenstatus.
Name	Edm.String	Name des Status.
ProjectId	Edm.Guid	ID des zugehörigen Projekts.
OrdinalPosition	Edm.Int32	Sortierposition.
Color	Edm.Int32?	Farbwert (als Ganzzahl).

Endpunkte

GET/odata/TaskStatus

Alle Aufgabenstatus abrufen

Filtern Sie nach Projekt:

GET /odata/TaskStatus?$filter=ProjectId eq 3fa85f64-5717-4562-b3fc-2c963f66afa6&$orderby=OrdinalPosition

---

GET/odata/TaskStatus({key})

Einen Aufgabenstatus nach ID abrufen

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

---

POST/odata/TaskStatus

Einen neuen Aufgabenstatus erstellen

{
  "Name": "In Bearbeitung",
  "ProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "OrdinalPosition": 2,
  "Color": 65280
}

---

PATCH/odata/TaskStatus({key})

Einen Aufgabenstatus aktualisieren

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

{
  "Name": "In Bearbeitung – Priorität",
  "Color": 16711680
}

---

DELETE/odata/TaskStatus({key})

Einen Aufgabenstatus löschen

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

Gibt 204 No Content bei Erfolg zurück.

---

GET/odata/TaskStatus/$count

Anzahl der Aufgabenstatus abrufen

Gibt eine Ganzzahl zurück.

---

TaskItemStatusDefault

Die TaskItemStatusDefault-Entität definiert die organisationsweiten Standardstatus für Aufgaben. Diese Standardwerte werden als Vorlage für neue Projekte verwendet.

Eigenschaften

Property	Type	Description
TaskItemStatusDefaultId	Edm.Guid	Eindeutige ID des Standardstatus.
Name	Edm.String	Name des Standardstatus.
HexColor	Edm.String	Farbwert als Hex-Code (z. B. #FF0000).
OrdinalPosition	Edm.Int32	Sortierposition.

Endpunkte

GET/odata/TaskItemStatusDefault

Alle Standard-Aufgabenstatus abrufen

GET /odata/TaskItemStatusDefault?$orderby=OrdinalPosition

---

GET/odata/TaskItemStatusDefault({key})

Einen Standard-Aufgabenstatus nach ID abrufen

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

---

POST/odata/TaskItemStatusDefault

Einen neuen Standard-Aufgabenstatus erstellen

{
  "Name": "Neu",
  "HexColor": "#3498DB",
  "OrdinalPosition": 0
}

---

PATCH/odata/TaskItemStatusDefault({key})

Einen Standard-Aufgabenstatus aktualisieren

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

{
  "HexColor": "#2ECC71"
}

---

DELETE/odata/TaskItemStatusDefault({key})

Einen Standard-Aufgabenstatus löschen

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

Gibt 204 No Content bei Erfolg zurück.

---

GET/odata/TaskItemStatusDefault/$count

Anzahl der Standard-Aufgabenstatus abrufen

Gibt eine Ganzzahl zurück.

---

TaskItemNote

Die TaskItemNote-Entität speichert Notizen zu einer Aufgabe. Sie funktioniert analog zu ProjectNote, ist jedoch an eine Aufgabe gebunden.

Eigenschaften

Property	Type	Description
TaskItemNoteId	Edm.Guid	Eindeutige ID der Notiz.
TaskItemId	Edm.Guid	ID der zugehörigen Aufgabe.
Note	Edm.String	Notiztext (Klartext).
NoteHtml	Edm.String	Notiztext (HTML-formatiert).
ShortDescription	Edm.String	Kurzbeschreibung.
CreateDateTime	Edm.DateTimeOffset	Erstellungszeitpunkt.
CreatedByContactId	Edm.Guid	ID des Erstellers.

Endpunkte

GET/odata/TaskItemNote

Alle Aufgabennotizen abrufen

Filtern Sie nach Aufgabe:

GET /odata/TaskItemNote?$filter=TaskItemId eq 3fa85f64-5717-4562-b3fc-2c963f66afa6&$orderby=CreateDateTime desc

---

GET/odata/TaskItemNote({key})

Eine Aufgabennotiz nach ID abrufen

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

---

POST/odata/TaskItemNote

Eine neue Aufgabennotiz erstellen

{
  "TaskItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ShortDescription": "Rückfrage zum Design",
  "Note": "Das Design muss noch mit dem Kunden abgestimmt werden."
}

---

PATCH/odata/TaskItemNote({key})

Eine Aufgabennotiz aktualisieren

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

{
  "Note": "Design wurde am 25.03. mit dem Kunden besprochen und freigegeben."
}

---

DELETE/odata/TaskItemNote({key})

Eine Aufgabennotiz löschen

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

Gibt 204 No Content bei Erfolg zurück.

---

GET/odata/TaskItemNote/$count

Anzahl der Aufgabennotizen abrufen

Gibt eine Ganzzahl zurück.

---

TaskItemTemplate

Die TaskItemTemplate-Entität ermöglicht das Speichern und Laden von Aufgabenvorlagen. Vorlagen können Aufgabenstrukturen aus bestehenden Projekten erfassen und in andere Projekte laden.

Eigenschaften

Property	Type	Description
TaskItemTemplateId	Edm.Guid	Eindeutige ID der Vorlage.
Name	Edm.String	Name der Vorlage.

Endpunkte

CRUD-Operationen

GET/odata/TaskItemTemplate

Alle Aufgabenvorlagen abrufen

GET /odata/TaskItemTemplate?$orderby=Name

---

GET/odata/TaskItemTemplate({key})

Eine Aufgabenvorlage nach ID abrufen

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

---

POST/odata/TaskItemTemplate

Eine neue Aufgabenvorlage erstellen

{
  "Name": "Standard-Projektaufgaben"
}

---

PATCH/odata/TaskItemTemplate({key})

Eine Aufgabenvorlage aktualisieren

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

{
  "Name": "Projektaufgaben v2"
}

---

DELETE/odata/TaskItemTemplate({key})

Eine Aufgabenvorlage löschen

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

Gibt 204 No Content bei Erfolg zurück.

---

GET/odata/TaskItemTemplate/$count

Anzahl der Aufgabenvorlagen abrufen

Gibt eine Ganzzahl zurück.

---

Vorlagenverwaltung

POST/odata/TaskItemTemplate/SaveTemplateForProject

Eine Vorlage aus den Aufgaben eines Projekts speichern

Speichert die Aufgabenstruktur eines bestehenden Projekts als wiederverwendbare Vorlage.

{
  "ProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Name": "Vorlage aus Projekt XYZ"
}

---

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

Eine Vorlage in ein Projekt laden

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

Erstellt Aufgaben im angegebenen Projekt basierend auf der Vorlage.

{
  "ProjectId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

tipp

Beim Laden einer Vorlage werden die Aufgaben einschließlich ihrer Hierarchie und Abhängigkeiten in das Zielprojekt übertragen.

---

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

Eine Vorlage herunterladen

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

---

GET/odata/TaskItemTemplate({key})/DownloadTaskItemTemplate()

Eine Aufgabenvorlage herunterladen (alternativ)

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

Alternativer Download-Endpunkt für Aufgabenvorlagen.

---

RelatedItem

Die RelatedItem-Entität ermöglicht den Zugriff auf verknüpfte Objekte einer Entität. Verknüpfungen können zwischen verschiedenen Entitätstypen bestehen (z. B. Aufgabe → Dokument, Projekt → Risiko).

Eigenschaften

Property	Type	Description
GenericObjectRelationId	Edm.Guid	Eindeutige ID der Verknüpfung.
ResultType	Edm.String	Typ des verknüpften Objekts.
RelatedObjectId	Edm.Guid	ID des verknüpften Objekts.
UpdatedAt	Edm.DateTimeOffset	Zeitpunkt der letzten Aktualisierung.
SecurityContactId	Edm.Guid	Kontakt-ID für Berechtigungsprüfung.
ProjectId	Edm.Guid?	Zugehörige Projekt-ID (falls zutreffend).
ObjectId	Edm.Guid	ID des Quellobjekts.
ParentObjectId	Edm.Guid?	ID des übergeordneten Objekts.
Title	Edm.String	Titel des verknüpften Objekts.
ImageId	Edm.Guid?	Bild-ID des verknüpften Objekts.

Endpunkte

GET/odata/RelatedItem({key})/GetRelatedItems()

Verknüpfte Objekte abrufen

Parameter	Type	Required	Description
key	Edm.Guid	✅	Die ID des Quellobjekts, dessen Verknüpfungen abgerufen werden sollen.

Gibt alle Objekte zurück, die mit dem angegebenen Objekt verknüpft sind.

GET /odata/RelatedItem(3fa85f64-5717-4562-b3fc-2c963f66afa6)/GetRelatedItems()

---

UserStopwatch

Die UserStopwatch-Entität ermöglicht den Zugriff auf die aktiven Stoppuhren des aktuellen Benutzers. Stoppuhren werden für die Zeiterfassung verwendet.

Endpunkte

GET/odata/UserStopwatch/GetStopwatches()

Aktive Stoppuhren abrufen

Gibt alle derzeit laufenden Stoppuhren des authentifizierten Benutzers zurück.

GET /odata/UserStopwatch/GetStopwatches()

tipp

Verwenden Sie diesen Endpunkt, um zu prüfen, ob der Benutzer aktuell eine Zeiterfassung über die Stoppuhrfunktion durchführt. Die Antwort enthält Informationen über die zugeordnete Aufgabe und den Startzeitpunkt.