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

案件に紐付いたファイル一覧を取得

Request

指定した案件に紐付いたファイルを取得します。

Security
OAuth2ClientCredentials
Path
matter_idstring(uuid)required

LegalOn が生成した案件 ID。

curl -i -X GET \
  'https://{api_base_url_without_scheme}/rest/v1/matters/{matter_id}/related-files' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

正常に紐付け済みファイル一覧を取得

Bodyapplication/json
filesArray of objects(MatterRelatedFile)required

案件に紐付いたファイル。

files[].​file_idstring(uuid)required

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

files[].​file_namestringnon-emptyrequired

ファイル名。

files[].​mime_typestringnon-empty

ファイルの MIME タイプ。保存済みファイルのメタデータに MIME タイプがない場合は省略します。

files[].​created_atstring(date-time)required

ファイルの作成日時。

Response
application/json
{ "files": [ { … } ] }

案件からファイルの紐付けを解除

Request

指定した案件とファイルの紐付けを解除します。ファイル自体は残ります。

Security
OAuth2ClientCredentials
Path
matter_idstring(uuid)required

LegalOn が生成した案件 ID。

related_file_idstring(uuid)required

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

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

Responses

正常にファイルの紐付けを解除

Response
No content

ファイル

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

Operations

ワークスペース

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

Operations