Skip to main content
PATCH
Actualizar esquema

Supported products

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de ruta

appId
integer<int32>
requerido
objectType
string
requerido

Cuerpo

application/json
clearDescription
boolean
requerido

Un booleano que indica si la descripción debe borrarse o restablecerse.

allowsSensitiveProperties
boolean

Un booleano que especifica si el tipo de objeto permite propiedades marcadas como sensibles.

description
string

Una cadena que proporciona una descripción del tipo de objeto.

labels
object
primaryDisplayProperty
string

Una cadena que identifica la propiedad principal usada para mostrar el objeto.

requiredProperties
string[]

Un conjunto de cadenas que indica qué propiedades son obligatorias para el tipo de objeto.

restorable
boolean

Un booleano que indica si el tipo de objeto se puede restaurar después de la eliminación.

searchableProperties
string[]

Un conjunto de cadenas que especifica qué propiedades se pueden usar en las consultas de búsqueda.

secondaryDisplayProperties
string[]

Un conjunto de cadenas que enumeran propiedades adicionales usadas para mostrar el objeto.

Respuesta

successful operation

allowsSensitiveProperties
boolean
requerido

Un booleano que indica si el tipo de objeto permite propiedades sensibles.

archived
boolean
requerido

Un booleano que indica si el tipo de objeto está archivado.

fullyQualifiedName
string
requerido

Una cadena que representa el nombre completamente certificado del tipo de objeto.

id
string
requerido

Una cadena que representa el identificador único del tipo de objeto.

labels
object
requerido
name
string
requerido

Una cadena que representa el nombre del tipo de objeto.

objectTypeId
string
requerido

Una cadena que representa el identificador único para el tipo de objeto dentro del sistema.

requiredProperties
string[]
requerido

Un conjunto de cadenas que representan las propiedades necesarias para este tipo de objeto.

searchableProperties
string[]
requerido

Un conjunto de cadenas que indica qué propiedades se pueden usar en las operaciones de búsqueda.

secondaryDisplayProperties
string[]
requerido

Un conjunto de cadenas que representan propiedades adicionales usadas para mostrar este tipo de objeto.

createdAt
string<date-time>

Una cadena que representa la fecha y hora en que se creó el tipo de objeto, en formato ISO 8601.

description
string

Una cadena que proporciona una descripción del tipo de objeto.

portalId
integer<int32>

Un número entero que representa el ID del portal asociado al tipo de objeto.

primaryDisplayProperty
string

Una cadena que representa la propiedad principal utilizada para mostrar este tipo de objeto.

updatedAt
string<date-time>

Una cadena que representa la fecha y hora de la última actualización del tipo de objeto, en formato ISO 8601.

Última modificación el 3 de abril de 2026