referenceDefinition を作成する

[アーティクル]
06/12/2024

名前空間: microsoft.graph.industryData

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

新しい referenceDefinition オブジェクトを作成します。

referenceDefinition オブジェクトは 、入力データを検証のために標準化された参照型の値に関連付けます。

次の参照型を、ソースデータとより適切に一致する他のコードと共に拡張できます。

名前	ReferenceType
学問	RefAcademicSubject
人口統計: 人種	RefRace
人口統計: 民族性	RefEthnicity
成績レベル	RefGradeLevel
組織の種類	RefOrgType
人物フラグ	RefPersonFlagType

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	❌	❌	❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類	最小特権アクセス許可	より高い特権のアクセス許可
委任 (職場または学校のアカウント)	IndustryData-ReferenceDefinition.ReadWrite.All	注意事項なし。
委任 (個人用 Microsoft アカウント)	サポートされていません。	サポートされていません。
アプリケーション	IndustryData-ReferenceDefinition.ReadWrite.All	注意事項なし。

HTTP 要求

POST /external/industryData/referenceDefinitions

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須です。認証と認可についての詳細をご覧ください。
Content-Type	application/json. 必須です。

要求本文

要求本文で、 referenceDefinition オブジェクトの JSON 表現を指定します。

次の表に、 referenceDefinition オブジェクトを作成するために必要なプロパティと省略可能なプロパティを示します。

プロパティ	種類	説明
referenceType	String	コレクション列挙値のカテゴリ型。必須です。
displayName	String	ユーザーインターフェイスに表示するための参照コード値の人間が判読できる表現。省略可能。
code	String	定義のコード値。 referenceType 内で一意である必要があります。必須です。
isDisabled	ブール型	定義が無効かどうかを示します。必須です。
sortIndex	Int32	定義をユーザーに提示する順序を指定するインデックス。 referenceType 内で一意である必要があります。必須。

応答

成功した場合、このメソッドは応答コード 201 Created と、応答本文に microsoft.graph.industryData.referenceDefinition オブジェクトを返します。

例

要求

次の例は要求を示しています。

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

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用可能なすべての型、プロパティ、API がサポートされているわけではありません。 SDK を使用してベータ API にアクセスする方法の詳細については、「ベータ API で Microsoft Graph SDK を使用する」を参照してください。

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、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"\
}\
'

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、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)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、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);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、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);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、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();

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、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

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.industry_data.reference_definition import ReferenceDefinition

graph_client = GraphServiceClient(credentials, scopes)

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)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

次の例は応答を示しています。

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

次の方法で共有

referenceDefinition を作成する

アクセス許可

HTTP 要求

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

フィードバック

その他のリソース