Zum Hauptinhalt springen

Listen

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

info

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

CheckList​

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

Datenmodell​

EigenschaftTypBeschreibung
CheckListIdguidEindeutige ID der Liste.
ProjectIdguidID des zugehörigen Projekts.
OrdinalPositionint32Sortierposition der Liste im Projekt.
NamestringName der Liste.
InitialColumnNamesstring[]Initiale Spaltennamen beim Erstellen (optional).

Endpunkte​

Alle Listen aller Projekte abrufen

GET/odata/CheckList

Unterstützt OData-Abfrageoptionen.

Eine Liste nach ID abrufen

GET/odata/CheckList({key})
ParameterTypErforderlichBeschreibung
keyguid✅Die CheckListId.

Eine neue Liste erstellen

POST/odata/CheckList
tipp

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

Eine bestehende Liste aktualisieren

PATCH/odata/CheckList({key})
ParameterTypErforderlichBeschreibung
keyguid✅Die CheckListId.
BodyDelta<ApiCheckList>✅JSON-Objekt mit den zu aktualisierenden Feldern.

Eine Liste löschen

DELETE/odata/CheckList({key})
ParameterTypErforderlichBeschreibung
keyguid✅Die CheckListId.
warnung

Das Löschen einer Liste 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.

Verknüpfungen​

Eine Verknüpfung zur Liste hinzufügen

POST/odata/CheckList({key})/AddRelation
ParameterTypErforderlichBeschreibung
keyguid✅Die CheckListId.
itemIdguid✅Die ID des zu verknüpfenden Elements.

Eine Verknüpfung von der Liste entfernen

POST/odata/CheckList({key})/RemoveRelation
ParameterTypErforderlichBeschreibung
keyguid✅Die CheckListId.
itemIdguid✅Die ID der zu entfernenden Verknüpfung.

CheckListColumn​

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

Datenmodell​

EigenschaftTypBeschreibung
CheckListColumnIdguidEindeutige ID der Spalte.
CheckListIdguidID der zugehörigen Liste.
OrdinalPositionint32Sortierposition der Spalte.
NamestringSpaltenname.
ColumnTypeint32Spaltentyp: 0 = Text, 1 = Datum/Uhrzeit, 2 = Ganzzahl, 3 = Dezimalzahl, 4 = Wahrheitswert, 5 = Auswahlliste, 6 = Währung.

Endpunkte​

Alle Listenspalten in allen Listen in allen Projekten abrufen

GET/odata/CheckListColumn

Unterstützt OData-Abfrageoptionen.

Eine Spalte nach ID abrufen

GET/odata/CheckListColumn({key})
ParameterTypErforderlichBeschreibung
keyguid✅Die CheckListColumnId.

Eine neue Spalte erstellen

POST/odata/CheckListColumn
ParameterTypErforderlichBeschreibung
BodyDelta<ApiCheckListColumn>✅JSON-Objekt mit den Spalteneigenschaften.

Eine Spalte aktualisieren

PATCH/odata/CheckListColumn({key})
ParameterTypErforderlichBeschreibung
keyguid✅Die CheckListColumnId.
BodyDelta<ApiCheckListColumn>✅JSON-Objekt mit den zu aktualisierenden Feldern.

Eine Spalte löschen

DELETE/odata/CheckListColumn({key})
ParameterTypErforderlichBeschreibung
keyguid✅Die CheckListColumnId.
warnung

Das Löschen einer Spalte entfernt auch alle zugehörigen Zellenwerte. Diese Aktion kann nicht rückgängig gemacht werden.

Gibt 204 No Content bei Erfolg zurück.

CheckListDataRow​

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

Datenmodell​

EigenschaftTypBeschreibung
RowIdguidEindeutige ID der Zeile.
CheckListIdguidID der zugehörigen Liste.
OrdinalPositionint32Sortierposition der Zeile.

Endpunkte​

Alle Datenzeilen abrufen. Unterstützt OData-Abfrageoptionen

GET/odata/CheckListDataRow

Eine Datenzeile nach ID abrufen

GET/odata/CheckListDataRow({key})
ParameterTypErforderlichBeschreibung
keyguid✅Die RowId.

Eine neue Datenzeile erstellen

POST/odata/CheckListDataRow

Eine Datenzeile aktualisieren

PATCH/odata/CheckListDataRow({key})
ParameterTypErforderlichBeschreibung
keyguid✅Die RowId.
BodyDelta<ApiCheckListDataRow>✅JSON-Objekt mit den zu aktualisierenden Feldern.

Eine Datenzeile löschen

DELETE/odata/CheckListDataRow({key})
ParameterTypErforderlichBeschreibung
keyguid✅Die RowId.
warnung

Das Löschen einer Zeile entfernt auch alle zugehörigen Zellenwerte. Diese Aktion kann nicht rückgängig gemacht werden.

Gibt 204 No Content bei Erfolg zurück.

CheckListTemplate​

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

Datenmodell​

EigenschaftTypBeschreibung
CheckListTemplateIdguidEindeutige ID der Vorlage.
NamestringName der Vorlage.

Endpunkte​

CRUD-Operationen​

Alle Listenvorlagen abrufen

GET/odata/CheckListTemplate

Unterstützt OData-Abfrageoptionen.

Eine Vorlage nach ID abrufen

GET/odata/CheckListTemplate({key})
ParameterTypErforderlichBeschreibung
keyguid✅Die CheckListTemplateId.

Eine neue Vorlage erstellen

POST/odata/CheckListTemplate

Eine Vorlage aktualisieren

PATCH/odata/CheckListTemplate({key})
ParameterTypErforderlichBeschreibung
keyguid✅Die CheckListTemplateId.
BodyDelta<ApiCheckListTemplate>✅JSON-Objekt mit den zu aktualisierenden Feldern.

Eine Vorlage löschen

DELETE/odata/CheckListTemplate({key})
ParameterTypErforderlichBeschreibung
keyguid✅Die CheckListTemplateId.
warnung

Das Löschen einer Vorlage kann nicht rückgängig gemacht werden.

Gibt 204 No Content bei Erfolg zurück.

Vorlagenverwaltung​

Eine Vorlage aus einer bestehenden Liste speichern

POST/odata/CheckListTemplate/SaveTemplateForCheckList
ParameterTypErforderlichBeschreibung
Bodyobject✅JSON-Objekt mit folgenden Feldern:

checkListId (guid, erforderlich) — Die CheckListId der Liste, die als Vorlage gespeichert werden soll.
name (string, erforderlich) — Name der neuen Vorlage.

Speichert die Struktur einer vorhandenen Liste als wiederverwendbare Vorlage.

Eine Vorlage in ein Projekt laden

POST/odata/CheckListTemplate({key})/LoadTemplateForProject
ParameterTypErforderlichBeschreibung
keyguid✅Die CheckListTemplateId der zu ladenden Vorlage.
Bodyobject✅JSON-Objekt mit folgenden Feldern:

projectId (guid, erforderlich) \u2014 Die ID des Projekts, in das die Vorlage geladen werden soll.

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

Voraussetzung

Das Laden einer Vorlage setzt voraus, dass die Ordnerstruktur des Zielprojekts initialisiert ist. Kann der Dokumentenspeicher nicht automatisch angelegt werden, schlägt die Anfrage fehl — initialisieren Sie die Ordnerstruktur im Bereich Dokumente des Projekts und wiederholen Sie den Aufruf.

Eine Vorlage herunterladen

GET/odata/CheckListTemplate({key})/DownloadTemplate()
ParameterTypErforderlichBeschreibung
keyguid✅Die CheckListTemplateId.

Gibt eine Datei mit dem Inhaltstyp application/xml und dem Dateinamen {Vorlagenname}.json zurück.

CheckListValue​

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

Datenmodell​

EigenschaftTypBeschreibung
RowIdguidID der zugehörigen Datenzeile.
FieldNameguidID der Spalte (CheckListColumnId).
ValueanyDer gespeicherte Wert (Typ variiert je nach Spaltentyp).

Endpunkte​

Einen Zellenwert erstellen oder aktualisieren

POST/odata/CheckListValue

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

info

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

OData-Abfragebeispiele​

Listen eines Projekts abrufen​

GET /odata/CheckList?$filter=ProjectId eq {projectId}&$orderby=OrdinalPosition asc

Liste erstellen​

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

{
  "ProjectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "Name": "Qualitätsprüfung",
  "OrdinalPosition": 0,
  "InitialColumnNames": "Aufgabe,Status,Verantwortlich"
}

Liste aktualisieren​

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

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

Spalten einer Liste abrufen​

GET /odata/CheckListColumn?$filter=CheckListId eq {checkListId}&$orderby=OrdinalPosition asc

Spalte erstellen​

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

{
  "CheckListId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "Name": "Verantwortlich",
  "OrdinalPosition": 3,
  "ColumnType": "text"
}

Zeilen einer Liste abrufen​

GET /odata/CheckListDataRow?$filter=CheckListId eq {checkListId}&$orderby=OrdinalPosition asc

Zeile erstellen​

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

{
  "CheckListId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "OrdinalPosition": 0
}

Zellenwert setzen​

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

{
  "RowId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "FieldName": "Status",
  "Value": "Bestanden"
}

Vorlage erstellen​

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

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

Liste als Vorlage speichern​

POST /odata/CheckListTemplate/SaveTemplateForCheckList
Content-Type: application/json

{
  "CheckListId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "TemplateName": "Vorlage aus Qualitätsprüfung"
}

Vorlage in ein Projekt laden​

POST /odata/CheckListTemplate('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/LoadTemplateForProject
Content-Type: application/json

{
  "TemplateId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "ProjectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
tipp

Kombinieren Sie $filter mit $orderby, um Listen, Spalten und Zeilen in der korrekten Anzeigereihenfolge abzurufen. Filtern nach ProjectId oder CheckListId ist das häufigste Muster.

Copyright © 2001-2026 InLoox GmbH. Alle Rechte vorbehalten.