Skip to content

REST API: Lucrul cu fișierele


API-ul REST al Planfix acceptă lucrul cu fișiere

Atașare și actualizare

Puteți folosi API-ul pentru a atașa sau actualiza fișierele pe care le-ați încărcat anterior:

Sarcină

  • Fișierele pot fi atașate sau actualizate numai în descrierea sarcinii.
  • Atașați fișiere la descriere atunci când creați o sarcină:

8jd89h.png

  • Actualizați fișierele din descrierea sarcinii:

dTxTaM.png

Important:

  • Fișierele sunt înlocuite cu cele transmise în parametrul files.
  • Dacă este transmis un câmp gol, fișierele sunt detașate de sarcină și șterse dacă nu sunt folosite în altă parte.
  • Dacă nu este transmis câmpul files, fișierele nu sunt actualizate.

Contact

  • Fișierele pot fi atașate sau actualizate numai în descrierea contactului.
  • Atașați fișiere la descriere atunci când creați un contact:

zRF6IB.png

  • Actualizați fișierele din descrierea contactului:

dejkxz.png

Important:

  • Fișierele sunt înlocuite cu cele transmise în parametrul files.
  • Dacă este transmis un câmp gol, fișierele sunt detașate de contact și șterse dacă nu sunt folosite în altă parte.
  • Dacă nu este transmis câmpul files, fișierele nu sunt actualizate.

Proiect

  • Fișierele pot fi atașate sau actualizate numai în documentele proiectului.
  • Atașați fișiere în timpul creării proiectului:

EKGUPU.png

  • Actualizați fișierele din proiect:

fsElGe.png

Important:

  • Fișierele sunt înlocuite cu cele transmise în parametrul files.
  • Dacă este transmis un câmp gol, fișierele sunt eliminate din proiect și șterse dacă nu sunt folosite în altă parte.
  • Dacă nu este transmis câmpul files, fișierele nu sunt actualizate.

Director

Adăugarea unui fișier la o înregistrare din Director în Planfix implică doi pași:

1. Încărcați fișierul folosind una dintre următoarele metode REST API:

  • /file/ — Încărcați un fișier dintr-o sursă locală.
  • /file/from-url/ — Încărcați un fișier de la o adresă URL.

Asigurați-vă că transmiteți directory ca valoare pentru parametrul targetType.

UHIi9I.png

În răspuns, veți primi ID-ul fișierului încărcat.

2. Creați o înregistrare nouă în Director și adăugați fișierul în câmpul „files”.

XH7XwC.png

Sau actualizați o înregistrare existentă din Director.

0G5Oy1.png

Important:

  • La actualizarea unei înregistrări, fișierele sunt înlocuite cu cele transmise în parametrul value.

Obținerea unei liste de fișiere

Puteți obține o listă de fișiere prin API:

Sarcină

Metoda are un parametru onlyFromDescription, care vă permite să obțineți numai fișierele din descrierea sarcinii:

IpVMnG.png

Contact

Metoda are un parametru onlyFromDescription, pe care îl puteți folosi pentru a obține numai fișierele din descrierea contactului:

PlMgOD.png

Proiect

Metoda are parametrii pageSize și offset pentru navigarea paginată prin listă:

EmFu1e.png


Mergeți la