削除履歴検索 API

指定された期間内に削除されたレコードID一覧を取得することができます。
ただし、レコードの削除履歴の保持期間は最大で1年間のため、1年以上前に削除されたデータは取得できません。

必要な権限

該当アプリ参照

Request

URL

https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/sheets/{sheetName}/deletedRecordIds
https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/schedules/deletedRecordIds

HTTP Method

POST

Parameter

Path Parameter

No.	パラメータ	必須	タイプ	デフォルト値	説明
1	tenant	○	string	-	会社ID
2	sheetName	○	string	-	アプリ名

削除履歴検索をサポートするアプリについて説明します。

No.	アプリ	説明
1	activity	活動
2	business_card	名刺
3	businessplan	案件
4	customer	顧客
5	deal	取引商品
6	product	商品
7	task	タスク
8	ー	拡張アプリ

Request Body

No.	プロパティ名	必須	項目名	タイプ	備考
1	targetStartDatetime		対象開始日時	string	"yyyy/MM/dd HH:mm:ss"形式 対象開始日時以降に削除されたレコードID（エンティティID）を返す、開始日時は含む（inclusive）
2	targetEndDatetime		対象終了日時	string	"yyyy/MM/dd HH:mm:ss"形式 対象終了日時以前に削除されたレコードID（エンティティID）を返す、終了日時は含まない（exclusive）
3	pagination		ページネーション	object
4	- limit		1 ページあたりの取得数	number	1 以上・500 以下
5	- page		ページ番号	number	1 以上

Example

{
  "targetStartDatetime": "2025/01/01 00:00:00",
  "targetEndDatetime": "2025/01/01 01:00:00",
  "pagination": {
    "limit": 10,
    "page": 1
  }
}

Response

Response Body

No.	プロパティ名	項目名	タイプ	備考
1	deletedRecordIds	削除 ID 配列	array(number)	指定された期間内に削除されたレコードIDの一覧（削除日順に昇順）
2	meta	データ拡張	object
3	- pagination	ページネーション	object
4	-- count	件数	number
5	-- totalCount	総件数	number
6	-- curentPage	現在のページ数	number
7	-- totalPage	全体ページ数	number

Example

{
  "deletedRecordIds": [
    1000001473981, 1000001473982, 1000001473983, 1000001473984, 1000001473985,
    1000001473986, 1000001473987, 1000001473988, 1000001473989, 1000001473990
  ],
  "meta": {
    "pagination": {
      "count": 10,
      "totalCount": 95,
      "currentPage": 1,
      "totalPage": 10
    }
  }
}