メインコンテンツまでスキップ

Docwize パブリック API (Docwize Public API)

ドキュメント、フォルダをプログラムから管理し、ドキュメントリポジトリを検索できます。

ドキュメント

ファイルのアップロード、メタデータの取得、バージョンの管理、コンテンツのダウンロード、ドキュメントフィールドの更新を行います。

POSTGETPATCH

フォルダ

フォルダツリーの参照、新しいフォルダの作成、親フォルダ間の移動、サブツリー全体の削除を行います。

GETPOSTDEL

検索

全文キーワード検索、セマンティックベクトル類似検索、構造化クエリ DSL によるメタデータフィルタリングを行います。

POST

スキーマ検出

実行時に、カスタムフィールドテンプレート、列定義、一意のメタデータ値を列挙します。

GETPOST

クイックスタート​

# 1. Create an API key in Docwize (New > API KEY MANAGEMENT > API Key Management)
# 2. Copy the Bearer token — it is only shown once

# Upload a document
curl -X POST https://portal.docwize.com/apiv2/pub/documents/upload \
  -H "Authorization: Bearer <TOKEN>" \
  -F "file=@invoice.pdf" \
  -F "folder_id=42" \
  -F "description=January Invoice" \
  -F "doc_type=Invoice"

# Search your repository
curl -X POST https://portal.docwize.com/apiv2/pub/search \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"where": {"fts": {"field": "content", "query": "invoice"}}}'

エラーレスポンス​

すべてのエラーは、問題の内容を示す detail フィールドを含む JSON 本文を返します。

{"detail": "Document not found or access denied"}
ステータス意味
200リクエストが成功しました
400不正なリクエストです — フィールド名、型、または必須パラメータの不足を確認してください
401Bearer トークンが存在しない、期限切れ、または失効しています
403トークンに必要なスコープがないか、ユーザーが要求されたリソースにアクセスする権限を持っていません
404要求されたドキュメント、フォルダ、またはファイルが存在しないか、ユーザーに閲覧権限がありません
422リクエスト本文は構文的には正しいものの、意味的に誤っています（例：無効なフィールド値）
423ドキュメントが他のユーザーによってロックされており、変更できません
500予期しないサーバーエラーです — この問題は自動的に報告されます
504リクエストがタイムアウトしました — 検索フィルタを絞り込むか、ページサイズを小さくしてください

関連​