API docs by Redocly

MNTSQ Public API (0.0.1)

Download OpenAPI specification:

MNTSQ CLM Public API Documentation

Matter

Operations about Matters

getV1Matter

案件一覧を取得

query Parameters
matter_number
string

案件番号で絞り込み（完全一致）。省略時は絞り込みなし

matter_uid
string

案件UIDで絞り込み（完全一致）。省略時は絞り込みなし

status_type
string

ステータスタイプ（カンマ区切りでOR結合）。省略時は絞り込みなし

status_labels
string

ステータスラベル（カンマ区切りでOR結合）。省略時は絞り込みなし

updated_from
string <date>

最終更新日(from)。省略時は下限なし

updated_to
string <date>

最終更新日(to)。省略時は上限なし

creator_email
string

作成者メールアドレス（カンマ区切りでOR結合）。省略時は絞り込みなし

q_attributes[][query]
Array of strings
Example: q_attributes[][query]=検索キーワード

検索キーワード（q_attributes指定時は必須）

q_attributes[][column_name]
Array of strings
Example: q_attributes[][column_name]=契約種別

カラム名（1行テキスト(string)/複数行テキスト(free_text)型のみ）。未指定時は標準フィールド（案件番号、タイトル、説明、コメント）を検索

matter_custom_column_term_filters[][column_name]
Array of strings
Example: matter_custom_column_term_filters[][column_name]=契約区分

カラム名（複数選択(multi_select)/単一選択(single_select)/リスト選択(list)/リスト入力(list_single)/確認チェック(boolean)型のみ）（matter_custom_column_term_filters指定時は必須）

matter_custom_column_term_filters[][query]
Array of strings
Example: matter_custom_column_term_filters[][query]="スペース 含む" オプションB

検索値（選択肢はスペース区切り、スペースを含むラベルはクオートで囲む。確認チェック(boolean)はtrue/false）（matter_custom_column_term_filters指定時は必須）

matter_custom_column_range_filters[][column_name]
Array of strings
Example: matter_custom_column_range_filters[][column_name]=契約期間

カラム名（日付範囲(date_range)/数値(number)/日付(date)型のみ）（matter_custom_column_range_filters指定時は必須）

matter_custom_column_range_filters[][range_part]
Array of strings
Items Enum: "from" "to"
Example: matter_custom_column_range_filters[][range_part]=from

日付範囲(date_range)型のみ必須。"from" または "to"

matter_custom_column_range_filters[][gte]
Array of strings
Example: matter_custom_column_range_filters[][gte]=2024-01-01

下限値（以上）（gte/lteいずれか必須）

matter_custom_column_range_filters[][lte]
Array of strings
Example: matter_custom_column_range_filters[][lte]=2024-12-31

上限値（以下）（gte/lteいずれか必須）

sort_by
string
Default: "updated_at"
Enum: "created_at" "updated_at" "last_actioned_at" "deadline_date"

ソート対象

sort_option
string
Default: "desc"
Enum: "asc" "desc"

昇順・降順

page
integer <int32>
Default: 1

ページ番号

per
integer <int32>
Default: 20

1ページあたり件数(最大100)

Responses

Response samples

Content type
application/json
{
  • "matters": [
    ],
  • "stats": {
    }
}

postV1Matter

案件を新規作成

Request Body schema: multipart/form-data
required
form
required
string

案件フォーム名。案件フローが有効なフォームは指定できません

title
required
string

案件タイトル

description
required
string

案件説明

deadline_date
string <date>

期限日（YYYY-MM-DD形式）。省略時は期限なし

requested_at
string <date-time>

依頼日時（ISO 8601形式）。省略時は案件作成日時が設定される

requester_users[]
Array of strings

依頼者(ユーザー)のメールアドレス一式。requester_user_groupsとともに省略時はAPI実行ユーザーが依頼者として設定

responsible_users[]
Array of strings

担当者(ユーザー)のメールアドレス一式。指定時は案件フォームの初期担当者に加えて追加される。省略時は案件フォームの初期担当者のみが設定される（初期担当者が未設定の場合は担当者なし）

related_users[]
Array of strings

関係者(ユーザー)のメールアドレス一式。指定時は案件フォームの初期関係者に加えて追加される。省略時は案件フォームの初期関係者のみが設定される（初期関係者が未設定の場合は関係者なし）

viewer_users[]
Array of strings

閲覧者(ユーザー)のメールアドレス一式。省略時は閲覧者なし

requester_user_groups[]
Array of strings

依頼者(グループ)の識別子一式。requester_usersとともに省略時はAPI実行ユーザーが依頼者として設定

responsible_user_groups[]
Array of strings

担当者(グループ)の識別子一式。指定時は案件フォームの初期担当者グループに加えて追加される。省略時は案件フォームの初期担当者グループのみが設定される（初期担当者グループが未設定の場合は担当者グループなし）

related_user_groups[]
Array of strings

関係者(グループ)の識別子一式。指定時は案件フォームの初期関係者グループに加えて追加される。省略時は案件フォームの初期関係者グループのみが設定される（初期関係者グループが未設定の場合は関係者グループなし）

viewer_user_groups[]
Array of strings

閲覧者(グループ)の識別子一式。省略時は閲覧者グループなし

custom_values[][name]
required
Array of strings

カスタム項目名（案件フォームで定義された項目名）

custom_values[][value]
Array of strings

カスタム項目値（単一値）。選択肢型以外はこちらを使用

custom_values[][values][]
Array of strings

カスタム項目値配列（選択肢型で複数選択する場合、または日付範囲型で使用）。

Responses

Response samples

Content type
application/json
{
  • "matter_uid": "76b5628b387140e29d2cd677373b934b"
}

putV1MatterMatterUid

案件を更新

path Parameters
matter_uid
required
string
Example: 76b5628b387140e29d2cd677373b934b

案件UID（案件の一意識別子）

Request Body schema: multipart/form-data
title
string

案件タイトル。省略時は変更なし

description
string

案件説明。省略時は変更なし

status
string

ステータスラベル。案件フロー有効時は自由遷移可能なステータスのみ指定可能。省略時は変更なし

deadline_date
string <date>

期限日（YYYY-MM-DD形式）。省略時は変更なし

requested_at
string <date-time>

依頼日時（ISO 8601形式）。省略時は変更なし

requester_users[]
Array of strings

依頼者(ユーザー)のメールアドレス一式。指定すると既存の依頼者を置き換え。省略時は既存の依頼者を維持

responsible_users[]
Array of strings

担当者(ユーザー)のメールアドレス一式。指定すると既存の担当者を置き換え。省略時は既存の担当者を維持

related_users[]
Array of strings

関係者(ユーザー)のメールアドレス一式。指定すると既存の関係者を置き換え。省略時は既存の関係者を維持

viewer_users[]
Array of strings

閲覧者(ユーザー)のメールアドレス一式。指定すると既存の閲覧者を置き換え。省略時は既存の閲覧者を維持

requester_user_groups[]
Array of strings

依頼者(グループ)の識別子一式。指定すると既存の依頼者グループを置き換え。省略時は既存の依頼者グループを維持

responsible_user_groups[]
Array of strings

担当者(グループ)の識別子一式。指定すると既存の担当者グループを置き換え。省略時は既存の担当者グループを維持

related_user_groups[]
Array of strings

関係者(グループ)の識別子一式。指定すると既存の関係者グループを置き換え。省略時は既存の関係者グループを維持

viewer_user_groups[]
Array of strings

閲覧者(グループ)の識別子一式。指定すると既存の閲覧者グループを置き換え。省略時は既存の閲覧者グループを維持

custom_values[][name]
required
Array of strings

カスタム項目名（案件フォームで定義された項目名）

custom_values[][value]
Array of strings

カスタム項目値（単一値）。選択肢型以外はこちらを使用。

custom_values[][values][]
Array of strings

カスタム項目値配列（選択肢型で複数選択する場合、または日付範囲型で使用）。

Responses

Response samples

Content type
application/json
{
  • "matter_uid": "string",
  • "title": "string",
  • "description": "string",
  • "matter_status_label": "string",
  • "deadline_date": "2019-08-24",
  • "custom_values": [
    ],
  • "custom_values_truncated": true,
  • "requester_users": [
    ],
  • "requester_user_groups": [
    ],
  • "responsible_users": [
    ],
  • "responsible_user_groups": [
    ],
  • "related_users": [
    ],
  • "related_user_groups": [
    ],
  • "viewer_users": [
    ],
  • "viewer_user_groups": [
    ]
}

deleteV1MatterMatterUid

案件を削除

path Parameters
matter_uid
required
string

案件UID

Responses

MatterDocument

Operations about MatterDocuments

getV1MatterMatterUidDocuments

案件のドキュメント一覧を取得

path Parameters
matter_uid
required
string

案件UID（32文字）

query Parameters
version_tag_name
string

バージョンタグ名（完全一致）。省略時は全バージョンタグのドキュメントを返却

page
integer <int32> >= 1
Default: 1

ページ番号

per
integer <int32> [ 1 .. 100 ]
Default: 20

1ページあたりの件数（最大100）

Responses

Response samples

Content type
application/json
{
  • "documents": [
    ],
  • "stats": {
    }
}

FileDownload

Operations about FileDownloads

getV1FiledownloadDocumentUid

ファイルダウンロード

path Parameters
document_uid
required
string

ドキュメントUID（32文字）

query Parameters
type
string
Default: "original"
Enum: "original" "raw"

original: 処理済み/復号化済みファイル, raw: アップロード時の元ファイル。省略時はoriginal

Responses

MatterAttachmentDocument

Operations about MatterAttachmentDocuments

postV1MatterAttachmentDocumentFileuploads

案件にファイルをアップロード

Request Body schema: multipart/form-data
required
matter_uid
required
string

案件UID (32文字)

file
required
string <binary>

アップロードするファイル

version_group_document_uid
string

既存ドキュメントのUID（このドキュメントのバージョングループに追加する場合に指定）。省略時は新規ドキュメントとしてアップロード

version_tag_name
string

バージョンタグ名（例: "Fix版", "決済版"）。省略時はバージョンタグなし

title
string

ドキュメントタイトル（省略時はファイル名を使用）

original_filename
string

添付ファイルのファイル名（%エンコーディング対策用）。省略時はmultipartのファイル名を使用

Responses

Response samples

Content type
application/json
{
  • "document_uid": "string",
  • "file_name": "string",
  • "content_type": "string",
  • "uploaded_at": "2019-08-24T14:15:22Z",
  • "version": {
    }
}

SPO

Operations about SPOs

getV1ConnectSpoAuthCredential

SPO認証情報一覧を取得

query Parameters
limit
integer <int32>
Example: limit=20

取得件数

entity_uid
string
Example: entity_uid=a1b2c3d4e5f67890a1b2c3d4e5f67890

Entity UID (32文字)

Responses

postV1ConnectSpoAuthCredential

SPO認証情報を作成

Request Body schema: application/json
required
ms_tenant_id
required
string

Microsoft Tenant ID

client_id
required
string

Client ID

client_secret
required
string

Client Secret

Responses

Request samples

Content type
application/json
{
  • "ms_tenant_id": "12345678-1234-1234-1234-123456789012",
  • "client_id": "abcdef12-3456-7890-abcd-ef1234567890",
  • "client_secret": "your-client-secret-value"
}

getV1ConnectSpoAuthCredentialSpoAuthCredentialUid

SPO認証情報詳細を取得

path Parameters
spo_auth_credential_uid
required
string
Example: a1b2c3d4e5f67890a1b2c3d4e5f67890

SPO認証情報UID (32文字)

Responses

putV1ConnectSpoAuthCredentialSpoAuthCredentialUid

SPO認証情報を更新

path Parameters
spo_auth_credential_uid
required
string
Example: a1b2c3d4e5f67890a1b2c3d4e5f67890

SPO認証情報UID (32文字)

Request Body schema: application/json
required
ms_tenant_id
string

Microsoft Tenant ID (最大255文字)

client_id
string

Client ID (最大255文字)

client_secret
string

Client Secret (最大255文字)

Responses

Request samples

Content type
application/json
{
  • "ms_tenant_id": "12345678-1234-1234-1234-123456789012",
  • "client_id": "abcdef12-3456-7890-abcd-ef1234567890",
  • "client_secret": "your-client-secret-value"
}

deleteV1ConnectSpoAuthCredentialSpoAuthCredentialUid

SPO認証情報を削除

path Parameters
spo_auth_credential_uid
required
string
Example: a1b2c3d4e5f67890a1b2c3d4e5f67890

SPO認証情報UID (32文字)

Responses

getV1ConnectSpoSyncConfig

SPO同期設定一覧を取得

query Parameters
limit
integer <int32>
Example: limit=20

取得件数

entity_uid
string
Example: entity_uid=a1b2c3d4e5f67890a1b2c3d4e5f67890

Entity UID (32文字)

Responses

postV1ConnectSpoSyncConfig

SPO同期設定を作成

Request Body schema: application/json
required
spo_auth_credential_uid
required
string

SPO Auth Credential UID (32文字)

spo_drive_id
required
string

SharePoint Drive ID

matter_form
string

案件フォーム名

spo_root_folder_id
string

SharePoint Root Folder ID

spo_matter_id_column_name
string

SharePoint Matter ID Column Name

mntsq_matter_custom_column_name
string

MNTSQ Matter Custom Column Name

document_tree_id
integer <int32>

ドキュメントツリーID

is_active
boolean

有効フラグ

Responses

Request samples

Content type
application/json
{
  • "spo_auth_credential_uid": "a1b2c3d4e5f67890a1b2c3d4e5f67890",
  • "spo_drive_id": "b!abc123def456",
  • "matter_form": "契約案件",
  • "spo_root_folder_id": "01ABC123XYZ",
  • "spo_matter_id_column_name": "MatterID",
  • "mntsq_matter_custom_column_name": "CustomField1",
  • "document_tree_id": 1,
  • "is_active": true
}

getV1ConnectSpoSyncConfigSpoSyncConfigUid

SPO同期設定詳細を取得

path Parameters
spo_sync_config_uid
required
string
Example: b2c3d4e5f67890a1b2c3d4e5f67890a1

SPO同期設定UID (32文字)

Responses

putV1ConnectSpoSyncConfigSpoSyncConfigUid

SPO同期設定を更新

path Parameters
spo_sync_config_uid
required
string
Example: b2c3d4e5f67890a1b2c3d4e5f67890a1

SPO同期設定UID (32文字)

Request Body schema: application/json
required
spo_auth_credential_uid
string

SPO Auth Credential UID (32文字)

spo_drive_id
string

SharePoint Drive ID

matter_form
string

案件フォーム名

spo_root_folder_id
string

SharePoint Root Folder ID

spo_matter_id_column_name
string

SharePoint Matter ID Column Name

mntsq_matter_custom_column_name
string

MNTSQ Matter Custom Column Name

document_tree_id
integer <int32>

ドキュメントツリーID

is_active
boolean

有効フラグ

Responses

Request samples

Content type
application/json
{
  • "spo_auth_credential_uid": "a1b2c3d4e5f67890a1b2c3d4e5f67890",
  • "spo_drive_id": "b!abc123def456",
  • "matter_form": "契約案件",
  • "spo_root_folder_id": "01ABC123XYZ",
  • "spo_matter_id_column_name": "MatterID",
  • "mntsq_matter_custom_column_name": "CustomField1",
  • "document_tree_id": 1,
  • "is_active": true
}

deleteV1ConnectSpoSyncConfigSpoSyncConfigUid

SPO同期設定を削除

path Parameters
spo_sync_config_uid
required
string
Example: b2c3d4e5f67890a1b2c3d4e5f67890a1

SPO同期設定UID (32文字)

Responses