REST API: Práce se soubory
The REST API of Planfix supports working with files
Připojování a aktualizace
Pomocí API můžete připojovat nebo aktualizovat soubory, které jste dříve nahráli:
Úkol
- Soubory jsou připojovány nebo aktualizovány pouze v popisu úkolu.
- Připojte soubory k popisu při vytváření úkolu:
- Aktualizujte soubory v popisu úkolu:
Důležité:
- Soubory jsou nahrazeny těmi, které jsou předány v parametru files.
- Pokud je předáno prázdné pole, soubory jsou odpojeny od úkolu a smazány, pokud nejsou použity jinde.
- Pokud pole files není předáno, soubory nejsou aktualizovány.
Kontakt
- Soubory jsou připojovány nebo aktualizovány pouze v popisu kontaktu.
- Připojte soubory k popisu při vytváření kontaktu:
- Aktualizujte soubory v popisu kontaktu:
Důležité:
- Soubory jsou nahrazeny těmi, které jsou předány v parametru files.
- Pokud je předáno prázdné pole, soubory jsou odpojeny od kontaktu a smazány, pokud nejsou použity jinde.
- Pokud pole files není předáno, soubory nejsou aktualizovány.
Projekt
- Soubory jsou připojovány nebo aktualizovány pouze v dokumentech projektu.
- Připojte soubory při vytváření projektu:
- Aktualizujte soubory v projektu:
Důležité:
- Soubory jsou nahrazeny těmi, které jsou předány v parametru files.
- Pokud je předáno prázdné pole, soubory jsou z projektu odstraněny a smazány, pokud nejsou použity jinde.
- Pokud pole files není přenášeno, soubory nejsou aktualizovány.
Adresář
Přidání souboru do záznamu adresáře v Planfixu probíhá ve dvou krocích:
1. Nahrajte soubor pomocí jedné z následujících REST API metod:
- /file/ — Nahrát soubor z lokálního zdroje.
- /file/from-url/ — Nahrát soubor z URL.
Ujistěte se, že pro parametr targetType předáte hodnotu directory.
V odpovědi obdržíte ID nahraného souboru.
2. Vytvořte nový záznam adresáře a přidejte soubor do pole “files”.
Nebo aktualizujte existující záznam adresáře
Důležité:
- Při aktualizaci záznamu jsou soubory nahrazeny těmi, které jsou předány v parametru value.
Získání seznamu souborů
Seznam souborů lze získat přes API:
Úkol
Metoda má parametr onlyFromDescription, který umožňuje získat soubory pouze z popisu úkolu:
Kontakt
Metoda má parametr onlyFromDescription, kterým můžete získat soubory pouze z popisu kontaktu:
Projekt
Metoda má parametry pageSize a offset pro stránkování seznamu:
