Compartilhar via


referenceDefinition resource type (Tipo de recurso referenceDefinition)

Espaço de nomes: microsoft.graph.industryData

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 um valor de referência enumerado. Cada domínio do setor suportado recebe uma coleção distinta de valores predefinidos e os clientes podem personalizá-los ao substituir os valores predefinidos ou ao adicionar novos valores ao inquilino. Os objetos referenceDefinition são utilizados em todo o sistema, tanto para configuração como para validar dados durante a transformação.

Cada referenceDefinition utiliza um identificador composto de {referenceType}-{code}. Isto proporciona uma experiência de programador mais natural, uma vez que a grande maioria dos valores de código são definidos por um corpo padrão, o que permite que os programadores em domínios específicos da indústria reconheçam melhor o formato.

Seguem-se exemplos de tipos:

  • refRole: utilizado ao associar e validar durante a importação
  • refOrgType: utilizado ao associar e validar durante a importação
  • userMatchTarget: utilizado apenas para a configuração

Métodos

Método Tipo de retorno Descrição
List microsoft.graph.industryData.referenceDefinition collection Obtenha uma lista dos objetos referenceDefinition e respetivas propriedades.
Get microsoft.graph.industryData.referenceDefinition Leia as propriedades e relações de um objeto referenceDefinition .
Create microsoft.graph.industryData.referenceDefinition Crie um novo objeto referenceDefinition .
Atualizar microsoft.graph.industryData.referenceDefinition Atualize as propriedades de um objeto referenceDefinition .
Delete Nenhum Eliminar um objeto referenceDefinition .

Propriedades

Propriedade Tipo Descrição
código Cadeia de caracteres O valor de código para a definição que tem de ser exclusivo no referenceType.
createdDateTime DateTimeOffset A data e hora em que a definição foi criada. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre no horário UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z.
displayName Cadeia de caracteres Uma representação legível por humanos do valor do código de referência para apresentação numa interface de utilizador.
isDisabled Booliano Indica se a definição está desativada.
lastModifiedDateTime DateTimeOffset A data e hora em que a definição foi alterada mais recentemente. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre no horário UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z.
referenceType Cadeia de caracteres O tipo categórico de uma coleção de valores enumerados.
sortIndex Int32 O índice que especifica a ordem pela qual deve apresentar a definição ao utilizador. Tem de ser exclusivo no referenceType.
source Cadeia de caracteres O corpo de normas ou a origem da organização que definiu o código.

Relações

Nenhum

Representação JSON

A representação JSON seguinte mostra o tipo de recurso.

{
  "@odata.type": "#microsoft.graph.industryData.referenceDefinition",
  "code": "String",
  "createdDateTime": "String (timestamp)",
  "displayName": "String",
  "isDisabled": "Boolean",
  "lastModifiedDateTime": "String (timestamp)",
  "referenceType": "String",
  "sortIndex": "Int32",
  "source": "String"
}