リスト(list)
リストに対して以下の操作が可能です。
●リストの新規登録
●リストの変更
●リストの取得
●リストの削除
ログインユーザーの対象リストの権限に応じて操作可能な内容が異なります。
●オーナー、編集者： リストの変更・削除が可能
●閲覧者： リストの参照のみ可能
システムユーザーは権限に関係なく全てのリストの参照・更新・削除が可能です。
リスト権限について
リストに対して、以下の対象にリスト権限を設定できます。
●社員
●共通グループ
●部署
設定できる権限の範囲は以下の通りです。
| パラメータ | 設定可能対象 | 備考 |
|---|---|---|
| 1: オーナー | 社員、部署 | 1名（または1部署）のみ設定可能 |
| 2: 編集者 | 社員、共通グループ、部署 | 複数設定可能 |
| 3: 閲覧者 | 社員、共通グループ、部署 | 複数設定可能 |
リストの「更新条件」について
リストにはリスト内の更新条件を指定する機能が存在します。
ただし、これらの条件設定は画面からの操作のみサポートしており、API経由での設定・変更は行えません。
更新条件の設定・変更が必要な場合は、画面上で操作を行ってください。
リスト取得
Request
URL
https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/list/{sheetName}/{listId}
HTTP Method
GET
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 | ー | 拡張アプリ（※任意のアプリ名を設定可能） |
※ 拡張アプリについての補足
「拡張アプリ」は自身が作成した拡張アプリのアプリ名を指定する必要があります。
Response
| No. | プロパティ名 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|
| 1 | listId | リストID | number | |
| 2 | listName | リスト名 | string | |
| 3 | listAuthorities | リスト権限 | array(object) | |
| - participantType | 権限タイプ | number | 1:オーナー、2:編集者、3:閲覧者 各権限タイプごとにまとめて返却 | |
| - employee | 社員 | array(object) | ||
| -- employeeId | 社員ID | number | ||
| -- employeeName | 社員名 | string | ||
| - group | 共通グループ | array(object) | ||
| -- groupId | 共通グループID | number | ||
| -- groupName | 共通グループ名 | string | ||
| - department | 部署 | array(object) | ||
| -- departmentId | 部署ID | number | ||
| -- departmentName | 部署名 | string | ||
| -- isIncludeChildDepartment | 子部署含むフラグ | boolean | ・trueの場合、子部署を権限の対象に含む ・falseの場合、子部署を権限の対象に含まない | |
| 4 | targetIds | リスト対象レコードID | array(number) | リストに含まれるレコードIDの一覧 |
| 5 | isUpdating | 更新中フラグ | boolean | |
| 6 | lastSyncDate | 最終同期日時 | string | "yyyy/MM/dd HH:mm"形式 |
| 7 | isAutoUpdate | 自動更新フラグ | boolean | trueの場合、自動更新の対象 |
| 6 | isOverwiteAutoUpdate | 上書き自動更新フラグ | boolean | ・trueの場合、リスト更新時にリスト対象から外れたIDをリストから除去 ・falseの場合、リスト更新時にリスト対象から外れたIDもそのままリスト対象として残り続ける |
| 7 | systemRegDate | 登録日 | string | "yyyy/MM/dd HH:mm"形式 |
| 8 | systemRegUser | 登録ユーザー | number | 登録者ユーザーID |
| 9 | systemRegEmployee | 登録社員 | number | 登録者社員ID |
| 10 | systemUpdDate | 更新日 | string | "yyyy/MM/dd HH:mm"形式 |
| 11 | systemUpdUser | 最終更新ユーザー | number | 最終更新者ユーザーID |
| 12 | systemUpdEmployee | 最終更新社員 | number | 最終更新者社員ID |
Example
{
"listId": "1",
"listName": "案件リスト",
"listAuthorities": [
{
"participantType": 1,
"employee": [
{
"employeeId": 1,
"employeeName": "佐藤 健一"
}
]
},
{
"participantType": 3,
"employee": [
{
"employeeId": 3,
"employeeName": "田中 美咲"
}
],
"group": [
{
"groupId": 1,
"groupName": "マーケティング戦略チーム"
}
],
"department": [
{
"departmentId": "2",
"departmentName": "営業第一課",
"isIncludeChildDepartment" : true
},
{
"departmentId": "3",
"departmentName": "コンサルティング事業部",
"isIncludeChildDepartment" : false
}
]
}
],
"targetIds": [
123, 456
],
"isUpdating" : false,
"lastSyncDate": "2025/02/05 01:00",
"isAutoUpdate": true,
"isOverwiteAutoUpdate": true,
"systemRegDate": "2025/02/05 01:00",
"systemRegUser": 1000,
"systemRegEmployee": 1,
"systemUpdDate": "2025/02/05 01:00",
"systemUpdUser": 1000,
"systemUpdEmployee": 1
}
リスト登録
Request
URL
https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/list/{sheetName}
HTTP Method
POST
Parameter
Path Parameter
| No. | パラメータ | 必須 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|---|
| 1 | tenant | ○ | string | - | 会社ID |
| 2 | sheetName | ○ | string | - | 対象アプリ名、リストをサポートしているアプリのみ |
リストをサポートするアプリは以下の通り。
| No. | アプリ名 | 備考 |
|---|---|---|
| 1 | businesscard | 名刺 |
| 2 | customer | 顧客 |
| 3 | businessplan | 案件 |
| 4 | activity | 活動 |
| 5 | product | 商品 |
| 6 | deal | 取引商品 |
| 7 | task | タスク |
| 8 | ー | 拡張アプリ（※任意のアプリ名を設定可能） |
※ 拡張アプリについての補足
「拡張アプリ」は自身が作成した拡張アプリのアプリ名を指定する必要があります。
Request Body
| No. | プロパティ名 | 必須 | 項目名 | タイプ | 備考 |
|---|---|---|---|---|---|
| 1 | listName | リスト名 | string | ||
| 2 | listAuthorities | リスト権限 | array(object) | ||
| - participantType | 権限タイプ | number | 1:オーナー、2:編集者、3:閲覧者 | ||
| - employee | 社員 | aray(object) | |||
| -- employeeId | 社員ID | number | |||
| - group | 共通グループ | aray(object) | |||
| -- groupId | 共通グループID | number | |||
| - department | 部署 | aray(object) | |||
| -- departmentId | 部署ID | number | |||
| -- isIncludeChildDepartment | 子部署含むフラグ | boolean | ・trueの場合、子部署を権限の対象に含む ・falseの場合、子部署を権限の対象に含まない |
Example
{
"listName": "案件リスト",
"listAuthorities": [
{
"participantType": 1,
"employee": [
{
"employeeId": 1
}
]
},
{
"participantType": 3,
"employee": [
{
"employeeId": 3
}
],
"group": [
{
"groupId": 1
}
],
"department": [
{
"departmentId": 2,
"isIncludeChildDepartment": true
},
{
"departmentId": 3,
"isIncludeChildDepartment": false
}
]
}
]
}
Response
Example
{
"listId": 123456,
"listName": "案件リスト",
"listAuthorities": [
{
"participantType": 1,
"employee": [
{
"employeeId": 1
}
]
},
{
"participantType": 3,
"employee": [
{
"employeeId": 3
}
],
"group": [
{
"groupId": 1
}
],
"department": [
{
"departmentId": 2,
"isIncludeChildDepartment": true
},
{
"departmentId": 3,
"isIncludeChildDepartment": false
}
]
}
]
}
リスト更新
Request
URL
https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/list/{sheetName}/{listId}
HTTP Method
PUT
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 | listName | リスト名 | string | ||
| 2 | listAuthorities | リスト権限 | array(object) | ||
| - participantType | 権限タイプ | number | 1:オーナー、2:編集者、3:閲覧者 | ||
| - employee | 社員 | aray(object) | |||
| -- employeeId | 社員ID | number | |||
| - group | 共通グループ | aray(object) | |||
| -- groupId | 共通グループID | number | |||
| - department | 部署 | aray(object) | |||
| -- departmentId | 部署ID | number | |||
| -- isIncludeChildDepartment | 子部署含むフラグ | boolean | ・trueの場合、子部署を権限の対象に含む ・falseの場合、子部署を権限の対象に含まない |
Example
{
"listName": "案件リスト",
"listAuthorities": [
{
"participantType": 1,
"employee": [
{
"employeeId": 1
}
]
},
{
"participantType": 3,
"employee": [
{
"employeeId": 3
}
],
"group": [
{
"groupId": 1
}
],
"department": [
{
"departmentId": 2,
"isIncludeChildDepartment": true
},
{
"departmentId": 3,
"isIncludeChildDepartment": false
}
]
}
]
}
Response
Example
{
"listId": 123456,
"listName": "案件リスト",
"listAuthorities": [
{
"participantType": 1,
"employee": [
{
"employeeId": 1
}
]
},
{
"participantType": 3,
"employee": [
{
"employeeId": 3
}
],
"group": [
{
"groupId": 1
}
],
"department": [
{
"departmentId": 2,
"isIncludeChildDepartment": true
},
{
"departmentId": 3,
"isIncludeChildDepartment": false
}
]
}
]
}
リスト削除
Request
URL
https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/list/{sheetName}/{listId}
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 | ー | 拡張アプリ（※任意のアプリ名を設定可能） |
※ 拡張アプリについての補足
「拡張アプリ」は自身が作成した拡張アプリのアプリ名を指定する必要があります。