Retrieve the schema of a specified custom object.
Récupérer les détails d’un schéma d’objet personnalisé, y compris ses propriétés et ses associations, en utilisant l’ID de type d’objet ou le nom entièrement qualifié.
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
L'identifiant unique du type d'objet CRM dont le schéma est récupéré.
Paramètres de requête
Un booléen indiquant s'il faut inclure les définitions d'association dans la réponse. La valeur par défaut est « true ».
Un booléen indiquant s'il faut inclure les métadonnées d'audit dans la réponse. La valeur par défaut est « vrai ».
Un booléen indiquant s'il faut inclure les définitions de propriété dans la réponse. La valeur par défaut est « true ».
Réponse
successful operation
Un booléen indiquant si le schéma d'objet autorise les propriétés sensibles.
Un booléen indiquant si le schéma d'objet est archivé.
Associations définies pour un type d'objet donné.
Un ID unique attribué pour l'objet, comprenant l'ID du portail et le nom de l'objet.
Un ID unique pour le type d'objet de ce schéma. Sera défini comme {meta-type}-{unique ID}.
Un nom unique pour le type d'objet de ce schéma.
Une chaîne de caractère représentant l'ID de type de l'objet.
Propriétés définies pour ce type d'objet.
Les noms des propriétés qui devraient être obligatoires lors de la création d'un objet de ce type.
Noms des propriétés qui seront indexées pour ce type d'objet dans la recherche de produits de HubSpot.
Les noms des propriétés secondaires pour cet objet. Elles seront affichées comme secondaires sur la page de la fiche d'informations HubSpot pour ce type d'objet.
Moment où le schéma d'objet a été créé.
Un nombre entier représentant l'ID de l'utilisateur qui a créé le schéma d'objet.
Une chaîne de caractères fournissant une description du schéma d'objet.
Le nom de la propriété principale pour cet objet. Elle sera affichée comme principale sur la page de la fiche d'informations HubSpot pour ce type d'objet.
Moment de la dernière mise à jour du schéma.
Un nombre entier représentant l'ID de l'utilisateur qui a mis à jour le schéma d'objet en dernier.