Compartilhar via


Criar 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.

Crie um novo objeto referenceDefinition .

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

Pode expandir os seguintes tipos de referência com outros códigos que melhor se alinham com os dados de origem.

Nome Tipo de Referência
Disciplinas Académicas RefAcademicSubject
Demográfico: Raça RefRace
Demográfico: Etnia RefEtnicidade
Nível de Nota RefGradeLevel
Tipos de Organização RefOrgType
Sinalizadores de Pessoa RefPersonFlagType

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
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 do pedido, forneça uma representação JSON do objeto referenceDefinition .

A tabela seguinte 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 uma coleção enumera os valores. Obrigatório.
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. Opcional.
código Cadeia de caracteres Valor de código para a definição. Tem de ser exclusivo no referenceType. Obrigatório.
isDisabled Booliano Indica se a definição está desativada. Obrigatório.
sortIndex Int32 O índice que especifica a ordem pela qual deve apresentar a definição ao utilizador. Tem de ser exclusivo no referenceType. Obrigatório.

Resposta

Se for bem-sucedido, este método devolve um 201 Created código de 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"
}