REST API: Lavorare con i file
L'REST API di Planfix supporta il lavoro con i file
Allega e aggiorna
Puoi utilizzare l'API per allegare o aggiornare file che hai caricato in precedenza:
Task
- I file vengono allegati o aggiornati solo nella descrizione del task.
- Allega file alla descrizione durante la creazione di un task:
- Aggiorna i file nella descrizione del task:
Importante:
- I file vengono sostituiti con quelli passati nel parametro files.
- Se viene passato un campo vuoto, i file vengono staccati dal task e cancellati se non utilizzati altrove.
- Se il campo files non viene passato, i file non vengono aggiornati.
Contact
- I file vengono allegati o aggiornati solo nella descrizione del contact.
- Allega file alla descrizione durante la creazione di un contact:
- Aggiorna i file nella descrizione del contact:
Importante:
- I file vengono sostituiti con quelli passati nel parametro files.
- Se viene passato un campo vuoto, i file vengono staccati dal contact e cancellati se non utilizzati altrove.
- Se il campo files non viene passato, i file non vengono aggiornati.
Project
- I file vengono allegati o aggiornati solo nei documenti del project.
- Allega file durante la creazione del project:
- Aggiorna i file nel project:
Importante:
- I file vengono sostituiti con quelli passati nel parametro files.
- Se viene passato un campo vuoto, i file vengono rimossi dal project e cancellati se non utilizzati altrove.
- Se il campo files non viene trasferito, i file non vengono aggiornati.
Directory
Aggiungere un file a una voce dell'elenco (directory) in Planfix comporta due passaggi:
1. Carica il file usando uno dei seguenti metodi REST API:
- /file/ — Carica un file da una sorgente locale.
- /file/from-url/ — Carica un file da un URL.
Assicurati di passare directory come valore per il parametro targetType.
Nella risposta riceverai l'ID del file caricato.
2.Crea una nuova voce dell'elenco e aggiungi il file al campo “files”.
Oppure aggiorna una directory esistente
Importante:
- Quando si aggiorna una voce, i file vengono sostituiti da quelli passati nel parametro value.
Ottieni elenco dei file
Puoi ottenere un elenco di file tramite API:
Task
Il metodo dispone di un parametro onlyFromDescription, che permette di recuperare solo i file dalla descrizione del task:
Contact
Il metodo dispone di un parametro onlyFromDescription, che puoi utilizzare per recuperare solo i file dalla descrizione del contact:
Project
Il metodo dispone dei parametri pageSize e offset per la navigazione per pagina attraverso l'elenco:
