Zum Hauptinhalt springen
POST
Objekte batchweise lesen

Supported products

Autorisierungen

Authorization
string
header
erforderlich

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

Abfrageparameter

archived
boolean
Standard:false

Ob nur Ergebnisse zurückgegeben werden sollen, die archiviert wurden.

Body

application/json

Gibt die Eingabe zum Lesen eines Batches von CRM-Objekten an, einschließlich Arrays von Objekt-IDs, angeforderten Eigenschaftsnamen (mit optionalem Verlauf) und einer optionalen eindeutigen identifizierenden Eigenschaft.

inputs
object[]
erforderlich

Ein Array von SimplePublicObjectId-Objekten, die die IDs der zu lesenden Objekte darstellen.

properties
string[]
erforderlich

Ein Array von Zeichenfolgen, das die in der Antwort zurückzugebenden Eigenschaften darstellt. Wenn eine angegebene Eigenschaft in den angeforderten Objekten nicht vorhanden ist, wird sie ignoriert.

propertiesWithHistory
string[]
erforderlich

Ein Array von Zeichenfolgen, das die Eigenschaften darstellt, die zusammen mit dem Verlauf der vorherigen Werte zurückgegeben werden. Wenn eine angegebene Eigenschaft in den angeforderten Objekten nicht vorhanden ist, wird sie ignoriert.

idProperty
string

Wenn eine benutzerdefinierte „Eindeutiger Wert“-Eigenschaft zum Abrufen von Datensätzen verwendet wird, der Name der Eigenschaft. Geben Sie diesen Parameter nicht an, wenn Sie nach Datensatz-ID abrufen.

Antwort

successful operation

Ein öffentliches Objekt-Batch-Antwortobjekt

completedAt
string<date-time>
erforderlich

Der Zeitpunkt (Datum und Uhrzeit), zu dem der Batch-Vorgang im ISO-8601-Format abgeschlossen wurde.

results
object[]
erforderlich

Ein Array von SimplePublicObject-Elementen, das die Ergebnisse des Batch-Vorgangs darstellt.

startedAt
string<date-time>
erforderlich

Der Zeitpunkt (Datum und Uhrzeit), zu dem der Batch-Vorgang im ISO-8601-Format gestartet wurde.

status
enum<string>
erforderlich

Der aktuelle Status des Batch-Vorgangs. Gültige Werte sind „PENDING“, „PROCESSING“, „CANCELED“ und „COMPLETE“.

Verfügbare Optionen:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

Eine Zuordnung von Linknamen zu zugehörigen URIs, die zusätzliche Ressourcen oder Dokumentationen im Zusammenhang mit dem Batch-Vorgang bereitstellt.

requestedAt
string<date-time>

Der Zeitpunkt (Datum und Uhrzeit), zu dem der Batch-Vorgang im ISO-8601-Format angefordert wurde.

Zuletzt geändert am 6. Oktober 2026