Créer une référenceDéfinition

Espace de noms : microsoft.graph.industryData

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Créez un objet referenceDefinition .

Les objets referenceDefinition associent les données entrantes à des valeurs de types de référence normalisées à des fins de validation.

Vous pouvez étendre les types de référence suivants avec d’autres codes qui s’alignent mieux sur vos données sources.

Nom ReferenceType
Matières académiques RefAcademicSubject
Démographie : race RefRace (en anglais)
Démographie : Ethnicité RefEthnicity
Niveau scolaire Niveau de réf
Types d’organisation RefOrgType (Type de référence)
Indicateurs de personne RefPersonFlagType

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ❌ ❌ ❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) IndustryData-ReferenceDefinition.ReadWrite.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application IndustryData-ReferenceDefinition.ReadWrite.All Non disponible.

Requête HTTP

POST /external/industryData/referenceDefinitions

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet referenceDefinition .

Le tableau suivant répertorie les propriétés requises et facultatives pour la création d’un objet referenceDefinition .

Propriété Type Description
referenceType String Type catégorique d’une collection de valeurs énumérées. Obligatoire.
displayName String Représentation lisible de la valeur de code de référence à afficher dans une interface utilisateur. Facultatif.
code String Valeur de code de la définition. Doit être unique dans le referenceType. Obligatoire.
isDisabled Booléen Indique si la définition est désactivée. Obligatoire.
sortIndex Int32 Index qui spécifie l’ordre de présentation de la définition à l’utilisateur. Doit être unique dans le referenceType. Obligatoire.

Réponse

En cas de réussite, cette méthode renvoie un code de 201 Created réponse et un objet microsoft.graph.industryData.referenceDefinition dans le corps de la réponse.

Exemples

Demande

L’exemple suivant illustre une demande.

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

Réponse

L’exemple suivant illustre la réponse.

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