Skip to content
/
ファイルを削除

LegalOn API (1.3.1)

API documentation for LegalOn services

Languages
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 を 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

ファイルのダウンロード URL を取得

Request

概要

指定したファイルの短期有効な署名付き URL を返します。

処理上の注意

  • file_version_id を省略すると最新版を対象にします。
  • URL はアクセス権限を持つ情報です。速やかに利用し、ログへの記録や共有を避けてください。
  • API は有効期限を保証値として返しません。
Security
OAuth2ClientCredentials
Path
file_idstring(uuid)required

ファイル ID

Query
file_version_idstring(uuid)

ファイルバージョン ID。省略すると最新版を対象にします。

curl -i -X GET \
  'https://{api_base_url_without_scheme}/rest/v1/files/{file_id}:download?file_version_id=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

正常にダウンロード URL を取得

Bodyapplication/json
file_namestringrequired

対象バージョンの拡張子を含むファイル名。取得した内容を保存する際に使用してください。

Example: "contract.docx"
urlstring(uri)required

署名付きダウンロード URL。

  • この値をログに出したり、第三者と共有したりしないでください。
Example: "https://storage.example.com/signed-download-url"
Response
application/json
{
  "file_name": "contract.docx",
  "url": "https://storage.example.com/signed-download-url"
}

ワークスペース

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

Operations