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 de versão.

Representa uma coluna em [um site][], [lista][] ou contentType.

Methods

Método Tipo de retorno Descrição
Listar colunas em um site coleção columnDefinition Obter uma lista dos objetos columnDefinition e suas propriedades em um site.
Listar colunas em uma lista coleção columnDefinition Obter uma lista dos objetos columnDefinition e suas propriedades em uma lista.
Listar colunas em um tipo de conteúdo coleção columnDefinition Obter 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.
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 Exclui 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
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 If true, no two list items may have the same value for this column.
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 Boolean 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 localização geográfica.
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.
validation columnValidation Esta coluna armazena a fórmula e a mensagem de validação da coluna.
hyperlinkOrPicture hyperlinkOrPictureColumn Esta coluna armazena valores de hiperlink ou imagem.
term termColumn Esta coluna armazena termos de taxonomia.
sourceContentType contentTypeInfo ContentType do qual esta coluna é herdada. Usado apenas para buscar colunas contentTypes.
thumbnail thumbnailColumn Esta coluna armazena valores de miniatura.
tipo columnTypes Para colunas de site, o tipo de coluna. Somente leitura.
contentApprovalStatus contentApprovalStatusColumn Esta coluna armazena o 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.

Observação: Essas propriedades correspondem à enumeração SharePoint SPFieldType. 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

Aqui está uma representação JSON de um recurso columnDefinition.

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

Comentários

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