ReferenzDefinition erstellen

Namespace: microsoft.graph.industryData

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Erstellen Sie ein neues referenceDefinition-Objekt .

referenceDefinition-Objekte ordnen eingehende Daten standardisierten Referenztypenwerten zur Validierung zu.

Sie können die folgenden Verweistypen mit anderen Codes erweitern, die besser mit Ihren Quelldaten übereinstimmen.

Name ReferenceType
Akademische Fächer RefAcademicSubject
Demografie: Rasse RefRace
Demografisch: Ethnische Zugehörigkeit RefEthnicity
Jahrgangsstufe RefGradeLevel
Organisationstypen RefOrgType
Personenflags RefPersonFlagType

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet
✅ ❌ ❌ ❌

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) IndustryData-ReferenceDefinition.ReadWrite.All Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application IndustryData-ReferenceDefinition.ReadWrite.All Nicht verfügbar.

HTTP-Anforderung

POST /external/industryData/referenceDefinitions

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung des referenceDefinition-Objekts an.

In der folgenden Tabelle sind die erforderlichen und optionalen Eigenschaften zum Erstellen eines referenceDefinition-Objekts aufgeführt.

Eigenschaft Typ Beschreibung
referenceType Zeichenfolge Der kategoriale Typ für eine Auflistung mit Enumerationswerten. Erforderlich.
displayName Zeichenfolge Eine lesbare Darstellung des Referenzcodewerts zur Anzeige in einer Benutzeroberfläche. Optional.
code Zeichenfolge Codewert für die Definition. Muss innerhalb des referenceType eindeutig sein. Erforderlich.
isDisabled Boolean Gibt an, ob die Definition deaktiviert ist. Erforderlich.
sortIndex Int32 Der Index, der die Reihenfolge angibt, in der dem Benutzer die Definition angezeigt werden soll. Muss innerhalb des referenceType eindeutig sein. Erforderlich.

Antwort

Bei erfolgreicher Ausführung gibt diese Methode einen 201 Created Antwortcode und ein microsoft.graph.industryData.referenceDefinition-Objekt im Antworttext zurück.

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

Antwort

Das folgende Beispiel zeigt die Antwort.

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