Skip to main content
PATCH
Atualizar esquema

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

appId
integer<int32>
obrigatório
objectType
string
obrigatório

Corpo

application/json
clearDescription
boolean
obrigatório

Um valor booleano que indica se a descrição deve ser limpa ou redefinida.

allowsSensitiveProperties
boolean

Um valor booleano que especifica se o tipo de objeto permite propriedades marcadas como confidenciais.

description
string

Uma string que fornece uma descrição do tipo de objeto.

labels
object
primaryDisplayProperty
string

Uma string que identifica a propriedade principal usada para exibir o objeto.

requiredProperties
string[]

Uma matriz de strings que indicam quais propriedades são necessárias para o tipo de objeto.

restorable
boolean

Um valor booleano que indica se o tipo de objeto pode ser restaurado após a exclusão.

searchableProperties
string[]

Uma matriz de strings que especifica quais propriedades podem ser usadas em consultas de pesquisa.

secondaryDisplayProperties
string[]

Uma matriz de strings que lista propriedades adicionais usadas para exibir o objeto.

Resposta

successful operation

allowsSensitiveProperties
boolean
obrigatório

Um booleano que indica se o tipo de objeto permite propriedades confidenciais.

archived
boolean
obrigatório

Um valor booleano que indica se o tipo de objeto está arquivado.

fullyQualifiedName
string
obrigatório

Uma string que representa o nome totalmente qualificado do tipo de objeto.

id
string
obrigatório

Uma string que representa o identificador exclusivo para o tipo de objeto.

labels
object
obrigatório
name
string
obrigatório

Uma string que representa o nome do tipo de objeto.

objectTypeId
string
obrigatório

Uma string que representa o identificador exclusivo para o tipo de objeto dentro do sistema.

requiredProperties
string[]
obrigatório

Uma matriz de strings que representam as propriedades necessárias para este tipo de objeto.

searchableProperties
string[]
obrigatório

Uma matriz de strings que indica quais propriedades podem ser usadas em operações de pesquisa.

secondaryDisplayProperties
string[]
obrigatório

Uma matriz de strings que representam propriedades adicionais usadas para exibir este tipo de objeto.

createdAt
string<date-time>

Uma string que representa a data e a hora em que o tipo de objeto foi criado, no formato ISO 8601.

description
string

Uma string que fornece uma descrição do tipo de objeto.

portalId
integer<int32>

Um número inteiro que representa o ID do portal associado ao tipo de objeto.

primaryDisplayProperty
string

Uma string que representa a propriedade principal usada para exibir este tipo de objeto.

updatedAt
string<date-time>

Uma string que representa a data e a hora em que o tipo de objeto foi atualizado pela última vez, no formato ISO 8601.

Última modificação em 10 de abril de 2026