跳转到内容

प्रकल्प, टॅग आणि सामायिकरण

फाइल लायब्ररी हा संसाधनांचा अंतिम स्रोत आहे; प्रकल्प, टॅग आणि शोध हे त्यांचे व्यवस्थापन करणारे दृश्य आहेत. फाइल किंवा दस्तऐवज आयडी ठेवा; स्थिर ओळखकर्त्यांऐवजी नावांचा वापर करू नका.

GET /api/v1/projects
POST /api/v1/projects
GET /api/v1/projects/{project_id}
PATCH /api/v1/projects/{project_id}
DELETE /api/v1/projects/{project_id}
POST /api/v1/projects/{project_id}/documents
DELETE /api/v1/projects/{project_id}/documents/{document_id}

एखादे दस्तऐवज एका प्रकल्पामध्ये जोडल्याने केवळ त्याची संरचना बदलते: फाइलची प्रत तयार होत नाही आणि तिचा मालक बदलत नाही.

GET /api/v1/tags
POST /api/v1/tags
DELETE /api/v1/tags/{tag_id}
POST /api/v1/tags/documents/{document_id}
DELETE /api/v1/tags/documents/{document_id}/{tag_id}

टॅग नाव हे प्रदर्शनासाठी असते; डिलीट करणे, डिटॅच करणे आणि क्वेरी करणे यासाठी टॅग आयडी वापरली जाते.

GET /api/v1/search?q={query}&limit=20

शोध केवळ वर्तमान खाते वाचू शकतील असे दस्तऐवज आणि जॉब्स परत करतो. शोध हा वाचनासाठी असून त्यासाठी कोणतेही क्रेडिट लागत नाही.

GET /api/v1/shares
POST /api/v1/shares
GET /api/v1/shares/{token}
GET /api/v1/shares/{token}/download
DELETE /api/v1/shares/{token}

POST /shares हे अनुवादाच्या परिणामासाठी केवळ-वाचनयोग्य लिंक तयार करते; शरीरात artifact_id आणि एक पर्यायी expires_in_days (1–365; ते नसल्यास लिंकची मुदत संपत नाही) असते. लिंक धारण करणारी कोणतीही व्यक्ती डाउनलोड करू शकते, म्हणून ती लॉग आणि ऍनालिटिक्स पॅरामीटर्समधून वगळा आणि जेव्हा त्याची गरज भासणार नाही तेव्हा ती हटवा.

GET /api/v1/workspace/files
GET /api/v1/workspace/entries
GET /api/v1/workspace/apps

हे एंडपॉइंट OmniDoc खात्यासाठी एकत्रित कार्यक्षेत्र तयार करण्यासाठी आहेत. क्लायंटने प्रतिसादांमधील नोंदी आणि क्षमता पाळाव्यात आणि स्वतः अॅप URL तयार करू नये.