Checklisten

Checklisten in InLoox ermöglichen die strukturierte Erfassung tabellarischer Daten innerhalb eines Projekts. Jede Checkliste besteht aus Spalten (Felddefinitionen), Datenzeilen und zugehörigen Werten. Vorlagen erlauben die Wiederverwendung von Checklistenstrukturen.

info

Checklisten sind stets einem Projekt zugeordnet. Verwenden Sie ProjectId beim Filtern, um nur Checklisten eines bestimmten Projekts abzurufen.

---

CheckList

Die CheckList-Entität repräsentiert eine einzelne Checkliste innerhalb eines Projekts.

Eigenschaften

Property	Type	Description
CheckListId	Edm.Guid	Eindeutige ID der Checkliste.
ProjectId	Edm.Guid	ID des zugehörigen Projekts.
OrdinalPosition	Edm.Int32	Sortierposition der Checkliste im Projekt.
Name	Edm.String	Name der Checkliste.
InitialColumnNames	Collection(Edm.String)	Initiale Spaltennamen beim Erstellen (optional).

Endpunkte

GET/odata/CheckList

Alle Checklisten abrufen

Unterstützt OData-Abfrageoptionen. Filtern Sie nach Projekt:

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

---

GET/odata/CheckList({key})

Eine Checkliste nach ID abrufen

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

---

POST/odata/CheckList

Eine neue Checkliste erstellen

{
  "ProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Name": "Qualitätsprüfung",
  "OrdinalPosition": 1,
  "InitialColumnNames": ["Kriterium", "Status", "Bemerkung"]
}

tipp

Verwenden Sie InitialColumnNames, um beim Erstellen direkt Spalten anzulegen. Andernfalls können Sie Spalten nachträglich über den CheckListColumn-Endpunkt hinzufügen.

---

PATCH/odata/CheckList({key})

Eine bestehende Checkliste aktualisieren

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

{
  "Name": "Qualitätsprüfung – Version 2"
}

---

DELETE/odata/CheckList({key})

Eine Checkliste löschen

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

warnung

Das Löschen einer Checkliste entfernt auch alle zugehörigen Spalten, Zeilen und Werte. Diese Aktion kann nicht rückgängig gemacht werden.

Gibt 204 No Content bei Erfolg zurück.

---

GET/odata/CheckList/$count

Anzahl der Checklisten abrufen

Gibt eine Ganzzahl zurück. Unterstützt $filter.

---

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

Eine Verknüpfung zur Checkliste hinzufügen

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

---

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

Eine Verknüpfung von der Checkliste entfernen

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

---

CheckListColumn

Die CheckListColumn-Entität definiert die Spalten (Felder) einer Checkliste.

Eigenschaften

Property	Type	Description
CheckListColumnId	Edm.Guid	Eindeutige ID der Spalte.
CheckListId	Edm.Guid	ID der zugehörigen Checkliste.
OrdinalPosition	Edm.Int32	Sortierposition der Spalte.
Name	Edm.String	Spaltenname.
ColumnType	Edm.Int32	Spaltentyp (z. B. Text, Zahl, Checkbox).

Endpunkte

GET/odata/CheckListColumn

Alle Checklistenspalten abrufen

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

---

GET/odata/CheckListColumn({key})

Eine Spalte nach ID abrufen

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

---

POST/odata/CheckListColumn

Eine neue Spalte erstellen

{
  "CheckListId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Name": "Verantwortlich",
  "OrdinalPosition": 3,
  "ColumnType": 0
}

---

PATCH/odata/CheckListColumn({key})

Eine Spalte aktualisieren

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

{
  "Name": "Zuständiger Mitarbeiter"
}

---

DELETE/odata/CheckListColumn({key})

Eine Spalte löschen

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

Gibt 204 No Content bei Erfolg zurück.

---

GET/odata/CheckListColumn/$count

Anzahl der Spalten abrufen

Gibt eine Ganzzahl zurück.

---

CheckListDataRow

Die CheckListDataRow-Entität repräsentiert eine Datenzeile in einer Checkliste. Die eigentlichen Werte werden über CheckListValue gespeichert.

Eigenschaften

Property	Type	Description
RowId	Edm.Guid	Eindeutige ID der Zeile.
CheckListId	Edm.Guid	ID der zugehörigen Checkliste.
OrdinalPosition	Edm.Int32	Sortierposition der Zeile.

Endpunkte

GET/odata/CheckListDataRow

Alle Datenzeilen abrufen

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

---

GET/odata/CheckListDataRow({key})

Eine Datenzeile nach ID abrufen

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

---

POST/odata/CheckListDataRow

Eine neue Datenzeile erstellen

{
  "CheckListId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "OrdinalPosition": 0
}

---

PATCH/odata/CheckListDataRow({key})

Eine Datenzeile aktualisieren

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

{
  "OrdinalPosition": 5
}

---

DELETE/odata/CheckListDataRow({key})

Eine Datenzeile löschen

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

Gibt 204 No Content bei Erfolg zurück.

---

GET/odata/CheckListDataRow/$count

Anzahl der Datenzeilen abrufen

Gibt eine Ganzzahl zurück.

---

CheckListTemplate

Die CheckListTemplate-Entität ermöglicht das Speichern und Laden von Checklistenvorlagen. Vorlagen können aus bestehenden Checklisten erstellt und in andere Projekte geladen werden.

Eigenschaften

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

Endpunkte

CRUD-Operationen

GET/odata/CheckListTemplate

Alle Checklistenvorlagen abrufen

Unterstützt OData-Abfrageoptionen.

GET /odata/CheckListTemplate?$orderby=Name

---

GET/odata/CheckListTemplate({key})

Eine Vorlage nach ID abrufen

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

---

POST/odata/CheckListTemplate

Eine neue Vorlage erstellen

{
  "Name": "Standard-Qualitätsprüfung"
}

---

PATCH/odata/CheckListTemplate({key})

Eine Vorlage aktualisieren

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

{
  "Name": "Qualitätsprüfung v2"
}

---

DELETE/odata/CheckListTemplate({key})

Eine Vorlage löschen

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

Gibt 204 No Content bei Erfolg zurück.

---

GET/odata/CheckListTemplate/$count

Anzahl der Vorlagen abrufen

Gibt eine Ganzzahl zurück.

---

Vorlagenverwaltung

POST/odata/CheckListTemplate/SaveTemplateForCheckList

Eine Vorlage aus einer bestehenden Checkliste speichern

Speichert die Struktur einer vorhandenen Checkliste als wiederverwendbare Vorlage.

{
  "CheckListId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Name": "Vorlage aus Qualitätsprüfung"
}

---

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

Eine Vorlage in ein Projekt laden

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

Erstellt eine neue Checkliste im angegebenen Projekt basierend auf der Vorlage.

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

---

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

Eine Vorlage herunterladen

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

Gibt die Vorlagendaten als Download zurück.

---

GET/odata/CheckListTemplate({key})/DownloadCheckListTemplate()

Eine Checklistenvorlage herunterladen (alternativ)

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

Alternativer Download-Endpunkt für Checklistenvorlagen.

---

CheckListValue

Die CheckListValue-Entität speichert den Wert einer einzelnen Zelle (Zeile × Spalte) in einer Checkliste.

Eigenschaften

Property	Type	Description
RowId	Edm.Guid	ID der zugehörigen Datenzeile.
FieldName	Edm.Guid	ID der Spalte (CheckListColumnId).
Value	any	Der gespeicherte Wert (Typ variiert je nach Spaltentyp).

Endpunkte

POST/odata/CheckListValue

Einen Zellenwert erstellen oder aktualisieren

Erstellt oder aktualisiert den Wert einer einzelnen Zelle in einer Checkliste.

{
  "RowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "FieldName": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "Value": "Bestanden"
}

info

Der Value-Typ muss zum Spaltentyp (ColumnType) passen. Für Checkbox-Spalten verwenden Sie true/false, für Zahlenspalten einen numerischen Wert.