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
| 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"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models.IndustryData;
var requestBody = new ReferenceDefinition
{
OdataType = "#microsoft.graph.industryData.referenceDefinition",
ReferenceType = "RefGradeLevel",
Code = "TestGrade",
IsDisabled = false,
SortIndex = 300,
DisplayName = "New Test Grade Level",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.External.IndustryData.ReferenceDefinitions.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodelsindustrydata "github.com/microsoftgraph/msgraph-beta-sdk-go/models/industrydata"
//other-imports
)
requestBody := graphmodelsindustrydata.NewReferenceDefinition()
referenceType := "RefGradeLevel"
requestBody.SetReferenceType(&referenceType)
code := "TestGrade"
requestBody.SetCode(&code)
isDisabled := false
requestBody.SetIsDisabled(&isDisabled)
sortIndex := int32(300)
requestBody.SetSortIndex(&sortIndex)
displayName := "New Test Grade Level"
requestBody.SetDisplayName(&displayName)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
referenceDefinitions, err := graphClient.External().IndustryData().ReferenceDefinitions().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.models.industrydata.ReferenceDefinition referenceDefinition = new com.microsoft.graph.beta.models.industrydata.ReferenceDefinition();
referenceDefinition.setOdataType("#microsoft.graph.industryData.referenceDefinition");
referenceDefinition.setReferenceType("RefGradeLevel");
referenceDefinition.setCode("TestGrade");
referenceDefinition.setIsDisabled(false);
referenceDefinition.setSortIndex(300);
referenceDefinition.setDisplayName("New Test Grade Level");
com.microsoft.graph.models.industrydata.ReferenceDefinition result = graphClient.external().industryData().referenceDefinitions().post(referenceDefinition);
const options = {
authProvider,
};
const client = Client.init(options);
const referenceDefinition = {
'@odata.type': '#microsoft.graph.industryData.referenceDefinition',
referenceType: 'RefGradeLevel',
code: 'TestGrade',
isDisabled: false,
sortIndex: 300,
displayName: 'New Test Grade Level'
};
await client.api('/external/industryData/referenceDefinitions')
.version('beta')
.post(referenceDefinition);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\IndustryData\ReferenceDefinition;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ReferenceDefinition();
$requestBody->setOdataType('#microsoft.graph.industryData.referenceDefinition');
$requestBody->setReferenceType('RefGradeLevel');
$requestBody->setCode('TestGrade');
$requestBody->setIsDisabled(false);
$requestBody->setSortIndex(300);
$requestBody->setDisplayName('New Test Grade Level');
$result = $graphServiceClient->external()->industryData()->referenceDefinitions()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Search
$params = @{
"@odata.type" = "#microsoft.graph.industryData.referenceDefinition"
referenceType = "RefGradeLevel"
code = "TestGrade"
isDisabled = $false
sortIndex = 300
displayName = "New Test Grade Level"
}
New-MgBetaExternalIndustryDataReferenceDefinition -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.industry_data.reference_definition import ReferenceDefinition
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ReferenceDefinition(
odata_type = "#microsoft.graph.industryData.referenceDefinition",
reference_type = "RefGradeLevel",
code = "TestGrade",
is_disabled = False,
sort_index = 300,
display_name = "New Test Grade Level",
)
result = await graph_client.external.industry_data.reference_definitions.post(request_body)
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"
}