Skip to main content
PATCH
Mettre à jour le schéma

Supported products

Autorisations

hapikey
string
query
requis

Paramètres de chemin

appId
integer<int32>
requis

L'identifiant unique de l'application associée au schéma.

objectType
string
requis

Le type d'objet dont le schéma est mis à jour.

Corps

application/json
clearDescription
boolean
requis

Un booléen indiquant si la description doit être effacée ou réinitialisée.

allowsSensitiveProperties
boolean

Un booléen qui indique si le type d'objet autorise les propriétés marquées comme sensibles.

description
string

Une chaîne de caractères fournissant une description du type d'objet.

labels
object
primaryDisplayProperty
string

Chaîne de caractères qui identifie la propriété principale utilisée pour afficher l'objet.

requiredProperties
string[]

Un tableau de chaînes de caractères indiquant les propriétés requises pour le type d'objet.

restorable
boolean

Un booléen indiquant si le type d'objet peut être restauré après suppression.

searchableProperties
string[]

Un tableau de chaînes spécifiant les propriétés pouvant être utilisées dans les requêtes de recherche.

secondaryDisplayProperties
string[]

Un tableau de chaînes de caractères qui liste les propriétés additionnelles utilisées pour l'affichage de l'objet.

Réponse

successful operation

allowsSensitiveProperties
boolean
requis

Un booléen indiquant si le type d'objet autorise les propriétés sensibles.

archived
boolean
requis

Un booléen indiquant si le type d'objet est archivé.

fullyQualifiedName
string
requis

Chaîne représentant le nom complet du type d'objet.

id
string
requis

Une chaîne représentant l'identifiant unique du type d'objet.

labels
object
requis
name
string
requis

Une chaîne représentant le nom du type d'objet.

objectTypeId
string
requis

Chaîne représentant l'identifiant unique du type d'objet au sein du système.

requiredProperties
string[]
requis

Un tableau de chaînes de caractères représentant les propriétés requises pour ce type d'objet.

searchableProperties
string[]
requis

Un tableau de chaînes indiquant les propriétés pouvant être utilisées dans les opérations de recherche.

secondaryDisplayProperties
string[]
requis

Un tableau de chaînes représentant des propriétés supplémentaires utilisées pour afficher ce type d'objet.

createdAt
string<date-time>

Une chaîne représentant la date et l'heure de création du type d'objet, au format ISO 8601.

description
string

Une chaîne fournissant une description du type d'objet.

portalId
integer<int32>

Un entier représentant l'ID du portail associé au type d'objet.

primaryDisplayProperty
string

Une chaîne représentant la propriété principale utilisée pour afficher ce type d'objet.

updatedAt
string<date-time>

Une chaîne représentant la date et l'heure de la dernière mise à jour du type d'objet, au format ISO 8601.

Dernière modification le 6 octobre 2026