Skip to main content
POST
オブジェクトをバッチ読み取り

Supported products

承認

Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

クエリパラメータ

archived
boolean
デフォルト:false

アーカイブ済みの結果のみを返すかどうか。

ボディ

application/json

CRMオブジェクトをバッチ読み取りするための入力を指定します。これには、オブジェクトIDの配列、要求されたプロパティー名(任意の履歴を含む)、および任意の重複しない識別プロパティーが含まれます。

inputs
object[]
必須

SimplePublicObjectIdオブジェクトの配列。各オブジェクトには、読み取るCRMオブジェクトのIDが含まれます。

properties
string[]
必須

レスポンスで返されるプロパティーの名前を表す文字列の配列。

propertiesWithHistory
string[]
必須

以前の値の履歴を返すプロパティーの名前を表す文字列の配列。

idProperty
string

カスタム固有値プロパティーを使用してレコードを取得する場合は、プロパティーの名前。レコードIDによって取得する場合は、このパラメーターを含めないでください。

レスポンス

successful operation

公開オブジェクトのバッチレスポンスオブジェクト

completedAt
string<date-time>
必須

バッチ操作が完了した日時(ISO 8601形式)。

results
object[]
必須

バッチ処理の結果を表すSimplePublicObject項目の配列。

startedAt
string<date-time>
必須

バッチ操作が開始された日時(ISO 8601形式)。

status
enum<string>
必須

バッチ操作の現在のステータス。有効な値は「PENDING」、「PROCESSING」、「CANCELED」、「COMPLETE」です。

利用可能なオプション:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

リンク名とバッチ操作に関する追加情報を提供する関連URIの対応付け。

requestedAt
string<date-time>

バッチ操作が要求された日時(ISO 8601形式)。

最終更新日 2026年10月6日