Creación de referenceDefinition

Artículo
06/28/2024

Espacio de nombres: microsoft.graph.industryData

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Cree un nuevo objeto referenceDefinition .

Los objetos referenceDefinition asocian datos entrantes con valores de tipos de referencia estandarizados para la validación.

Puede ampliar los siguientes tipos de referencia con otros códigos que mejor se alineen con los datos de origen.

Nombre	ReferenceType
Temas académicos	RefAcademicSubject
Datos demográficos: raza	RefRace
Demográfico: origen étnico	RefEthnicity
Nivel de grado	RefGradeLevel
Tipos de organización	RefOrgType
Marcas de persona	RefPersonFlagType

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global	Gobierno de EE. UU. L4	Us Government L5 (DOD)	China operada por 21Vianet
✅	❌	❌	❌

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permisos con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	IndustryData-ReferenceDefinition.ReadWrite.All	No disponible.
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	IndustryData-ReferenceDefinition.ReadWrite.All	No disponible.

Solicitud HTTP

POST /external/industryData/referenceDefinitions

Encabezados de solicitud

Nombre	Descripción
Authorization	{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type	application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una representación JSON del objeto referenceDefinition .

En la tabla siguiente se enumeran las propiedades necesarias y opcionales para crear un objeto referenceDefinition .

Propiedad	Tipo	Descripción
referenceType	Cadena	Tipo categórico de una colección de valores enumerados. Obligatorio.
displayName	Cadena	Representación legible del valor de código de referencia para mostrar en una interfaz de usuario. Opcional.
código	Cadena	Valor de código para la definición. Debe ser único en referenceType. Obligatorio.
isDisabled	Booleano	Indica si la definición está deshabilitada. Obligatorio.
sortIndex	Int32	Índice que especifica el orden en que se va a presentar la definición al usuario. Debe ser único en referenceType. Obligatorio.

Respuesta

Si se ejecuta correctamente, este método devuelve un 201 Created código de respuesta y un objeto microsoft.graph.industryData.referenceDefinition en el cuerpo de la respuesta.

Ejemplos

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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);

Importante

Los SDK de Microsoft Graph usan la versión v1.0 de la API de manera predeterminada y no admiten todos los tipos, propiedades y API disponibles en la versión beta. Para obtener más información sobre cómo acceder a la API beta con el SDK, consulte Uso de los SDK de Microsoft Graph con la API beta.

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.



mgc-beta external industry-data reference-definitions create --body '{\
  "@odata.type": "#microsoft.graph.industryData.referenceDefinition",\
  "referenceType": "RefGradeLevel",\
  "code": "TestGrade",\
  "isDisabled": false,\
  "sortIndex": 300,\
  "displayName": "New Test Grade Level"\
}\
'

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.



// 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)

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


// 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);

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


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);

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


<?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();

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


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

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


# 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)

Importante

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

En el ejemplo siguiente se muestra la respuesta.

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"
}

Compartir a través de

Creación de referenceDefinition

Permissions

Solicitud HTTP

Encabezados de solicitud

Cuerpo de la solicitud

Respuesta

Ejemplos

Solicitud

Respuesta

Comentarios

Recursos adicionales