Tipo de recurso columnDefinition

Namespace: microsoft.graph

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

ColumnDefinitions e valores de campo para hidden colunas não são mostrados por padrão. Para listar coluna ocultaDefinitions, inclua hidden em sua $select instrução. Para listar valores de campo ocultos 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 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 Criar um novo objeto columnDefinition em um site.
Criar columnDefinition para uma lista columnDefinition Criar um novo objeto columnDefinition em uma lista.
Criar columnDefinition para um tipo de conteúdo columnDefinition Criar 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 None 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, term, hyperlinkOrPicture, thumbnail e contentApprovalStatus) são mutuamente exclusivas; uma coluna só pode ter um deles especificado.

Nome da 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 cadeia de caracteres 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 cadeia de caracteres O identificador exclusivo da coluna.
indexed Boolean Especifica se os valores de 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 Boolean 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. Presente somente na resposta de colunas contentTypes. Somente leitura.
thumbnail thumbnailColumn Esta coluna armazena valores de miniatura.
type 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

Nome da propriedade Tipo Descrição
sourceColumn columnDefinition A coluna de origem da 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 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. A resposta de sites e colunas de lista não conterá isDeletable, propagateChanges, isReorderable, isSealed, validation, hyperlinkOrPicture, term, sourceContentType, thumbnail, type, contentApprovalStatus e sourceColumn properties.

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" }
}