Criar referenceDefinition

Namespace: 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.

Crie um novo objeto referenceDefinition .

Os objetos referenceDefinition associam dados de entrada a valores de tipos de referência padronizados para validação.

Você pode estender os seguintes tipos de referência com outros códigos que se alinhem melhor aos dados de origem.

Nome Tipo de referência
Assuntos Acadêmicos RefAcademicSubject
Demográfico: Raça RefRace
Demográfico: Etnia RefEthnicity
Nível da série RefGradeLevel
Tipos de Organização RefOrgType
Sinalizadores de Pessoa RefPersonFlagType

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ❌ ❌ ❌

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) IndustryData-ReferenceDefinition.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application IndustryData-ReferenceDefinition.ReadWrite.All Indisponível.

Solicitação HTTP

POST /external/industryData/referenceDefinitions

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON do objeto referenceDefinition .

A tabela a seguir lista as propriedades obrigatórias e opcionais para criar um objeto referenceDefinition .

Propriedade Tipo Descrição
referenceType Cadeia de caracteres O tipo categórico para valores enumerados de uma coleção. Obrigatório.
displayName Cadeia de caracteres Uma representação legível do valor do código de referência para exibição em uma interface do usuário. Opcional.
código Cadeia de caracteres Valor de código para a definição. Deve ser exclusivo dentro do referenceType. Obrigatório.
isDisabled Booliano Indica se a definição está desabilitada. Obrigatório.
sortIndex Int32 O índice que especifica a ordem na qual apresentar a definição ao usuário. Deve ser exclusivo dentro do referenceType. Obrigatório.

Resposta

Se for bem-sucedido, esse método retornará um código de 201 Created resposta e um objeto microsoft.graph.industryData.referenceDefinition no corpo da resposta.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/external/industryData/referenceDefinitions
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.industryData.referenceDefinition",
  "referenceType": "RefGradeLevel",
  "code": "TestGrade",
  "isDisabled": false,
  "sortIndex": 300,
  "displayName": "New Test Grade Level"
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.industryData.referenceDefinition",
  "id": "RefGradeLevel-TestGrade",
  "referenceType": "RefGradeLevel",
  "displayName": "New Test Grade Level",
  "code": "TestGrade",
  "source": "Tenant Defined",
  "isDisabled": false,
  "sortIndex": 300,
  "createdDateTime": "2024-03-13T18:20:26.3796502Z",
  "lastModifiedDateTime": "2024-03-13T18:20:26.3796502Z"
}