API documentation for LegalOn services
LegalOn API (1.3.1)
Request
指定した案件に公開メッセージまたは非公開メッセージを作成します。任意で最大10件の新規ファイルを添付できます。
新規ファイルはmultipart/form-dataのファイルパートにバイナリとして含めて送信してください。アップロードURL、ファイルパス、オブジェクトパスを取得・指定する必要はありません。
- 1ファイルあたり100MiB以下、合計200MiB以下とします。
- いずれかのファイルの検証またはアップロードに失敗した場合、メッセージを作成せずにリクエスト全体が失敗します。
- 非公開メッセージにはセンシティブな情報が含まれる可能性があります。外部へ複製する場合は適切なアクセス制御を維持してください。
- 冪等性キーには対応していません。処理完了後に応答を受信できなかった場合、再送前にメッセージが作成済みでないか確認してください。再送するとメッセージと添付ファイルが重複して作成される可能性があります。
案件メッセージ作成リクエスト。
構造化されたメッセージ本文。各 blocks 要素は指定順に段落として表示します。
テキストとメンション先ユーザーIDを合計した文字数は1文字以上4000文字以下です。
指定順に表示する段落。inlines が空のブロックは空行を表します。
段落内のインライン要素。指定した順序で表示します。空行は空の配列で表します。
表示するテキスト。type が text の場合は必須、mention の場合は省略します。
メンションするユーザーについてLegalOnが生成したユーザーID。type が mention の場合は必須、text の場合は省略します。
メッセージに設定する公開範囲。指定できる値は public(公開メッセージ)または private(非公開メッセージ)です。
新規アップロードするバイナリファイル。フォームフィールドは最大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と同じメディアタイプ規則に従って拡張子と一致させてください。
- サーバーのURLは `{api_base_url}/rest/v1` です。
アクセストークン取得時のレスポンスに含まれる `api_base_url` の値を用いてサーバーの URL を構成してください。
https://{api_base_url_without_scheme}/rest/v1/matters/{matter_id}/messages
- cURL
- JavaScript
- Python
- Java
- Go
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>'{ "message_id": "00000000-0000-0000-0000-000000000030" }
案件メッセージ本文更新リクエスト。
構造化されたメッセージ本文。各 blocks 要素は指定順に段落として表示します。
テキストとメンション先ユーザーIDを合計した文字数は1文字以上4000文字以下です。
指定順に表示する段落。inlines が空のブロックは空行を表します。
段落内のインライン要素。指定した順序で表示します。空行は空の配列で表します。
表示するテキスト。type が text の場合は必須、mention の場合は省略します。
メンションするユーザーについてLegalOnが生成したユーザーID。type が mention の場合は必須、text の場合は省略します。
- サーバーのURLは `{api_base_url}/rest/v1` です。
アクセストークン取得時のレスポンスに含まれる `api_base_url` の値を用いてサーバーの URL を構成してください。
https://{api_base_url_without_scheme}/rest/v1/matters/{matter_id}/messages/{message_id}
- cURL
- JavaScript
- Python
- Java
- Go
curl -i -X PATCH \
'https://{api_base_url_without_scheme}/rest/v1/matters/{matter_id}/messages/{message_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"content": {
"blocks": [
{
"inlines": [
{
"type": "text",
"text": "Please review the revised draft with ",
"marks": [
"underline"
]
},
{
"type": "mention",
"user_id": "00000000-0000-0000-0000-000000000001"
}
]
}
]
}
}'- サーバーのURLは `{api_base_url}/rest/v1` です。
アクセストークン取得時のレスポンスに含まれる `api_base_url` の値を用いてサーバーの URL を構成してください。
https://{api_base_url_without_scheme}/rest/v1/matters/{matter_id}/messages/{message_id}
- cURL
- JavaScript
- Python
- Java
- Go
curl -i -X DELETE \
'https://{api_base_url_without_scheme}/rest/v1/matters/{matter_id}/messages/{message_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'