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

案件

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

Operations

案件を更新

Request

概要

案件の基本項目、依頼者、依頼部署、案件ステータス、主・副担当者、カスタム項目を1回のリクエストで部分更新します。

処理上の注意

  • 依頼者を指定した場合は有効なユーザーを優先し、該当しない場合は既存ゲストの再利用または新規作成を行います。
  • 依頼者を省略した場合は既存の依頼者を保持し、その他の省略した項目も変更しません。
Security
OAuth2ClientCredentials
Path
matter_idstring(uuid)required

LegalOn が生成した案件 ID。

Bodyapplication/jsonrequired

案件部分更新リクエスト。

non-empty
titlestring[ 1 .. 200 ] characters

案件名。

overviewstring[ 1 .. 4000 ] characters

案件概要。

matter_typestring

案件タイプ。

Enum"other""legal_request""contract_review""contract_drafting"
due_datestring or null(date-time)

納期。null を指定すると解除し、省略すると変更しません。

status_idstring(uuid)

設定する案件ステータス。

requesterobject(RequesterInput)

メールアドレスと氏名で指定する依頼者。ユーザーまたはゲストのIDは直接指定できません。

requesting_department_idstring or null(uuid)

設定する依頼部署。null を指定すると解除します。

main_assignee_idstring or null(uuid)

主担当者のユーザー ID。null を指定すると主担当者を解除します。

sub_assignee_idsArray of strings(uuid)<= 30 itemsunique

副担当者のユーザー ID の全量。

  • 空配列を指定するとすべて解除します。
  • 同じユーザー ID は重複して指定できません。
custom_attributesArray of objects(MatterCustomAttributePatch)[ 1 .. 50 ] items

更新するカスタム項目。

  • 指定しない定義は変更しません。
  • 同じ定義 ID は重複して指定できません。
curl -i -X PATCH \
  'https://{api_base_url_without_scheme}/rest/v1/matters/{matter_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Review mutual NDA",
    "due_date": null,
    "status_id": "00000000-0000-0000-0000-000000000002",
    "requester": {
      "email": "requester@example.com",
      "name": "Request User"
    },
    "main_assignee_id": "00000000-0000-0000-0000-000000000004",
    "sub_assignee_ids": [
      "00000000-0000-0000-0000-000000000005"
    ],
    "custom_attributes": [
      {
        "custom_attribute_definition_id": "00000000-0000-0000-0000-000000000010",
        "text_value": "High priority"
      }
    ]
  }'

Responses

正常に案件を更新

Response
No content

案件を削除

Request

指定した案件を削除します。

Security
OAuth2ClientCredentials
Path
matter_idstring(uuid)required

LegalOn が生成した案件 ID。

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

Responses

正常に案件を削除

Response
No content

タイムライン項目を取得

Request

概要

指定した案件のタイムライン項目をページングして取得します。初期対応するイベント種別は message です。visibility を省略した場合は公開メッセージだけを返します。 レスポンスはイベントエンベロープ形式です。トップレベルのタイムライン項目構造を変更せずにイベント種別を追加できます。

指定項目

page_token、visibility、page_sizeで取得範囲とページングを指定できます。各項目の詳細はパラメータの説明を参照してください。

制約

  • 案件が存在しない場合は404、存在する案件を呼び出し元が閲覧できない場合は403を返します。
  • 添付ファイル情報はレスポンスに含まれません。

処理上の注意

非公開メッセージにはセンシティブな情報が含まれる可能性があります。visibility に private または all を指定する場合は、外部での保存・転送に適切なアクセス制御を適用し、意図しない共有を防いでください。

関連API

メッセージを作成する場合は、POST /matters/{matter_id}/messagesを使用します。

Security
OAuth2ClientCredentials
Path
matter_idstring(uuid)required

LegalOn が生成した案件 ID。

Query
visibilitystring(MessageVisibilityFilter)

取得するメッセージの公開範囲。未指定時は public（公開メッセージ）です。

Default "public"
Enum"public""private""all"
page_sizeinteger[ 1 .. 100 ]

1ページあたりに返却するタイムライン項目数。

Default 50
page_tokenstring[ 1 .. 4096 ] characters

前または次のページを取得するための不透明なトークン。

curl -i -X GET \
  'https://{api_base_url_without_scheme}/rest/v1/matters/{matter_id}/timeline-items?visibility=public&page_size=50&page_token=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

正常にタイムラインを取得

Bodyapplication/json
timeline_itemsArray of objects(TimelineItem)required

指定した公開範囲に一致するタイムライン項目。

timeline_items[].​event_typestring(TimelineEventType)required

公開タイムラインイベントの種別。TimelineItem のエンベロープを変更せずにイベント種別を追加できます。

Value"message"
timeline_items[].​eventobject(TimelineItemEvent)= 1 propertyrequired

イベント固有のタイムライン内容。event_type に対応する項目を設定します。初期対応イベントでは message を使用します。

timeline_items[].​event.​messageobject(MessageTimelineEvent)

メッセージイベント（message）の公開内容。未削除の場合は content、author、is_edited を返し、削除済みの場合は省略します。

このAPIでは添付ファイル情報を返しません。

total_sizeinteger>= 0required

一致したタイムライン項目の総数。

next_page_tokenstring[ 1 .. 4096 ] characters

次のページを取得するためのトークン。次のページがない場合は省略します。

prev_page_tokenstring[ 1 .. 4096 ] characters

前のページを取得するためのトークン。前のページがない場合は省略します。

Response
application/json
{
  "timeline_items": [
    { … }
  ],
  "total_size": 1,
  "next_page_token": "eyJjYXNlX3RpbWVsaW5lX2V2ZW50X2lkIjoiMDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDMwIiwidHlwZSI6Im5leHQifQ"
}

ファイル

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

Operations

ワークスペース

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

Operations