Créer ou mettre à jour un schéma

Espace de noms : microsoft.graph.externalConnectors

Créez ou mettez à jour un schéma existant pour une connexion Recherche Microsoft.

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

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

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

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) ExternalConnection.ReadWrite.OwnedBy ExternalConnection.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application ExternalConnection.ReadWrite.OwnedBy ExternalConnection.ReadWrite.All

Requête HTTP

PATCH /external/connections/{id}/schema

En-têtes de demande

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

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON d’un objet de schéma .

Lorsque vous inscrivez un schéma d’élément personnalisé, la propriétébaseTypedoit être définie sur microsoft.graph.externalItemet doit contenir la propriété properties. L’objet propertiesdoit contenir au moins une propriété, jusqu’à un maximum de 128.

Réponse

Si elle réussit, cette méthode renvoie un 202 Accepted code de réponse et une URL dans l’en-tête Location de réponse qui peuvent être utilisés pour obtenir l’état de l’opération.

Note: La création du schéma peut prendre entre 5 et 15 minutes. Nous vous recommandons d’utiliser l’URL dans l’en-tête Location de réponse pour obtenir l’état de l’opération.

Exemples

Demande

L’exemple suivant montre une demande d’inscription ou de mise à jour d’un schéma personnalisé existant de façon asynchrone.

PATCH https://graph.microsoft.com/v1.0/external/connections/contosohr/schema
Content-type: application/json

{
  "baseType": "microsoft.graph.externalItem",
  "properties": [
    {
      "name": "ticketTitle",
      "type": "String",
      "isSearchable": "true",
      "isRetrievable": "true",
      "labels": [
        "title"
      ]
    },
    {
      "name": "priority",
      "type": "String",
      "isQueryable": "true",
      "isRetrievable": "true",
      "isSearchable": "false"
    },
    {
      "name": "assignee",
      "type": "String",
      "isRetrievable": "true"
    }
  ]
}

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 202 Accepted
Location: https://graph.microsoft.com/v1.0/external/connections/contosohr/operations/616bfeed-666f-4ce0-8cd9-058939010bfc