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

テナントに設定された定義を返します。レスポンスの順序は 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": [
    { … }
  ]
}

契約カスタム項目の値を更新

Request

1〜50 件の値を1回のリクエストで更新します。指定しない定義は維持します。定義を指定して text_value を省略すると値をクリアします。未知の ID が含まれる場合はリクエスト全体を拒否し、値は更新しません。

Security
OAuth2ClientCredentials
Path
document_idstring(uuid)required

契約書 ID。

Bodyapplication/jsonrequired
custom_attributesArray of objects(ContractCustomAttributePatch)[ 1 .. 50 ] itemsrequired
custom_attributes[].​setting_idstring(uuid)required

定義 ID。

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

更新するテキスト値。省略すると値をクリアする。

curl -i -X PATCH \
  'https://{api_base_url_without_scheme}/rest/v1/contracts/{document_id}/custom-attributes' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_attributes": [
      {
        "setting_id": "a85785e9-b0c4-4f26-bdb1-2832c57d90d8",
        "text_value": "string"
      }
    ]
  }'

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