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

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

Responses

正常に契約書を削除

Response
No content

契約書の最新版をアップロード

Request

指定した契約書に新しいバージョンを追加します。

  • 再送すると別のバージョンが追加される場合があります。
Security
OAuth2ClientCredentials
Path
document_idstring(uuid)required

契約書 ID

Bodymultipart/form-datarequired
filestring(binary)required

契約書バージョンのファイル。ファイル名とメディアタイプは multipart file part から取得します。

document_status_codestring(document_status_code)

締結前契約書の契約書ステータスコード。NONE は契約書ステータスなしを表す。

Enum"COUNTERPARTY_DRAFT""INTERNAL_DRAFT""COUNTERPARTY_REVISION""INTERNAL_REVISION""APPROVED_VERSION""READY_FOR_SIGNATURE""NONE"
curl -i -X POST \
  'https://{api_base_url_without_scheme}/rest/v1/contracts/{document_id}/versions' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string \
  -F document_status_code=COUNTERPARTY_DRAFT

Responses

バージョンを追加

Bodyapplication/json
document_version_idstring(uuid)required
Response
application/json
{
  "document_version_id": "00000016-0000-0000-0001-100000000102"
}

契約書バージョン一覧を取得

Request

指定した契約書の全バージョンをバージョン番号の昇順で取得します。

Security
OAuth2ClientCredentials
Path
document_idstring(uuid)required

契約書 ID

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

Responses

正常に契約書バージョン一覧を取得

Bodyapplication/json
document_idstring(uuid)required

契約書 ID

versionsArray of objects(contract_version_summary)required

契約書バージョン一覧

versions[].​document_version_idstring(uuid)required

契約書バージョンID

versions[].​version_numberinteger>= 1required

現在の契約書バージョン一覧におけるバージョン番号

versions[].​file_namestring[ 1 .. 255 ] charactersrequired

ファイル名

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

契約書バージョンの作成日時

versions[].​updated_atstring(date-time)required

契約書バージョンの更新日時

Response
application/json
{
  "document_id": "00000016-0000-0000-0001-100000000001",
  "versions": [
    { … },
    { … }
  ]
}

案件

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

Operations

ファイル

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

Operations

ワークスペース

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

Operations