columnDefinition resource type (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 num site, lista ou contentType.
Por predefinição, não são apresentados columnDefinitions e valores de campo para hidden colunas. 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 pretendidas por nome na sua $select instrução.
Métodos
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, 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 dos dois itens 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 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. |
| 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 | geolocalizaçãoColumn | 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 esta coluna pode ser eliminada. |
| propagateChanges | Booliano | Se true, as alterações a esta 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 de validação e a mensagem para a coluna. |
| hyperlinkOrPicture | hyperlinkOrPictureColumn | Esta coluna armazena valores de hiperligação ou imagem. |
| termo | termColumn | Esta coluna armazena termos de taxonomia. |
| sourceContentType | contentTypeInfo | ContentType do qual esta coluna é herdada. Utilizado apenas para obter contentTypes colunas. |
| thumbnail | miniaturaColuna | Esta coluna armazena valores de miniaturas. |
| type | columnTypes | Para colunas de site, o tipo de coluna. Somente leitura. |
| contentApprovalStatus | contentApprovalStatusColumn | Esta coluna armazena o estado de aprovação de conteúdo. |
Relações
| Relação | Tipo | Descrição |
|---|---|---|
| coluna de origem | columnDefinition | A coluna de origem para a 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 beta 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.
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"},
"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"}
}