ファイルをアップロード

LegalOn API (1.3.1)

API documentation for LegalOn services

Servers

サーバーのURLは `{api_base_url}/rest/v1` です。アクセストークン取得時のレスポンスに含まれる `api_base_url` の値を用いてサーバーの URL を構成してください。

https://{api_base_url_without_scheme}/rest/v1

ユーザー

ユーザーに関する操作

Operations

ユーザーグループ

ユーザーグループに関する操作

Operations

ワークスペース

ユーザーの閲覧権限によらず、テナント内のすべてのワークスペース/フォルダに関する操作

Operations

部署

部署に関する操作

Operations

契約書（ファイル）

契約書の作成・取得・更新・削除などの操作を提供します。ワークスペースを対象とする操作では、共通の「ワークスペース」（GET /workspaces）で取得した workspace_id を指定してください。

Operations

案件

案件の作成、取得、更新、削除などの操作を提供します。案件の操作には、マターマネジメント Pro ライセンスを持つユーザーが所有する API クレデンシャルが必要です。

Operations

ファイル

LegalOn のリソースで利用するファイルを作成・管理します。

Operations

ファイルをアップロード

Request

概要

指定したワークスペースに汎用ファイルをアップロードし、ファイル ID を返します。

対象ファイル

対象は、LegalOnの動作環境の「■対応ファイル形式＞ ◇メールからマターマネジメントの案件に添付して取込み可能なファイル形式＞サポート対象外」に記載されていないファイル形式です。

制約

ファイル名は multipart の file part から取得します。

ファイルは100MiB以下とします。
ファイル名は拡張子を含む200文字以下とし、改行を含めず、先頭または末尾をピリオドにしないでください。

処理上の注意

アップロード後に、ファイルの拡張子と実体から検出したメディアタイプを検査します。いずれかが拒否対象の場合、このAPIが201を返した後でもファイルを削除します。
冪等性キーには対応していません。処理完了後に応答を受信できなかった場合、再送すると別のファイルが作成される可能性があります。

レスポンス

レスポンスの created_at は、API がファイル作成を完了してレスポンスを組み立てた時刻です。永続化時刻とは数秒程度ずれる場合があります。

関連API

ファイルは契約書または案件には紐付きません。POST /contracts/{document_id}/related-file-links で契約書、POST /matters/{matter_id}/related-file-links で案件に紐付けられます。同じファイルを両方に紐付けることもできます。

Security

OAuth2ClientCredentials

Bodymultipart/form-datarequired

汎用ファイルアップロードリクエスト。

workspace_idstring(uuid)required

保存先ワークスペース ID。

filestring(binary)required

ファイル本体。この part からファイル名を取得します。Content-Type を指定する場合は、構文上正しいメディアタイプを指定してください。不正な場合は415を返します。

curl -i -X POST \
  'https://{api_base_url_without_scheme}/rest/v1/files' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F workspace_id=00000000-0000-0000-0000-000000000003 \
  -F 'file=<binary file content>'

Responses

正常にファイルをアップロード

Bodyapplication/json

file_idstring(uuid)required

LegalOn が生成したファイル ID。

file_namestringnon-emptyrequired

ファイル名。

mime_typestringnon-emptyrequired

ファイルの MIME タイプ。

created_atstring(date-time)required

API がファイル作成を完了してレスポンスを組み立てた時刻。永続化時刻とは数秒程度ずれる場合があります。

Response

application/json

{
  "file_id": "00000000-0000-0000-0000-000000000040",
  "file_name": "nda.pdf",
  "mime_type": "application/pdf",
  "created_at": "2026-08-18T00:00:00Z"
}

ファイルを別のワークスペースへ移動

Request

指定したファイルを移動先のワークスペースへ移動します。移動結果に応じて、各ファイル ID を succeeded_file_ids または failed_file_ids に返します。

Security

OAuth2ClientCredentials

Bodyapplication/jsonrequired

destination_workspace_idstring(uuid)required

移動先のワークスペース ID

file_idsArray of strings(uuid)required

移動するファイル ID

curl -i -X POST \
  'https://{api_base_url_without_scheme}/rest/v1/files:move' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "destination_workspace_id": "00000000-0000-0000-0000-000000000003",
    "file_ids": [
      "00000016-0000-0000-0001-100000000001",
      "00000016-0000-0000-0001-100000000002"
    ]
  }'

Responses

要求を処理しました。ファイル ID を移動結果ごとに分けて返します。失敗理由は含まれません。

Bodyapplication/json

succeeded_file_idsArray of strings(uuid)required

移動に成功したファイル ID

failed_file_idsArray of strings(uuid)required

移動できなかったファイル ID

Response

application/json

{
  "succeeded_file_ids": [
    "00000016-0000-0000-0001-100000000001"
  ],
  "failed_file_ids": [
    "00000016-0000-0000-0001-100000000002"
  ]
}

ファイルを削除

Request

他のリソースから参照されている場合も、指定したファイルを削除できます。

Security

OAuth2ClientCredentials

Path

file_idstring(uuid)required

ファイル ID

curl -i -X DELETE \
  'https://{api_base_url_without_scheme}/rest/v1/files/{file_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

削除完了

Response

No content

ワークスペース

共通のワークスペース/フォルダは、契約書などのリソースを格納・整理する単位です。

Operations