Skip to main content
POST
Récupérer les cours en lot

Supported products

Paramètres de requête

archived
boolean
défaut:false

S'il faut renvoyer uniquement les résultats qui ont été archivés.

Corps

application/json

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.

inputs
object[]
requis

Un tableau d'objets SimplePublicObjectId, chacun représentant un ID d'objet pour lequel l'opération de lecture par lots sera effectuée.

properties
string[]
requis

Un tableau de chaînes de caractères spécifiant les propriétés à renvoyer dans la réponse. Si les propriétés spécifiées ne sont pas présentes sur les objets demandés, elles seront ignorées.

propertiesWithHistory
string[]
requis

Un tableau de chaînes de caractères spécifiant les propriétés à renvoyer avec l'historique de leurs valeurs précédentes. Si les propriétés spécifiées ne sont pas présentes sur les objets demandés, elles seront ignorées.

idProperty
string

Une chaîne représentant le nom d'une propriété dont les valeurs sont uniques pour ce type d'objet.

Réponse

successful operation

Objet de réponse de lot d'objet public

completedAt
string<date-time>
requis

La date et l'heure auxquelles l'opération de lot a été effectuée, au format ISO 8601.

results
object[]
requis

Un tableau d'éléments SimplePublicObject représentant les résultats de l'opération par lot.

startedAt
string<date-time>
requis

La date et l'heure de début de l'opération par lot, au format ISO 8601.

status
enum<string>
requis

Le statut actuel de l'opération par lot. Les valeurs valides incluent « PENDING », « PROCESSING », « CANCELED » et « COMPLETE ».

Options disponibles:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

Une carte des noms de liens vers les URI associées, fournissant des ressources ou des informations supplémentaires liées à l'opération de lot.

requestedAt
string<date-time>

La date et l'heure auxquelles l'opération de lot a été demandée, au format ISO 8601.

Dernière modification le 6 octobre 2026