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 pelo 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 objeto columnDefinition em um tipo de conteúdo.
Obter columnDefinition columnDefinition Leia as propriedades e as relações de um objeto columnDefinition .
Atualizar columnDefinition columnDefinition Atualize as propriedades de um objeto columnDefinition .
Excluir columnDefinition Nenhum Excluir 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 (booliano, calculado, escolha, moeda, dateTime, pesquisa, número, personOrGroup, texto) são mutuamente exclusivas -- uma coluna só pode ter uma delas especificada.

Propriedade Tipo Descrição
columnGroup string Para colunas de site, o nome do grupo ao qual esta coluna pertence. Ajuda a organizar as colunas relacionadas.
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, nenhum item de lista pode ter o mesmo valor para esta coluna.
hidden Booliano Especifica se a coluna é exibida na interface do usuário.
id string O identificador exclusivo da coluna.
indexed Booliano Especifica se os valores da coluna podem ser usados para classificação e pesquisa.
name 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.
readOnly Booliano Especifica se os valores da coluna podem ser modificados.
required Booliano Especifica se o valor da coluna não é opcional.
boolean booleanColumn Esta coluna armazena valores boolianos.
calculated calculatedColumn Os dados dessa coluna são calculados com base em outras colunas.
choice choiceColumn Esta coluna armazena dados de uma lista de opções.
currency currencyColumn Esta coluna armazena valores monetários.
dateTime dateTimeColumn Esta coluna armazena valores de datetime.
defaultValue defaultColumnValue O valor padrão dessa coluna.
Geolocalização geolocationColumn Esta coluna armazena uma geolocalização.
lookup lookupColumn Os dados dessa coluna são procurados por outra fonte no site.
number numberColumn Esta coluna armazena valores numéricos.
personOrGroup personOrGroupColumn Esta coluna armazena valores de Pessoa ou Grupo.
text textColumn Esta coluna armazena valores de texto.
isDeletable Booliano Indica se essa coluna pode ser excluída.
propagateChanges Booliano Se true, as alterações nesta coluna serão propagadas para listas que implementam a coluna.
isReorderable Booliano Indica se os valores na coluna podem ser reordenados. Somente leitura.
Issealed Booliano Especifica se a coluna pode ser alterada.
Validação columnValidation Esta coluna armazena a fórmula e a mensagem de validação para a coluna.
hyperlinkOrPicture hyperlinkOrPictureColumn Esta coluna armazena valores de hiperlink ou imagem.
Termo termColumn Esta coluna armazena termos de taxonomia.
sourceContentType contentTypeInfo ContentType do qual esta coluna é herdada. Usado apenas para buscar colunas contentTypes.
thumbnail miniaturaColumn Esta coluna armazena valores de miniatura.
type columnTypes Para colunas de site, o tipo de coluna. Somente leitura.
contentApprovalStatus contentApprovalStatusColumn Esta coluna armazena status de aprovação de conteúdo.

Relações

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

Nota: Essas propriedades correspondem à enumeração SPFieldType do SharePoint. Observe que os tipos de campo mais comuns sã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

Veja a seguir uma representação JSON do 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",
  "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"}
}