契約管理項目を更新

ユーザー

ユーザーに関する操作

Operations

ユーザーグループ

ユーザーグループに関する操作

Operations

ワークスペース

ユーザーの閲覧権限によらず、テナント内のすべてのワークスペース/フォルダに関する操作

Operations

部署

部署に関する操作

Operations

契約書（ファイル）

契約書の作成・取得・更新・削除などの操作を提供します。ワークスペースを対象とする操作では、共通の「ワークスペース」（GET /workspaces）で取得した workspace_id を指定してください。

Operations

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

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": [
    { … }
  ]
}

契約管理項目を更新

Request

指定した契約管理項目だけを更新します。省略した項目は変更しません。空文字または空配列を指定すると、その項目をクリアします。

Security

OAuth2ClientCredentials

Path

document_idstring(uuid)required

契約書 ID

Bodyapplication/jsonrequired

non-empty

management_numberstring<= 50 characters

管理番号。空文字を指定すると値をクリアします。

voucher_idsArray of strings<= 10 items

伝票番号。空配列を指定すると値をクリアします。

contract_assigneesArray of objects<= 50 items

契約担当者。空配列を指定すると担当者をクリアします。

curl -i -X PATCH \
  'https://{api_base_url_without_scheme}/rest/v1/contracts/{document_id}/management-attributes' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "management_number": "CN-2026-001",
    "voucher_ids": [
      "V-001",
      "V-002"
    ],
    "contract_assignees": [
      {
        "id": "00000000-0000-0000-0000-000000000001",
        "assignee_type": "user"
      }
    ]
  }'

Responses

更新完了

Response

No content

契約書情報を取得

Request

指定した契約書情報の詳細を取得します。

Security

OAuth2ClientCredentials

Path

document_idstring(uuid)required

契約書 ID

Query

document_version_idstring(uuid)

取得対象のバージョンID。未指定時は最新バージョンを返す。

curl -i -X GET \
  'https://{api_base_url_without_scheme}/rest/v1/contracts/{document_id}?document_version_id=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

正常に契約書情報を取得

Bodyapplication/json

document_idstring(uuid)required

契約書 ID

document_version_idstring(uuid)required

契約書バージョンID

file_namestring[ 1 .. 255 ] charactersrequired

契約書ファイル名

mime_typestring[ 1 .. 255 ] charactersrequired

契約書ファイルのMIMEタイプ

workspace_idsArray of strings(uuid)required

この契約書を含むワークスペース/フォルダ

created_atstring(date-time)required

契約書作成日時

updated_atstring(date-time)required

契約書最終更新日時

document_processing_statusstring(document_processing_status)required

契約書処理ステータス

Enum"PROCESSING""READY""REJECTED""FAILED""SKIPPED"

preview_statusstring(preview_status)required

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

Enum"PROCESSING""READY""NOT_AVAILABLE""FAILED"

metadata_extraction_statusesobject(metadata_extraction_statuses)required

項目単位のメタデータ抽出ステータス。現在の内部データソースで利用できない項目は省略する。

metadata_extraction_statuses.title_statusstring(metadata_extraction_status)

項目単位のメタデータ抽出ステータス