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

契約書バージョンを削除

Request

指定した契約書バージョンを削除します。

Security
OAuth2ClientCredentials
Path
document_idstring(uuid)required

契約書 ID

document_version_idstring(uuid)required

契約書バージョンID

curl -i -X DELETE \
  'https://{api_base_url_without_scheme}/rest/v1/contracts/{document_id}/versions/{document_version_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

正常に契約書バージョンを削除

Response
No content

契約書以外の関連ファイルを契約書に紐付け

Request

既存の契約書以外の関連ファイルを、指定した契約書に紐付けます。関連ファイルはPOST /filesで作成でき、同じファイルを案件にも紐付けられます。

Security
OAuth2ClientCredentials
Path
document_idstring(uuid)required

契約書 ID

Bodyapplication/jsonrequired

既存ファイル関連付けリクエスト

related_file_idstring(uuid)required

紐付ける契約書以外の関連ファイル ID。成功レスポンスでは同じ ID を related_file_id として返し、紐付け解除時にもこの ID を使用する。

curl -i -X POST \
  'https://{api_base_url_without_scheme}/rest/v1/contracts/{document_id}/related-file-links' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "related_file_id": "00000016-0000-0000-0001-100000000301"
  }'

Responses

正常に既存ファイルを関連付け

Bodyapplication/json
document_idstring(uuid)required

契約書 ID

related_file_idstring(uuid)required

契約書以外の関連ファイル ID

Response
application/json
{ "document_id": "00000016-0000-0000-0001-100000000001", "related_file_id": "00000016-0000-0000-0001-100000000301" }

案件

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

Operations

ファイル

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

Operations

ワークスペース

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

Operations