Compartilhar via


columnDefinition resource type (Tipo de recurso columnDefinition)

Namespace: microsoft.graph

Representa uma coluna num site, lista ou contentType.

Por predefinição, as columnDefinitions e os valores de campo para hidden colunas não são apresentados. Para listar colunas ocultasDefinições, inclua hidden na sua $select instrução. Para listar valores de campo ocultos em listItems, inclua as colunas pretendidas por nome na sua $select instrução.

Métodos

Método Tipo de retorno Descrição
Listar colunas num site coleção columnDefinition Obtenha uma lista dos objetos columnDefinition e respetivas propriedades num site.
Listar colunas numa lista coleção columnDefinition Obtenha uma lista dos objetos columnDefinition e respetivas propriedades numa lista.
Listar colunas num tipo de conteúdo coleção columnDefinition Obtenha uma lista dos objetos columnDefinition e respetivas propriedades num tipo de conteúdo.
Criar columnDefinition para um site columnDefinition Criar um novo objeto columnDefinition num site.
Criar columnDefinition para uma lista columnDefinition Criar um novo objeto columnDefinition numa lista.
Criar columnDefinition para um tipo de conteúdo columnDefinition Criar um novo objeto columnDefinition num tipo de conteúdo.
Obter columnDefinition columnDefinition Leia as propriedades e relações de um objeto columnDefinition .
Atualizar colunaDefinição columnDefinition Atualize as propriedades de um objeto columnDefinition .
Eliminar columnDefinition Nenhum Eliminar 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 com o tipo (Booleano, calculado, escolha, moeda, dateTime, lookup, number, personOrGroup, text, term, hyperlinkOrPicture, thumbnail e contentApprovalStatus) são mutuamente exclusivas; uma coluna só pode ter uma especificada.

Nome da propriedade Tipo Descrição
boolean booleanColumn Esta coluna armazena valores booleanos.
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.
columnGroup string Para colunas de site, o nome do grupo ao qual esta coluna pertence. Ajuda a organizar as colunas relacionadas.
contentApprovalStatus contentApprovalStatusColumn Esta coluna armazena status de aprovação de conteúdos.
currency 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, nenhum dos dois itens de lista pode ter o mesmo valor para esta coluna.
geolocalização geolocalizaçãoColumn Esta coluna armazena uma geolocalização.
hidden Booliano Especifica se a coluna é exibida na interface do usuário.
hyperlinkOrPicture hyperlinkOrPictureColumn Esta coluna armazena valores de hiperligação ou imagem.
isDeletable Booliano Indica se esta coluna pode ser eliminada.
isReorderable Booliano Indica se os valores na coluna podem ser reordenados. Somente leitura.
id string O identificador exclusivo da coluna.
indexed Booliano Especifica se os valores das colunas podem ser utilizados para ordenação e pesquisa.
isSealed Booliano Especifica se a coluna pode ser alterada.
lookup lookupColumn Os dados dessa coluna são procurados por outra fonte no site.
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.
número numberColumn Esta coluna armazena valores numéricos.
personOrGroup personOrGroupColumn Esta coluna armazena valores de Pessoa ou Grupo.
propagateChanges Booliano Se for "verdadeiro", as alterações a esta coluna serão propagadas para listas que implementem a coluna.
readOnly Booliano Especifica se os valores da coluna podem ser modificados.
required Booliano Especifica se o valor da coluna não é opcional.
sourceContentType contentTypeInfo ContentType do qual esta coluna é herdada. Apresentar apenas na resposta contentTypes columns. Somente leitura.
termo termColumn Esta coluna armazena termos de taxonomia.
text textColumn Esta coluna armazena valores de texto.
thumbnail miniaturaColuna Esta coluna armazena valores de miniaturas.
type columnTypes Para colunas de site, o tipo de coluna. Somente leitura.
validação columnValidation Esta coluna armazena a fórmula de validação e a mensagem para a coluna.

Relações

Nome da propriedade Tipo Descrição
coluna de origem columnDefinition A coluna de origem da coluna de tipo de conteúdo.

Nota: Estas propriedades correspondem à enumeração SPFieldType do SharePoint. Tenha em atenção que os tipos de campo mais comuns são representados na tabela anterior. No entanto, esta API ainda está em falta. 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 irá conter isDeletable, propagateChanges, isReorderable, isSealed, validation, hyperlinkOrPicture, term, sourceContentType, thumbnail, type, contentApprovalStatus e sourceColumn properties.

Representação JSON

A representação JSON seguinte 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",
  "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" },
  "readOnly": "Boolean",
  "required": "Boolean",
  "propagateChanges": "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" }
}