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

契約書ファイルをアップロードして、指定したワークスペース/フォルダに契約書を作成します。AI解析（メタデータ抽出・プレビュー生成）は非同期で実行されます。

Security
OAuth2ClientCredentials
Bodymultipart/form-datarequired

契約書作成リクエスト。document_status_code を未指定にすると契約書ステータスなしで作成する。これは NONE を指定した場合と同義。

workspace_idstring(uuid)required

保存先ワークスペース/フォルダID

contract_file_typestring(contract_file_type)required

アップロードする契約書種別

Enum"PRE_EXECUTION""EXECUTED"
document_status_codestring(document_status_code)

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

Enum"COUNTERPARTY_DRAFT""INTERNAL_DRAFT""COUNTERPARTY_REVISION""INTERNAL_REVISION""APPROVED_VERSION""READY_FOR_SIGNATURE""NONE"
filestring(binary)required

契約書ファイル本体

curl -i -X POST \
  'https://{api_base_url_without_scheme}/rest/v1/contracts' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F workspace_id=00000023-0000-0000-0001-000000000020 \
  -F contract_file_type=PRE_EXECUTION \
  -F document_status_code=INTERNAL_DRAFT \
  -F 'file=<binary file content>'

Responses

正常に契約書を作成

Bodyapplication/json
document_idstring(uuid)required

契約書 ID

document_version_idstring(uuid)required

契約書バージョンID

workspace_idsArray of strings(uuid)required

契約書が所属するワークスペース/フォルダID

document_processing_statusstring(document_processing_status)required

契約書処理ステータス

Enum"PROCESSING""READY""REJECTED""FAILED""SKIPPED"
preview_statusstring(preview_status)required

プレビュー利用可否ステータス

Enum"PROCESSING""READY""NOT_AVAILABLE""FAILED"
Response
application/json
{
  "document_id": "00000016-0000-0000-0001-100000000001",
  "document_version_id": "00000016-0000-0000-0001-100000000101",
  "workspace_ids": [
    "00000023-0000-0000-0001-000000000020"
  ],
  "document_processing_status": "PROCESSING",
  "preview_status": "PROCESSING"
}

契約カスタム項目定義一覧を取得

Request

テナントに設定された定義を返します。レスポンスの順序は Contract Management の設定一覧に従います。

Security
OAuth2ClientCredentials
curl -i -X GET \
  'https://{api_base_url_without_scheme}/rest/v1/contracts/custom-attribute-definitions' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

正常に一覧を取得

Bodyapplication/json
custom_attribute_definitionsArray of objects(ContractCustomAttributeDefinition)required
custom_attribute_definitions[].​setting_idstring(uuid)required

定義 ID。

custom_attribute_definitions[].​display_namestring[ 1 .. 50 ] charactersrequired

表示名。

custom_attribute_definitions[].​typestringrequired

項目の値型。

Value"single_line_text"
custom_attribute_definitions[].​is_automatic_extractionbooleanrequired

値を自動抽出するか。

custom_attribute_definitions[].​descriptionstring

項目の説明。

custom_attribute_definitions[].​formatstring

自動抽出時の出力形式。

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

契約カスタム項目の値を取得

Request

指定した契約書のカスタム項目値を返します。未入力の値は省略します。

Security
OAuth2ClientCredentials
Path
document_idstring(uuid)required

契約書 ID。

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

Responses

正常に取得

Bodyapplication/json
custom_attributesArray of objects(ContractCustomAttribute)required
custom_attributes[].​setting_idstring(uuid)required

定義 ID。

custom_attributes[].​text_valuestring[ 1 .. 300 ] characters

テキスト値。値が空の場合は省略する。

custom_attributes[].​processing_statusstring

自動抽出状態。

Enum"completed""failed""processing""not_applicable"
Response
application/json
{
  "custom_attributes": [
    { … }
  ]
}

案件

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

Operations

ファイル

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

Operations

ワークスペース

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

Operations