REST API: Файлдармен жұмыс

Planfix REST API файлдармен жұмыс істеуді қолдайды

• Қосу және жаңарту
• Файлдар тізімін алу

Қосу және жаңарту

API арқылы бұрын жүктеген файлдарыңызды қосуға немесе жаңартуға болады:

• Тапсырмалар
• Байланыстар
• Жобалар
• Каталогтар

Тапсырма

• Файлдар тек тапсырма сипаттамасына қосылады немесе жаңартылады.
• Тапсырма жасаған кезде файлдарды сипаттамаға қосыңыз:

• Тапсырма сипаттамасындағы файлдарды жаңарту:

Маңызды:

• Файлдар files параметрінде берілген файлдармен ауыстырылады.
• Егер бос өріс берілсе, файлдар тапсырмадан ажыратылады және басқа жерде қолданылмаса жойылады.
• Егер files өрісі берілмесе, файлдар жаңартылмайды.

Байланыс

• Файлдар тек байланыс сипаттамасына қосылады немесе жаңартылады.
• Байланыс жасаған кезде файлдарды сипаттамаға қосыңыз:

• Байланыс сипаттамасындағы файлдарды жаңарту:

Маңызды:

• Файлдар files параметрінде берілген файлдармен ауыстырылады.
• Егер бос өріс берілсе, файлдар байланыстан ажыратылады және басқа жерде қолданылмаса жойылады.
• Егер files өрісі берілмесе, файлдар жаңартылмайды.

Жоба

• Файлдар тек жоба құжаттарына қосылады немесе жаңартылады.
• Жоба жасаған кезде файлдарды тіркеңіз:

• Жобадағы файлдарды жаңарту:

Маңызды:

• Файлдар files параметрінде берілген файлдармен ауыстырылады.
• Егер бос өріс берілсе, файлдар жобадан алынады және басқа жерде қолданылмаса жойылады.
• Егер files өрісі берілмесе, файлдар жаңартылмайды.

Каталог

Planfix-та каталог жазбасына файл қосу екі қадамнан тұрады:

1. Файлды келесі REST API әдістерінің бірімен жүктеңіз:

• /file/ — Файлды жергілікті көзден жүктеу.
• /file/from-url/ — URL арқылы файлды жүктеу.

targetType параметрінің мәні ретінде directory жіберуді ұмытпаңыз.

Жауапта сіз жүктелген файлдың ID-ын аласыз.

2. Жаңа каталог жазбасын жасап, файлды "files" өрісіне қосыңыз.

Немесе бар каталогты жаңартыңыз

Маңызды:

• Жазбаны жаңартқанда файлдар value параметрінде берілген файлдармен ауыстырылады.

Файлдар тізімін алу

API арқылы файлдар тізімін алуға болады:

• Тапсырма
• Байланыс
• Жоба

Тапсырма

Әдісте onlyFromDescription деген параметр бар, ол файлдарды тек тапсырма сипаттамасынан алу мүмкіндігін береді:

Байланыс

Әдісте onlyFromDescription параметрі бар, оны тек байланыс сипаттамасынан файлдарды алу үшін қолдануға болады:

Жоба

Әдісте тізімді парақтап өту үшін pageSize және offset деген параметрлер бар:

Өту

• REST API
• API