リスト対象

リストに対するレコードの追加・削除ができます。

ログインユーザーの対象リストの権限に応じて操作可能な内容が異なります。
　●オーナー、編集者：対象リストに対してレコードの追加・削除の操作が可能
　●閲覧者：対象リストの参照のみ可能。レコードの追加・削除の操作は不可

システムユーザーは権限に関係なく全てのリストに対する操作が可能です。

リスト対象追加

Request

URL

https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/list/{sheetName}/{listId}/target

HTTP Method

POST

Parameter

Path Parameter

No.	パラメータ	必須	タイプ	デフォルト値	説明
1	tenant	○	string	-	会社ID
2	sheetName	○	string	-	対象アプリ名、リストをサポートしているアプリのみ指定可能
2	listId	○	number	-	リストID

リストをサポートするアプリは以下の通り。

No.	アプリ名	備考
1	businesscard	名刺
2	customer	顧客
3	businessplan	案件
4	activity	活動
5	product	商品
6	deal	取引商品
7	task	タスク
8	ー	拡張アプリ（※任意のアプリ名を設定可能）

※ 拡張アプリについての補足
「拡張アプリ」は自身が作成した拡張アプリのアプリ名を指定する必要があります。

Request Body

No.	プロパティ名	必須	項目名	タイプ	備考
1	targetIds	○	レコードID	array(number)	リストに追加するレコードID、一度に指定できるレコード数は100まで

Example

{
    "targetIds" : [
        1234,
        5678
    ]
}

Response

No.	プロパティ名	必須	項目名	タイプ	備考
1	targetIds	○	レコードID	array(number)	リストに追加されたレコードID

Example

{
    "targetIds" : [
        1234,
        5678
    ]
}

リスト対象削除

Request

URL

https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/list/{sheetName}/{listId}/target

HTTP Method

DELETE

Parameter

Path Parameter

No.	パラメータ	必須	タイプ	デフォルト値	説明
1	tenant	○	string	-	会社ID
2	sheetName	○	string	-	対象アプリ名、リストをサポートしているアプリのみ指定可能
3	listId	○	number	-	リストID

リストをサポートするアプリは以下の通り。

No.	アプリ名	備考
1	businesscard	名刺
2	customer	顧客
3	businessplan	案件
4	activity	活動
5	product	商品
6	deal	取引商品
7	task	タスク
8	ー	拡張アプリ（※任意のアプリ名を設定可能）

※ 拡張アプリについての補足
「拡張アプリ」は自身が作成した拡張アプリのアプリ名を指定する必要があります。

Request Body

No.	プロパティ名	必須	項目名	タイプ	備考
1	targetIds	○	対象アプリID	array(number)	リストから削除するレコードID、一度に指定できるレコードIDは100まで

Example

{
    "targetIds" : [
        1234,
        5678
    ]
}