Partilhar via


DocumentFieldSchema interface

Descrição do esquema semântico de campo usando uma sintaxe de estilo de esquema JSON.

Propriedades

description

Descrição do campo.

example

Exemplo de conteúdo do campo.

items

Esquema de tipo de campo de cada elemento da matriz.

properties

Subcampos nomeados do campo de objeto.

type

Tipo de dados semânticos do valor do campo.

Valores possíveis: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", "selectionGroup"

Detalhes de Propriedade

description

Descrição do campo.

description?: string

Valor de Propriedade

string

example

Exemplo de conteúdo do campo.

example?: string

Valor de Propriedade

string

items

Esquema de tipo de campo de cada elemento da matriz.

items?: DocumentFieldSchema

Valor de Propriedade

properties

Subcampos nomeados do campo de objeto.

properties?: Record<string, DocumentFieldSchema>

Valor de Propriedade

Record<string, DocumentFieldSchema>

type

Tipo de dados semânticos do valor do campo.

Valores possíveis: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", "selectionGroup"

type: string

Valor de Propriedade

string