REST API: Praca z plikami
REST API Planfixa obsługuje pracę z plikami
Dołączanie i aktualizacja
Za pomocą API można dołączać lub aktualizować pliki, które zostały wcześniej przesłane:
Zadanie
- Pliki są dołączane lub aktualizowane tylko w opisie zadania.
- Dołącz pliki do opisu podczas tworzenia zadania:
- Zaktualizuj pliki w opisie zadania:
Ważne:
- Pliki zostaną zastąpione tymi przekazanymi w parametrze files.
- Jeśli zostanie przekazane puste pole, pliki zostaną odłączone od zadania i usunięte, jeśli nie są używane gdzie indziej.
- Jeśli pole files nie zostanie przekazane, pliki nie zostaną zaktualizowane.
Kontakt
- Pliki są dołączane lub aktualizowane tylko w opisie kontaktu.
- Dołącz pliki do opisu podczas tworzenia kontaktu:
- Zaktualizuj pliki w opisie kontaktu:
Ważne:
- Pliki zostaną zastąpione tymi przekazanymi w parametrze files.
- Jeśli zostanie przekazane puste pole, pliki zostaną odłączone od kontaktu i usunięte, jeśli nie są używane gdzie indziej.
- Jeśli pole files nie zostanie przekazane, pliki nie zostaną zaktualizowane.
Projekt
- Pliki są dołączane lub aktualizowane tylko w dokumentach projektu.
- Dołącz pliki podczas tworzenia projektu:
- Zaktualizuj pliki w projekcie:
Ważne:
- Pliki zostaną zastąpione tymi przekazanymi w parametrze files.
- Jeśli zostanie przekazane puste pole, pliki zostaną usunięte z projektu i skasowane, jeśli nie są używane gdzie indziej.
- Jeśli pole files nie zostanie przekazane, pliki nie zostaną zaktualizowane.
Katalog
Dodawanie pliku do wpisu w katalogu Planfix odbywa się w dwóch krokach:
1. Prześlij plik przy użyciu jednej z następujących metod REST API:
- /file/ — Prześlij plik z lokalnego źródła.
- /file/from-url/ — Prześlij plik z URL.
Upewnij się, że jako wartość parametru targetType przekazano directory.
W odpowiedzi otrzymasz ID przesłanego pliku.
2. Utwórz nowy wpis w katalogu i dodaj plik do pola "files".
Lub zaktualizuj istniejący wpis w katalogu
Ważne:
- Podczas aktualizacji wpisu pliki zostaną zastąpione tymi przekazanymi w parametrze value.
Pobieranie listy plików
Listę plików można uzyskać poprzez API:
Zadanie
Metoda ma parametr onlyFromDescription, który pozwala pobrać pliki tylko z opisu zadania:
Kontakt
Metoda ma parametr onlyFromDescription, który umożliwia pobranie plików tylko z opisu kontaktu:
Projekt
Metoda posiada parametry pageSize i offset do nawigacji po stronach listy:
