跳转到内容

Жобалар, тегтер және бөлісу

Файлдар кітапханасы ресурстардың шынайы дереккөзі болып табылады; жобалар, тегтер және іздеу — оларды ұйымдастыратын көріністер. Файл немесе құжат идентификаторларын сақтаңыз; тұрақты идентификаторлардың орнына атауларды қолданбаңыз.

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}

Тег атауы көрсетілім үшін қолданылады; жою, бөлу және сұрау операциялары тег ID-ін пайдаланады.

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

Іздеу нәтижесінде тек ағымдағы тіркелгі оқи алатын құжаттар мен жұмыстар көрсетіледі. Іздеу — оқу операциясы болып табылады және несие қажет етпейді.

Сілтемелерді бөлісіңіз

Section titled “Сілтемелерді бөлісіңіз”
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-дерін жасамауы тиіс.