Tovább a tartalomhoz

Projektek, címkék és megosztás

A fájltár a forrás, amelyből a erőforrásokat lekérdezhetők; a projektek, címkék és a keresés csak szemléltető nézetek. Tartsa meg a fájl- vagy dokumentumazonosítókat; ne használjon neveket a stabil azonosítók helyett.

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}

Egy dokumentum hozzáadása egy projekthez csak a szervezését változtatja meg: a fájl nem kerül másolásra, és a tulajdonosa sem változik.

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}

A címke név a megjelenítésre szolgál; a törlés, leválasztás és lekérdezés a címkeazonosítót használja.

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

A keresés csak azokat a dokumentumokat és munkákat jeleníti meg, amelyeket a jelenlegi fiók olvashat. A keresés olvasási művelet, ezért nem von le egyenlőre semmilyen hitelt.

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

A POST /shares csak olvasható hivatkozást hoz létre a fordítási eredményhez; a test tartalmazza a artifact_id-et és egy opcionális expires_in_days-ot (1–365; enélkül a hivatkozás nem jár le). A hivatkozás birtokosai letölthetik, ezért tartsa távol a naplóktól és az elemzőparamétereiktől, valamint törlje, ha már nincs rá szükség.

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

Ezek a végpontok egy OmniDoc fiókhoz tartozó egységes munkaterület kiépítésére szolgálnak. Az ügyfelek a válaszokban szereplő bejegyzéseket és képességeket kell, hogy kövessék, és ne építsenek saját alkalmazási URL-címeket.