referenceDefinition の作成

名前空間: microsoft.graph.industryData

重要

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

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

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

以下の参照型は、ソース データにより適した他のコードで拡張できます。

名前 ReferenceType
学問科目 RefAcademicSubject
ユーザー属性: 人種 RefRace
人口統計: 民族 RefEthnicity
Grade Level 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"
}

応答

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

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