Read a batch of objects by internal ID, or unique property values
Récupérer un lot d’objets CRM à l’aide de leurs identifiants internes ou de leurs valeurs de propriété uniques. Ce point de terminaison est utile pour récupérer plusieurs objets en une seule requête, ce qui peut aider à optimiser les performances et à réduire le nombre d’appels d’API nécessaires. Vous pouvez spécifier si les objets archivés doivent être inclus dans la réponse.
Supported products
Supported products
Required Scopes
Required Scopes
Autorisations
The access token received from the authorization server in the OAuth 2.0 flow.
Paramètres de chemin
Le type d'objet CRM à lire par lots, tel que les contacts, les entreprises ou les transactions.
Paramètres de requête
S'il faut renvoyer uniquement les résultats qui ont été archivés. La valeur par défaut est faux.
Corps
Spécifie l'entrée pour la lecture d'un lot d'objets CRM, y compris des tableaux d'ID d'objets, les noms de propriétés demandés (avec historique facultatif) et une propriété d'identification unique facultative.
Un tableau d'objets SimplePublicObjectId, chacun contenant une ID d'un objet à lire.
Un tableau de chaînes représentant les propriétés à renvoyer dans la réponse pour chaque objet.
Un tableau de chaînes indiquant les propriétés pour lesquelles les valeurs historiques doivent être renvoyées, ainsi que les valeurs actuelles.
Une chaîne qui précise le nom d'une propriété dont les valeurs sont uniques pour le type d'objet, utilisée pour identifier les objets.
Réponse
successful operation
Objet de réponse de lot d'objet public
La date et l'heure auxquelles l'opération de lot a été effectuée, au format ISO 8601.
Un tableau d'éléments SimplePublicObject qui sont le résultat de l'opération de lot.
La date et l'heure de début de l'opération par lot, au format ISO 8601.
Le statut actuel de l'opération par lot. Les valeurs valides incluent « PENDING », « PROCESSING », « CANCELED » et « COMPLETE ».
CANCELED, COMPLETE, PENDING, PROCESSING Une carte des noms de liens vers les URI associées à l'opération de lot.
La date et l'heure auxquelles l'opération de lot a été demandée, au format ISO 8601.