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

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

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"
}

案件メッセージを作成

Request

概要

指定した案件に公開メッセージまたは非公開メッセージを作成します。任意で最大10件の新規ファイルを添付できます。

指定項目

新規ファイルはmultipart/form-dataのファイルパートにバイナリとして含めて送信してください。アップロードURL、ファイルパス、オブジェクトパスを取得・指定する必要はありません。

制約

  • 1ファイルあたり100MiB以下、合計200MiB以下とします。
  • いずれかのファイルの検証またはアップロードに失敗した場合、メッセージを作成せずにリクエスト全体が失敗します。

処理上の注意

  • 非公開メッセージにはセンシティブな情報が含まれる可能性があります。外部へ複製する場合は適切なアクセス制御を維持してください。
  • 冪等性キーには対応していません。処理完了後に応答を受信できなかった場合、再送前にメッセージが作成済みでないか確認してください。再送するとメッセージと添付ファイルが重複して作成される可能性があります。
Security
OAuth2ClientCredentials
Path
matter_idstring(uuid)required

LegalOn が生成した案件 ID。

Bodymultipart/form-datarequired

案件メッセージ作成リクエスト。

contentobject(MessageContent)required

構造化されたメッセージ本文。各 blocks 要素は指定順に段落として表示します。

テキストとメンション先ユーザーIDを合計した文字数は1文字以上4000文字以下です。

content.​blocksArray of objects(MessageContentBlock)non-emptyrequired

指定順に表示する段落。inlines が空のブロックは空行を表します。

content.​blocks[].​inlinesArray of objects(MessageContentInline)required

段落内のインライン要素。指定した順序で表示します。空行は空の配列で表します。

content.​blocks[].​inlines[].​typestringrequired

インライン要素の種類。

Enum"text""mention"
content.​blocks[].​inlines[].​textstring[ 1 .. 4000 ] characters

表示するテキスト。type が text の場合は必須、mention の場合は省略します。

content.​blocks[].​inlines[].​user_idstring(uuid)

メンションするユーザーについてLegalOnが生成したユーザーID。type が mention の場合は必須、text の場合は省略します。

content.​blocks[].​inlines[].​marksArray of strings(MessageInlineMarks)<= 3 itemsunique

インライン要素に適用する文字装飾。装飾しない場合は省略します。指定順に意味はありません。

Items Enum"bold""strikethrough""underline"
visibilitystring(MessageVisibility)required

メッセージに設定する公開範囲。指定できる値は public（公開メッセージ）または private（非公開メッセージ）です。

Enum"public""private"
filesArray of strings(binary)<= 10 items

新規アップロードするバイナリファイル。フォームフィールドは最大10回指定できます。

ファイル名と Content-Type は各 multipart/form-data のファイルパートから取得します。ファイル名やMIMEタイプを別のメタデータフィールドで指定したり、保存先のパスを指定したりすることはできません。

  • ファイル名は拡張子を含めて200文字以下とし、改行を含めず、先頭または末尾をピリオドにしないでください。
  • 対応拡張子は .pdf、.doc、.docx、.xls、.xlsx、.csv、.ppt、.pptx、.eml、.msg、.png、.gif、.jpg、.jpeg です。
  • Content-Type は POST /files と同じメディアタイプ規則に従って拡張子と一致させてください。
curl -i -X POST \
  'https://{api_base_url_without_scheme}/rest/v1/matters/{matter_id}/messages' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'content[blocks][0][inlines][0][type]=text' \
  -F 'content[blocks][0][inlines][0][text]=Please review ' \
  -F 'content[blocks][0][inlines][1][type]=mention' \
  -F 'content[blocks][0][inlines][1][user_id]=00000000-0000-0000-0000-000000000001' \
  -F 'content[blocks][0][inlines][1][marks]=bold' \
  -F 'content[blocks][0][inlines][2][type]=text' \
  -F 'content[blocks][0][inlines][2][text]=the latest revision.' \
  -F 'content[blocks][0][inlines][2][marks]=bold' \
  -F 'content[blocks][0][inlines][2][marks]=underline' \
  -F 'content[blocks][2][inlines][0][type]=text' \
  -F 'content[blocks][2][inlines][0][text]=Comments are welcome.' \
  -F visibility=public \
  -F 'files=<binary file content>'

Responses

正常にメッセージを作成

Bodyapplication/json
message_idstring(uuid)required

LegalOn が生成したメッセージ ID。

Response
application/json
{
  "message_id": "00000000-0000-0000-0000-000000000030"
}

ファイル

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

Operations

ワークスペース

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

Operations