Organisation & Stammdaten
Diese Seite beschreibt die API-Endpunkte für Stammdaten, die in verschiedenen Bereichen von InLoox verwendet werden: Kategorien, Kunden, Projektstatus, Standard-Aufgabenstatus, Vorlagen und weitere Hilfsentitäten.
Category
Die Category-Entität ermöglicht die Kategorisierung von Projekten. Kategorien können frei definiert und zugewiesen werden.
Datenmodell
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
CategoryId | guid | Eindeutige ID der Kategorie. |
Name | string | Name der Kategorie. |
Endpunkte
Alle Kategorien abrufen
/odata/CategoryUnterstützt OData-Abfrageoptionen.
Eine Kategorie nach ID abrufen
/odata/Category({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die CategoryId. |
Eine neue Kategorie erstellen
/odata/Category| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Body | Delta<ApiCategory> | ✅ | JSON-Objekt mit den Eigenschaften aus dem Datenmodell. |
Eine Kategorie aktualisieren
/odata/Category({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die CategoryId. |
Body | Delta<ApiCategory> | ✅ | JSON-Objekt mit den zu aktualisierenden Feldern. |
Eine Kategorie löschen
/odata/Category({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die CategoryId. |
Das Löschen einer Kategorie entfernt sie aus allen Projekten, die sie verwenden. Diese Aktion kann nicht rückgängig gemacht werden.
Gibt 204 No Content bei Erfolg 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.
Datenmodell
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
ClientId | guid | Eindeutige ID des Kunden. |
Name | string | Kundenname. |
NumberPrefix | string | Präfix der Kundennummer. |
NumberIncremential | int? | Automatisch inkrementierter Teil der Kundennummer. |
NumberSuffix | string | Suffix der Kundennummer. |
Number | string | Vollständige Kundennummer (Präfix + Inkrement + Suffix). |
Endpunkte
Alle Kunden abrufen
/odata/ClientUnterstützt OData-Abfrageoptionen.
Einen Kunden nach ID abrufen
/odata/Client({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die ClientId. |
Einen neuen Kunden erstellen
/odata/Client| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Body | Delta<ApiClient> | ✅ | JSON-Objekt mit den Eigenschaften aus dem Datenmodell. |
Die Kundennummer wird automatisch generiert, wenn die Nummerneinstellungen in der Konfiguration aktiviert sind. Verwenden Sie odata/Configuration/GetClientNumberSettings(), um die aktuelle Konfiguration abzurufen.
Einen Kunden aktualisieren
/odata/Client({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die ClientId. |
Body | Delta<ApiClient> | ✅ | JSON-Objekt mit den zu aktualisierenden Feldern. |
Einen Kunden löschen
/odata/Client({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die ClientId. |
Das Löschen eines Kunden entfernt ihn aus allen zugeordneten Projekten. Diese Aktion kann nicht rückgängig gemacht werden.
Gibt 204 No Content bei Erfolg zurück.
Division
Die Division-Entität (Abteilung) ermöglicht die hierarchische Organisationsstruktur in InLoox. Abteilungen können verschachtelt werden und Kontakte zugewiesen bekommen. Nutzer können Berechtigungen auf Projekte erhalten, denen bestimmte Abteilungen zugeordnet sind.
Datenmodell
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
DivisionId | guid | Eindeutige ID der Abteilung. |
ParentDivisionId | guid? | ID der übergeordneten Abteilung (null für Stammebene). |
DisplayName | string | Anzeigename der Abteilung. |
PositionNumber | int | Sortierposition. |
Description | string | Beschreibung der Abteilung. |
Endpunkte
CRUD-Operationen
Alle Abteilungen abrufen
/odata/DivisionUnterstützt OData-Abfrageoptionen.
Eine Abteilung nach ID abrufen
/odata/Division({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die DivisionId der abzurufenden Abteilung. |
Eine neue Abteilung erstellen
/odata/Division| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Body | Delta<ApiDivision> | ✅ | JSON-Objekt mit den Eigenschaften aus dem Datenmodell. |
Lassen Sie DivisionId weg, damit der Server automatisch eine neue ID generiert. Setzen Sie ParentDivisionId, um eine Unterabteilung zu erstellen.
Eine bestehende Abteilung aktualisieren
/odata/Division({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die DivisionId der zu aktualisierenden Abteilung. |
Body | Delta<ApiDivision> | ✅ | JSON-Objekt mit den zu aktualisierenden Feldern. |
Eine Abteilung löschen
/odata/Division({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die DivisionId der zu löschenden Abteilung. |
Gibt 204 No Content bei Erfolg zurück.
Das Löschen einer Abteilung entfernt auch alle Kontaktzuordnungen dieser Abteilung. Da Berechtigungen auch auf Abteilungsebene vergeben werden können, verlieren Benutzer möglicherweise den Zugriff auf Projekte.
Kontaktverwaltung
Alle Kontakte mit Abteilungszuordnung abrufen
/odata/Division/GetContacts()Gibt alle DivisionContactRelation-Einträge zurück.
Einen Kontakt einer Abteilung zuweisen
/odata/Division({key})/AddContact| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die DivisionId. |
Body | object | ✅ | JSON-Objekt mit folgenden Feldern: ContactId (guid, erforderlich) — Der zuzuweisende Kontakt. |
Einen Kontakt aus einer Abteilung entfernen
/odata/Division({key})/RemoveContact| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die DivisionId. |
Body | object | ✅ | JSON-Objekt mit folgenden Feldern: ContactId (guid, erforderlich) — Der zu entfernende Kontakt. |
DivisionContactRelation
Die DivisionContactRelation-Entität bildet die Zuordnung zwischen Abteilungen und Kontakten ab. Jede Zuordnung verknüpft genau einen Kontakt mit einer Abteilung.
Diese Entität ist schreibgeschützt. Um die Zuordnung von Abteilungen und Kontakten zu verwalten, verwenden Sie die Aktionen AddContact und RemoveContact auf der Division-Entität.
Datenmodell
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
DivisionContactRelationId | guid | Eindeutige ID der Zuordnung. |
DivisionId | guid | ID der Abteilung. |
ContactId | guid | ID des Kontakts. |
Endpunkte
Alle Abteilungs-Kontakt-Zuordnungen aller Kontakte abrufen
/odata/DivisionContactRelationUnterstützt OData-Abfrageoptionen.
Filtern Sie nach Abteilung oder Kontakt:
GET /odata/DivisionContactRelation?$filter=DivisionId eq xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Eine einzelne Zuordnung nach ID abrufen
/odata/DivisionContactRelation({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die DivisionContactRelationId. |
ProjectStatus
Die ProjectStatus-Entität definiert die verfügbaren Statuswerte für Projekte. Jeder Status hat einen Namen, einen Fortschrittswert und eine Sortierposition.
Datenmodell
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
ProjectStatusId | guid | Eindeutige ID des Projektstatus. |
Name | string | Name des Status (z. B. Aktiv, Abgeschlossen, Pausiert). |
Progress | int | Fortschrittswert in Prozent (0–100). |
OrdinalPosition | int | Sortierposition. |
Endpunkte
Alle Projektstatus abrufen
/odata/ProjectStatusEinen Projektstatus nach ID abrufen
/odata/ProjectStatus({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die ProjectStatusId. |
Einen neuen Projektstatus erstellen
/odata/ProjectStatus| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Body | Delta<ApiProjectStatus> | ✅ | JSON-Objekt mit den Eigenschaften aus dem Datenmodell. |
Einen Projektstatus aktualisieren
/odata/ProjectStatus({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die ProjectStatusId. |
Body | Delta<ApiProjectStatus> | ✅ | JSON-Objekt mit den zu aktualisierenden Feldern. |
Einen Projektstatus löschen
/odata/ProjectStatus({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die ProjectStatusId. |
Das Löschen eines Projektstatus betrifft alle Projekte, die ihn verwenden. Diese Aktion kann nicht rückgängig gemacht werden.
Gibt 204 No Content bei Erfolg zurück.
Skill
Die Skill-Entität verwaltet Fertigkeiten (auch Fähigkeiten oder Kompetenzen), die Kontakten zugewiesen werden können. Dies ermöglicht eine vereinfachte Ressourcenplanung bzw. Auswahl von zuständigen Personen nach frei definierbaren Eigenschaften.
Datenmodell
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
SkillId | guid | Eindeutige ID der Fertigkeit. |
Name | string | Name der Fertigkeit. |
Description | string | Beschreibung der Fertigkeit. |
Endpunkte
CRUD-Operationen
Alle Fertigkeiten abrufen
/odata/SkillUnterstützt OData-Abfrageoptionen.
Eine Fertigkeit nach ID abrufen
/odata/Skill({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die SkillId. |
Eine neue Fertigkeit erstellen
/odata/Skill| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Body | Delta<ApiSkill> | ✅ | JSON-Objekt mit den Eigenschaften aus dem Datenmodell. |
Eine bestehende Fertigkeit aktualisieren
/odata/Skill({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die SkillId der zu aktualisierenden Fertigkeit. |
Body | Delta<ApiSkill> | ✅ | JSON-Objekt mit den zu aktualisierenden Feldern. |
Eine Fertigkeit löschen
/odata/Skill({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die SkillId der zu löschenden Fertigkeit. |
Gibt 204 No Content bei Erfolg zurück.
Das Löschen einer Fertigkeit entfernt alle Kontaktzuordnungen für diese Fertigkeit.
Kontaktzuordnungen
Alle Kontakte mit Fertigkeitszuordnungen abrufen
/odata/Skill/GetContacts()Gibt alle Kontakt-Fertigkeits-Zuordnungen zurück.
Kontakte einer bestimmten Fertigkeit abrufen
/odata/Skill({key})/GetSkillContacts()| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die SkillId. |
Einen Kontakt einer Fertigkeit zuweisen
/odata/Skill({key})/AddContact| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die SkillId. |
Body | object | ✅ | JSON-Objekt mit folgenden Feldern: ContactId (guid, erforderlich) — Der zuzuweisende Kontakt. |
Einen Kontakt von einer Fertigkeit entfernen
/odata/Skill({key})/RemoveContact| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die SkillId. |
Body | object | ✅ | JSON-Objekt mit folgenden Feldern: ContactId (guid, erforderlich) — Der zu entfernende Kontakt. |
TaskItemStatusDefault
Die TaskItemStatusDefault-Entität definiert die organisationsweiten Standardstatus für Kanban-Aufgaben.
Neue Projekte übernehmen diese Standardwerte automatisch.
Datenmodell
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
TaskItemStatusDefaultId | guid | Eindeutige ID des Standardstatus. |
Name | string | Name des Standardstatus. |
HexColor | string | Farbwert als Hex-Code (z. B. #FF0000). |
OrdinalPosition | int | Sortierposition. |
Endpunkte
Alle Standard-Aufgabenstatus abrufen
/odata/TaskItemStatusDefaultEinen Standard-Aufgabenstatus nach ID abrufen
/odata/TaskItemStatusDefault({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die TaskItemStatusDefaultId. |
Einen neuen Standard-Aufgabenstatus erstellen
/odata/TaskItemStatusDefault| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Body | Delta<ApiTaskItemStatusDefault> | ✅ | JSON-Objekt mit den Eigenschaften aus dem Datenmodell. |
Einen Standard-Aufgabenstatus aktualisieren
/odata/TaskItemStatusDefault({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die TaskItemStatusDefaultId. |
Body | Delta<ApiTaskItemStatusDefault> | ✅ | JSON-Objekt mit den zu aktualisierenden Feldern. |
Einen Standard-Aufgabenstatus löschen
/odata/TaskItemStatusDefault({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die TaskItemStatusDefaultId. |
Das Löschen eines Standard-Aufgabenstatus betrifft nur die Standardwerte, die von neuen Projekten übernommen werden. Bestehende Projekte sind davon nicht betroffen.
Gibt 204 No Content bei Erfolg zurück.