tipo de recurso columnDefinition

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Representa uma coluna em um site, lista ou contentType.

Por padrão, columnDefinitions e valores de campo para hidden colunas não são mostrados. Para vê-los ao listar columnDefinitions, inclua hidden na instrução $select. Para vê-los ao mostrar valores de campo em listItems, inclua as colunas desejadas por nome em sua $select instrução.

Métodos

Método Tipo de retorno Descrição
Listar colunas em um site coleção columnDefinition Obtenha uma lista dos objetos columnDefinition e suas propriedades em um site.
Listar colunas em uma lista coleção columnDefinition Obtenha uma lista dos objetos columnDefinition e suas propriedades em uma lista.
Listar colunas em um tipo de conteúdo coleção columnDefinition Obtenha uma lista dos objetos columnDefinition e suas propriedades em um tipo de conteúdo.
Criar columnDefinition para um site columnDefinition Crie um novo objeto columnDefinition em um site.
Criar columnDefinition para uma lista columnDefinition Crie um novo objeto columnDefinition em uma lista.
Criar columnDefinition para um tipo de conteúdo columnDefinition Crie um novo objeto columnDefinition em um tipo de conteúdo.
Get columnDefinition columnDefinition Leia as propriedades e relações de um objeto columnDefinition .
Atualizar columnDefinition columnDefinition Atualize as propriedades de um objeto columnDefinition .
Excluir columnDefinition Nenhum Exclua um objeto columnDefinition .

Propriedades

As colunas podem conter dados de vários tipos. As propriedades a seguir indicam qual tipo de dados uma coluna armazena, bem como configurações adicionais para esses dados. As propriedades relacionadas ao tipo (boolean, calculated, choice, currency, dateTime, lookup, number, personOrGroup, text) são mutuamente exclusivas, uma coluna só pode ter uma delas especificada.

Propriedade Tipo Descrição
booliano booleanColumn Essa coluna armazena valores booleanos.
calculados calculatedColumn Os dados dessa coluna são calculados com base em outras colunas.
escolha choiceColumn Esta coluna armazena dados de uma lista de opções.
columnGroup string Para colunas de site, o nome do grupo ao qual esta coluna pertence. Ajuda a organizar as colunas relacionadas.
contentApprovalStatus contentApprovalStatusColumn Essa coluna armazena o status de aprovação de conteúdo.
Moeda currencyColumn Esta coluna armazena valores monetários.
dateTime dateTimeColumn Esta coluna armazena valores de datetime.
defaultValue defaultColumnValue O valor padrão dessa coluna.
description string A descrição voltado para o usuário da coluna.
displayName string O nome voltado para o usuário da coluna.
enforceUniqueValues Booliano Se true, dois itens da lista podem ter o mesmo valor para esta coluna.
Localização geográfica geolocationColumn Essa coluna armazena uma geolocalização.
hidden Booliano Especifica se a coluna é exibida na interface do usuário.
hyperlinkOrPicture hyperlinkOrPictureColumn Essa coluna armazena valores de hiperlink ou imagem.
id string O identificador exclusivo da coluna.
indexed Booliano Especifica se os valores da coluna podem ser usados para classificação e pesquisa.
isDeletable Booliano Indica se esta coluna pode ser excluída.
isReorderable Booliano Indica se os valores na coluna podem ser reordenados. Somente leitura.
isSearchable Booliano Especifica se os valores da coluna podem ser usados para pesquisa. Atualmente com suporte apenas para colunas em um fileStorageContainer.
isSealed Booliano Especifica se a coluna pode ser alterada.
Pesquisa lookupColumn Os dados dessa coluna são procurados por outra fonte no site.
nome string O nome voltado para a API da coluna, conforme ele aparece nos campos em uma listItem. Para o nome voltado ao usuário, consulte displayName.
number numberColumn Esta coluna armazena valores numéricos.
personOrGroup personOrGroupColumn Esta coluna armazena valores de Pessoa ou Grupo.
propagateChanges Booliano Se true, as alterações nessa coluna serão propagadas para listas que implementam a coluna.
readOnly Booliano Especifica se os valores da coluna podem ser modificados.
obrigatório Booliano Especifica se o valor da coluna não é opcional.
sourceContentType contentTypeInfo ContentType do qual essa coluna é herdada. Usado apenas para buscar colunas contentTypes.
term termColumn Esta coluna armazena termos de taxonomia.
texto textColumn Esta coluna armazena valores de texto.
miniatura thumbnailColumn Essa coluna armazena valores em miniatura.
type columnTypes Para colunas de site, o tipo de coluna. Somente leitura.
de IVA columnValidation Esta coluna armazena a fórmula de validação e a mensagem para a coluna.

Observação

As propriedades isSearchable e indexed são relacionadas, mas independentes. Se isSearchable não for especificado explicitamente, ele usará o valor de indexado. Depois de definir isSearchable, ele se torna independente de indexado. Se apenas isSearchable for especificado, o estado pesquisável da coluna será atualizado sem alterar seu estado indexado. No momento, a propriedade isSearchable tem suporte apenas para colunas em um fileStorageContainer.

Relações

Relação Tipo Descrição
sourceColumn columnDefinition A coluna de origem para a coluna do tipo de conteúdo.

Observação: Essas propriedades correspondem à enumeração SPFieldType do SharePoint. Observe que os tipos de campo mais comuns estão representados na tabela anterior. No entanto, essa API beta ainda está faltando algumas. nestes casos, nenhuma das facetas do tipo de coluna serão preenchidas, e a coluna só terá as propriedades básicas.

Representação JSON

A representação JSON a seguir mostra o tipo de recurso.

{
  "boolean": {"@odata.type": "microsoft.graph.booleanColumn"},
  "calculated": {"@odata.type": "microsoft.graph.calculatedColumn"},
  "choice": {"@odata.type": "microsoft.graph.choiceColumn"},
  "columnGroup": "String",
  "contentApprovalStatus": {"@odata.type": "microsoft.graph.contentApprovalStatusColumn"},
  "currency": {"@odata.type": "microsoft.graph.currencyColumn"},
  "dateTime": {"@odata.type": "microsoft.graph.dateTimeColumn"},
  "defaultValue": {"@odata.type": "microsoft.graph.defaultColumnValue"},
  "description": "String",
  "displayName": "String",
  "enforceUniqueValues": "Boolean",
  "geolocation": {"@odata.type": "microsoft.graph.geolocationColumn"},
  "hidden": "Boolean",
  "hyperlinkOrPicture": {"@odata.type": "microsoft.graph.hyperlinkOrPictureColumn"},
  "id": "String (identifier)",
  "indexed": "Boolean",
  "isSearchable": "Boolean",
  "isDeletable": "Boolean",
  "isReorderable": "Boolean",
  "isSealed": "Boolean",
  "lookup": {"@odata.type": "microsoft.graph.lookupColumn"},
  "name": "staticNameForApi",
  "number": {"@odata.type": "microsoft.graph.numberColumn"},
  "personOrGroup": {"@odata.type": "microsoft.graph.personOrGroupColumn"},
  "propagateChanges": "Boolean",
  "readOnly": "Boolean",
  "required": "Boolean",
  "sourceContentType": {"@odata.type": "microsoft.graph.contentTypeInfo"},
  "term": {"@odata.type": "microsoft.graph.termColumn"},
  "text": {"@odata.type": "microsoft.graph.textColumn"},
  "thumbnail": {"@odata.type": "microsoft.graph.thumbnailColumn"},
  "type": {"@odata.type": "microsoft.graph.columnTypes"},
  "validation": {"@odata.type": "microsoft.graph.columnValidation"}
}