Skip to content

REST API: Fayllar bilan ishlash

Planfix REST API fayllar bilan ishlashni qo‘llab‑quvvatlaydi

Qo‘shish va yangilash

Siz API orqali avval yuklagan fayllarni qo‘shishingiz yoki yangilashingiz mumkin:

Vazifa

  • Fayllar faqatgina vazifa tavsifi ichida qo‘shiladi yoki yangilanadi.
  • Vazifa yaratishda fayllarni tavsifga qo‘shing:

8jd89h.png

  • Vazifa tavsifidagi fayllarni yangilang:

dTxTaM.png

Muhim:

  • Fayllar files parametrida uzatilganlari bilan almashtiriladi.
  • Agar bo‘sh maydon uzatilsa, fayllar vazifadan ajratiladi va boshqa joyda ishlatilmagan bo‘lsa o‘chiriladi.
  • Agar files maydoni uzatilmasa, fayllar yangilanmaydi.

Kontakt

  • Fayllar faqatgina kontakt tavsifi ichida qo‘shiladi yoki yangilanadi.
  • Kontakt yaratishda fayllarni tavsifga qo‘shing:

zRF6IB.png

  • Kontakt tavsifidagi fayllarni yangilang:

dejkxz.png

Muhim:

  • Fayllar files parametrida uzatilganlari bilan almashtiriladi.
  • Agar bo‘sh maydon uzatilsa, fayllar kontaktlardan ajratiladi va boshqa joyda ishlatilmagan bo‘lsa o‘chiriladi.
  • Agar files maydoni uzatilmasa, fayllar yangilanmaydi.

Loyiha

  • Fayllar faqatgina loyiha hujjatlari ichida qo‘shiladi yoki yangilanadi.
  • Loyiha yaratishda fayllarni qo‘shing:

EKGUPU.png

  • Loyihadagi fayllarni yangilang:

fsElGe.png

Muhim:

  • Fayllar files parametrida uzatilganlari bilan almashtiriladi.
  • Agar bo‘sh maydon uzatilsa, fayllar loyihadadan olib tashlanadi va boshqa joyda ishlatilmagan bo‘lsa o‘chiriladi.
  • Agar files maydoni uzatilmasa, fayllar yangilanmaydi.

Ma'lumotnoma

Planfixda ma'lumotnoma yozuviga fayl qo‘shish ikki bosqichni o‘z ichiga oladi:

1. Faylni quyidagi REST API metodlaridan biri yordamida yuklang:

  • /file/ — Lokal manbadan fayl yuklash.
  • /file/from-url/ — URL orqali fayl yuklash.

targetType parametr uchun qiymat sifatida directoryni uzatganingizga ishonch hosil qiling.

UHIi9I.png

Javobda yuklangan faylning IDsi qaytadi.

2. Yangi ma'lumotnoma yozuvini yarating va faylni "files" maydoniga qo‘shing.

XH7XwC.png

Yoki mavjud ma'lumotnoma yozuvini yangilang

0G5Oy1.png

Muhim:

  • Yozuvni yangilaganda, fayllar value parametrida uzatilganlari bilan almashtiriladi.

Fayllar ro‘yxatini olish

Siz API orqali fayllar ro‘yxatini olishingiz mumkin:

Vazifa

Metodda onlyFromDescription parametri mavjud bo‘lib, u orqali faqat vazifa tavsifidan fayllarni olish mumkin:

IpVMnG.png

Kontakt

Metodda onlyFromDescription parametri mavjud bo‘lib, u orqali faqat kontakt tavsifidan fayllarni olish mumkin:

PlMgOD.png

Loyiha

Metodda ro‘yxat bo‘ylab sahifalash uchun pageSize va offset parametrlari mavjud:

EmFu1e.png


O‘tish