名前空間: 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 |
文字列 |
コレクション列挙値のカテゴリ型。 必須です。 |
| displayName |
文字列 |
ユーザー インターフェイスに表示するための参照コード値の人間が判読できる表現。 省略可能。 |
| code |
文字列 |
定義のコード値。 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);
// 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)
応答
次の例は応答を示しています。
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"
}