REST-API: Arbeiten mit Dateien
Die REST API von Planfix unterstützen das Arbeiten mit Dateien
Anhängen und Aktualisieren
Sie können die API verwenden, um Dateien anzuhängen oder zu aktualisieren, die Sie zuvor hochgeladen haben:
Aufgabe
- Dateien werden nur in der Aufgabebeschreibung angehängt oder aktualisiert.
- Dateien an die Beschreibung anhängen beim Erstellen einer Aufgabe:
- Dateien in der Aufgabebeschreibung aktualisieren:
Wichtig:
- Dateien werden durch jene ersetzt, die im files-Parameter übergeben werden.
- Wenn ein leeres Feld übergeben wird, werden Dateien von der Aufgabe entfernt und gelöscht, falls sie nirgendwo sonst verwendet werden.
- Wenn das files-Feld nicht übergeben wird, werden die Dateien nicht aktualisiert.
Kontakt
- Dateien werden nur in der Kontaktbeschreibung angehängt oder aktualisiert.
- Dateien an die Beschreibung anhängen beim Erstellen eines Kontakts:
- Dateien in der Kontaktbeschreibung aktualisieren:
Wichtig:
- Dateien werden durch jene ersetzt, die im files-Parameter übergeben werden.
- Wenn ein leeres Feld übergeben wird, werden Dateien vom Kontakt entfernt und gelöscht, falls sie nirgendwo sonst verwendet werden.
- Wenn das files-Feld nicht übergeben wird, werden die Dateien nicht aktualisiert.
Projekt
- Dateien werden nur in den Projektdokumenten angehängt oder aktualisiert.
- Dateien beim Erstellen eines Projekts anhängen:
- Dateien im Projekt aktualisieren:
Wichtig:
- Dateien werden durch jene ersetzt, die im files-Parameter übergeben werden.
- Wenn ein leeres Feld übergeben wird, werden die Dateien aus dem Projekt entfernt und gelöscht, falls sie nirgendwo sonst verwendet werden.
- Wenn das files-Feld nicht übergeben wird, werden die Dateien nicht aktualisiert.
Verzeichnis
Das Hinzufügen einer Datei zu einem Verzeichniseintrag in Planfix umfasst zwei Schritte:
1. Laden Sie die Datei mit einer der folgenden REST-API-Methoden hoch:
- /file/ — Eine Datei aus einer lokalen Quelle hochladen.
- /file/from-url/ — Eine Datei von einer URL hochladen.
Achten Sie darauf, für den Parameter targetType den Wert directory zu übergeben.
In der Antwort erhalten Sie die ID der hochgeladenen Datei.
2. Erstellen Sie einen neuen Verzeichniseintrag und fügen Sie die Datei zum Feld „files“ hinzu.
Oder aktualisieren Sie ein bestehendes Verzeichnis
Wichtig:
- Beim Aktualisieren eines Eintrags werden die Dateien durch jene ersetzt, die im value-Parameter übergeben werden.
Dateiliste abrufen
Sie können über die API eine Liste von Dateien erhalten:
Aufgabe
Die Methode hat einen Parameter onlyFromDescription, mit dem Sie Dateien nur aus der Aufgabebeschreibung abrufen können:
Kontakt
Die Methode hat einen Parameter onlyFromDescription, mit dem Sie Dateien nur aus der Kontaktbeschreibung abrufen können:
Projekt
Die Methode hat die Parameter pageSize und offset zur Seitennavigation durch die Liste:
