ذخیره دادههای برنامه برای فایل یا پوشه
https://api.parsget.com/api/v1/files/{file}/stateبرای پیگیری درخواست در لاگها، یک شناسه بین ۱ تا ۱۰۰ کاراکتر بفرستید. اگر این هدر را نفرستید، سرور شناسه میسازد.
هدرهای استانداردبرای ذخیره دادههایی مثل موقعیت پخش ویدیو یا تنظیمات نمایش پوشه، یک شیء JSON در value بفرستید. این دادهها فقط در دسترس برنامه شما و همین کاربر هستند. برای هر فایل یا پوشه میتوانید تا ۶۴ KiB ذخیره کنید؛ این حجم از سهمیه فضای ذخیرهسازی برنامه کم نمیشود. فیلدهای داخل value را خودتان تعیین میکنید. هر درخواست PUT کل مقدار قبلی را جایگزین میکند؛ پس فیلدهایی را که میخواهید نگه دارید هم بفرستید.
اگر میخواهید تغییرات دستگاه دیگری ناخواسته بازنویسی نشود، ETag پاسخ قبلی را کامل در هدر If-Match بفرستید. اگر دادهها از آن زمان تغییر کرده باشد، پاسخ 412 میگیرید و چیزی ذخیره نمیشود. برای ذخیره فقط زمانی که هنوز دادهای وجود ندارد، If-None-Match: * بفرستید. قالب نامعتبر این هدرها پاسخ 400 دارد. بدون این هدرها، آخرین درخواست ذخیره، مقدار قبلی را جایگزین میکند.
با حذف فایل یا پوشه، پاکسازی آن پس از انقضا یا علامتگذاری آن برای حذف، دادههای مربوط به آن هم پاک میشود. این موضوع شامل فایلها و پوشههای حذفشده داخل پوشه نیز میشود. تغییر نام و جابهجایی، دادهها را حفظ میکند؛ اما کپی جدید یا فایل و پوشه بازیابیشده، دادههای قبلی را ندارد. لغو توکن بهتنهایی دادهها را پاک نمیکند.
Parameters
| Field | Type | Description |
|---|---|---|
file | string · pathrequired | شناسه یکتای فایل یا پوشه |
If-Match | string · headeroptional | ETag پاسخ قبلی را کامل بفرستید تا ذخیره فقط در صورت تغییر نکردن دادهها انجام شود. با *، ذخیره فقط در صورت وجود دادههای قبلی انجام میشود. |
If-None-Match | string · headeroptional | برای ایجاد فقط در صورت نبود دادهها، * بفرستید. |
Request body
| Field | Type | Description |
|---|---|---|
value | Record<string, any>required | — |
Response schema
object| Field | Type | Description |
|---|---|---|
value | Record<string, any> | دادههای دلخواه برنامه در قالب یک شیء JSON با حداکثر حجم ۶۴ KiB. فیلدهای داخل این شیء را خودتان تعیین میکنید. |
version | integermin 1 | — |
etag | string | برای ارسال If-Match، این مقدار را کامل و همراه با علامت نقلقول کپی کنید. ETag را از روی version نسازید. |
created_at | stringdate-time | — |
updated_at | stringdate-time | — |
file_id | string | — |
error