REST API: Lucrul cu fișierele
The REST API of Planfix supports working with files
Atașați și actualizați
You can use the API to attach or update files that you have previously uploaded:
Sarcină
- Fișierele sunt atașate sau actualizate numai în descrierea sarcinii.
- Atașați fișiere în descriere la crearea unei sarcini:
- Actualizați fișierele din descrierea sarcinii:
Important:
- Fișierele sunt înlocuite cu cele transmise în parametrul files.
- Dacă se transmite un câmp gol, fișierele sunt detașate de sarcină și șterse dacă nu sunt folosite în altă parte.
- Dacă câmpul files nu este transmis, fișierele nu sunt actualizate.
Contact
- Fișierele sunt atașate sau actualizate numai în descrierea contactului.
- Atașați fișiere în descriere la crearea unui contact:
- Actualizați fișierele din descrierea contactului:
Important:
- Fișierele sunt înlocuite cu cele transmise în parametrul files.
- Dacă se transmite un câmp gol, fișierele sunt detașate de contact și șterse dacă nu sunt folosite în altă parte.
- Dacă câmpul files nu este transmis, fișierele nu sunt actualizate.
Proiect
- Fișierele sunt atașate sau actualizate numai în documentele proiectului.
- Atașați fișiere în timpul creării proiectului:
- Actualizați fișierele din proiect:
Important:
- Fișierele sunt înlocuite cu cele transmise în parametrul files.
- Dacă se transmite un câmp gol, fișierele sunt eliminate din proiect și șterse dacă nu sunt folosite în altă parte.
- Dacă câmpul files nu este transferat, fișierele nu sunt actualizate.
Director
Adăugarea unui fișier la o înregistrare din director în Planfix implică două etape:
1. Încărcați fișierul folosind una dintre următoarele metode REST API:
- /file/ — Upload a file from a local source.
- /file/from-url/ — Upload a file from a URL.
Asigurați-vă că transmiteți directory ca valoare pentru parametrul targetType.
În răspuns veți primi ID-ul fișierului încărcat.
2. Creați o nouă înregistrare în director și adăugați fișierul în câmpul “files”.
Sau actualizați o înregistrare existentă
Important:
- La actualizarea unei înregistrări, fișierele sunt înlocuite cu cele transmise în parametrul value.
Obțineți lista de fișiere
You can obtain a list of files via API:
Sarcină
Metoda are un parametru onlyFromDescription, care vă permite să preluați fișiere doar din descrierea sarcinii:
Contact
Metoda are un parametru onlyFromDescription, pe care îl puteți folosi pentru a prelua fișiere doar din descrierea contactului:
Proiect
Metoda are parametrii pageSize și offset pentru navigarea pe pagini prin listă:
