Partager via


Tables de CustomAPI

Les données qui définissent des API personnalisées se situent dans les tables/entités suivantes :

Les sections de cet article fournissent des informations détaillées sur les valeurs de colonne que vous utilisez le plus.

Ce diagramme montre comment les tables sont liées à ces tables et d’autres :

Diagramme montrant les relations entre les tables.

La relation avec la table CatalogAssignment permet d’utiliser une API personnalisée avec des événements métier Microsoft Dataverse. Plus d’informations : tables Catalog et CatalogAssignment.

Récupérer des données sur les API personnalisées

Vous pouvez utiliser les requêtes suivantes pour récupérer des données sur les API personnalisées.

Pour plus d’informations, consultez Interroger les données à l’aide de l’API web

GET [Organization URI]/api/data/v9.1/customapis?$select=
    uniquename,
    allowedcustomprocessingsteptype,
    bindingtype,
    boundentitylogicalname,
    description,
    displayname,
    executeprivilegename,
    iscustomizable,
    isfunction,
    isprivate,
    workflowsdkstepenabled
  &$expand=
  CustomAPIRequestParameters($select=
    uniquename,
    name,
    description,
    displayname,
    type,
    logicalentityname,
    iscustomizable,
    isoptional),
  CustomAPIResponseProperties($select=
    uniquename,
    name,
    description,
    displayname,
    iscustomizable,
    type,
    logicalentityname),
  PluginTypeId($select=
    plugintypeid,
    typename,
    version,
    name,
    assemblyname)

Colonnes de table d’API personnalisées

Le tableau suivant inclut les colonnes sélectionnées d’une table d’API personnalisée que vous pouvez définir.

Nom complet
Nom du schéma
Nom logique
Type Descriptif
Type d’étape de traitement personnalisé autorisé
AllowedCustomProcessingStepType
allowedcustomprocessingsteptype
Choix
Liste déroulante
  • Valeur : 0
    Étiquette : Aucun
    Signification : Aucune étape de traitement personnalisée n’est autorisée.
  • Valeur: 1
    Étiquette : Asynchrone uniquement
    Signification : seules les étapes de traitement personnalisée asynchrones autorisées
  • Valeur: 2
    Étiquette : Synchrone et asynchrone
    Signification : Aucune restriction. Les plug-ins tiers peuvent ajouter une logique synchrone pour modifier le comportement du message.
Voir Sélectionner un type d’étape de traitement personnalisé
Impossible de modifier une fois qu’il est enregistré.
Type de liaison
BindingType
bindingtype
Choix
Liste déroulante
  • Valeur : 0 Étiquette : Globale
  • Valeur : 1 étiquette : entité
  • Valeur : 2 Étiquette : EntityCollection
Voir Sélectionner un type de liaison
Impossible de modifier une fois qu’il est enregistré.
Nom logique de l’entité liée
BoundEntityLogicalName
boundentitylogicalname
Texto
Chaîne
Nom logique de la table liée à l’API personnalisée s’il n’est pas global.
Impossible de modifier une fois qu’il est enregistré.
API personnalisée
CustomAPIId
customapiid
Identificateur unique
GUID
Identificateur unique pour les instances d’API personnalisées
Impossible de modifier une fois qu’il est enregistré.
Description
Description
description
Texto
Chaîne
Description localisée pour cette API personnalisée. Utilisez cette valeur lorsque le message est visible dans une application. Par exemple, en tant que Info-bulle.
Nom d’affichage
DisplayName
displayname
Texto
Chaîne
Nom d'affichage localisé pour cette API personnalisée. Utilisez cette valeur lorsque le message est visible dans une application.
Nom du privilège d’exécution
ExecutePrivilegeName
executeprivilegename
Texto
Chaîne
(Facultatif) Nom du privilège qui autorise l’exécution de l’API personnalisée. Voir : Sécuriser votre API personnalisée avec un privilège
Est personnalisable
IsCustomizable
iscustomizable
ManagedProperty Indique si l’API personnalisée peut être personnalisée ou supprimée lors d’une partie d’une solution managée.
Est une fonction
IsFunction
isfunction
Oui/non
Booléen
  • Valeur : 0 Étiquette : Non
  • Valeur : 1 Étiquette : Oui
Voir Quand créer une fonction
Impossible de modifier une fois qu’il est enregistré.
Est privé
IsPrivate
isprivate
Oui/non
Booléen
  • Valeur : 0 Étiquette : Non
  • Valeur : 1 Étiquette : Oui
Voir Quand rendre votre API personnalisée privée
Nom
Name
name
Texto
Chaîne
Nom principal de l’API personnalisée. Cette valeur s’affiche dans la liste des API personnalisées lorsqu’elles sont affichées dans la solution.
Owner
OwnerId
ownerid
Propriétaire Référence à l’utilisateur ou à l’équipe propriétaire de l’API.
Type de plug-in
PluginTypeId
plugintypeid
Recherche Référence au type de plug-in qui fournit l’opération principale pour cette API personnalisée. Voir : Utiliser un plug-in pour inclure une logique dans votre API personnalisée
Nom unique
UniqueName
uniquename
Texto
Chaîne
Nom unique de l’API personnalisée. Cette valeur est le nom du message créé.
Cette valeur doit inclure un préfixe de personnalisation qui correspond au jeu de préfixes de votre éditeur de solution.
Cette valeur ne peut contenir aucun caractère spécial.
Impossible de modifier une fois qu’il est enregistré.
Activé pour le workflow
WorkflowSdkStepEnabled
workflowsdkstepenabled
Oui/non
Booléen
Indique si l’API personnalisée est activée en tant qu’action de flux de travail. Voir : Utiliser une API personnalisée dans un flux de travail
Impossible de modifier une fois qu’il est enregistré.

Colonnes de la table CustomAPIRequestParameter

Une API personnalisée n’est pas nécessaire pour avoir des paramètres. Il n’existe aucun ordre spécifié pour les paramètres. Ils sont identifiés par nom.

Un paramètre est lié à une API personnalisée unique. Vous ne pouvez pas définir plusieurs API personnalisées pour utiliser la même définition de paramètre. Vous pouvez définir plusieurs paramètres de requête avec la même UniqueName valeur s’ils sont utilisés par différentes API personnalisées.

Note

Si vous définissez une table liée pour votre API personnalisée, le paramètre de requête sera généré pour vous. Vous n’avez pas besoin de créer un paramètre d’entrée pour la table lorsque l’API personnalisée est liée à une table. Plus d’informations : Sélectionnez un type de liaison

Le tableau suivant inclut des colonnes (attributs) de la table de paramètres de requête d’API personnalisée que vous pouvez définir.

Nom complet
Nom du schéma
Nom logique
Type Descriptif
paramètre de requête d’API personnalisé
CustomAPIRequestParameterId
customapirequestparameterid
Identificateur unique
GUID
Identificateur unique pour les instances de paramètres de requête d’API personnalisées.
Impossible de modifier une fois qu’il est enregistré.
API personnalisée
CustomAPIId
customapiid
Recherche Identificateur unique de l’API personnalisée à laquelle ce paramètre de demande d’API personnalisé est associé.
Impossible de modifier une fois qu’il est enregistré.
Description
Description
description
Texto
Chaîne
Description localisée pour les instances de paramètres de requête d’API personnalisées. Utilisez cette valeur lorsque le paramètre de message est visible dans une application. Par exemple, en tant que Info-bulle.
Nom d’affichage
DisplayName
displayname
Texto
Chaîne
Nom d'affichage localisé pour les instances de paramètres de requête d’API personnalisées. Utilisez cette valeur lorsque le paramètre de message est visible dans une application.
Est personnalisable
IsCustomizable
iscustomizable
ManagedProperty Indique si le paramètre de requête d’API personnalisé peut être personnalisé ou supprimé lors d’une partie d’une solution managée. Voir Personnalisation de l’API
Est facultatif
IsOptional
isoptional
Oui/non
Booléen
Indique si le paramètre de requête d’API personnalisé est facultatif. S’il n’est pas facultatif, il est nécessaire de passer une valeur pour ce paramètre lors de l’utilisation du message.
  • Valeur : 0 Étiquette : Non
  • Valeur : 1 Étiquette : Oui
Impossible de modifier une fois qu’il est enregistré.
Nom d’entité logique
LogicalEntityName
logicalentityname
Texto
Chaîne
Nom logique de la table liée au paramètre de requête d’API personnalisé.
Impossible de modifier une fois qu’il est enregistré.
Nom
Name
name
Texto
Chaîne
Nom principal du paramètre de requête d’API personnalisée. Cette valeur s’affiche dans la liste des paramètres de requête d’API personnalisés lorsqu’elles sont affichées dans la solution. Utilisez cette valeur pour différencier ce paramètre des autres utilisateurs qui partagent un nom unique commun.
Cette convention d’affectation de noms est recommandée : {custom API Unique Name}.{Parameter UniqueName}
Owner
OwnerId
ownerid
Propriétaire Référence à l’utilisateur ou à l’équipe propriétaire de l’API.
Type
Type
type
Choix
Liste déroulante
Type de données du paramètre de requête d’API personnalisée.
  • Valeur : 0 Étiquette : Boolean
  • Valeur : 1 Étiquette : DateTime
  • Valeur : 2 Étiquette : Décimal
  • Valeur : 3 Étiquette : Entité
  • Valeur : 4 Étiquette : EntityCollection
  • Valeur : 5 Étiquette : EntityReference
  • Valeur : 6 Étiquette : Float
  • Valeur : 7 Étiquette : Entier
  • Valeur : 8 Libellé : Argent
  • Valeur : 9 Étiquette : Liste de choix
  • Valeur : 10 Étiquette : Chaîne
  • Valeur : 11 Étiquette : StringArray
  • Valeur : 12 Étiquette : Guid
Impossible de modifier une fois qu’il est enregistré.
Nom unique
UniqueName
uniquename
Texto
Chaîne
Nom unique pour le paramètre de requête d’API personnalisée. Cette valeur est le nom du paramètre lorsque vous appelez l’API personnalisée.
Cette valeur ne peut contenir aucun caractère spécial.
Impossible de modifier une fois qu’il est enregistré.

Colonnes de la table CustomAPIResponseProperty

L’objet retourné pour votre message d’API personnalisé inclut toutes les propriétés de réponse que vous définissez. Il n’est pas nécessaire qu’une action d’API personnalisée retourne une valeur, mais elle doit retourner une valeur si elle est définie en tant que fonction.

S’il n’existe qu’une seule propriété de réponse Entity ou EntityCollection définie, la réponse est de ce type. S’il existe plusieurs paramètres ou un ou plusieurs paramètres d’un type simple, l’API retourne un type complexe où chaque propriété de réponse est une propriété de ce type complexe.

Par exemple, si votre nom unique d’API personnalisé est sample_CustomAPIExample, il retourne un type complexe nommé sample_CustomAPIExampleResponse avec des propriétés pour chaque propriété de réponse que vous définissez.

Le tableau suivant inclut des colonnes (attributs) de la table de propriétés de réponse de l’API personnalisée que vous pouvez définir.

Nom complet
Nom du schéma
Nom logique
Type Descriptif
Propriété de réponse API personnalisée
CustomAPIResponsePropertyId
customapiresponsepropertyid
Identificateur unique
GUID
Identificateur unique pour les instances de propriété de réponse d’API personnalisées.
Impossible de modifier une fois qu’il est enregistré.
API personnalisée
CustomAPIId
customapiid
Recherche Identificateur unique de l’API personnalisée à laquelle cette propriété de réponse d’API personnalisée est associée.
Impossible de modifier une fois qu’il est enregistré.
Description
Description
description
Texto
Chaîne
Description localisée pour les instances de propriété de réponse d’API personnalisées. Utilisez cette valeur lorsque le paramètre de message est visible dans une application. Par exemple, en tant que Info-bulle.
Nom d’affichage
DisplayName
displayname
Texto
Chaîne
Nom d'affichage localisé pour les instances de propriété de réponse d’API personnalisée. Utilisez cette valeur lorsque le paramètre de message est visible dans une application.
Est personnalisable
IsCustomizable
iscustomizable
ManagedProperty Indique si la propriété de réponse d’API personnalisée peut être personnalisée ou supprimée lors d’une partie d’une solution managée.
Nom d’entité logique
LogicalEntityName
logicalentityname
Texto
Chaîne
Lorsque Entity ou EntityReference sont sélectionnés comme type, vous pouvez spécifier le nom logique de la table liée à la propriété de réponse d’API personnalisée. Vous ne pouvez pas spécifier de nom d’entité logique lorsque vous choisissez EntityCollection comme type.
Impossible de modifier une fois qu’il est enregistré.
Nom
Name
name
Chaîne Nom principal de la propriété de réponse d’API personnalisée. Cette valeur s’affiche dans la liste des paramètres de requête d’API personnalisés lorsqu’elles sont affichées dans la solution. Utilisez cette valeur pour différencier ce paramètre des autres utilisateurs qui partagent un nom unique commun.
Cette convention d’affectation de noms est recommandée : {custom API Unique Name}.{Property UniqueName}
Owner
OwnerId
ownerid
Propriétaire Référence à l’utilisateur ou à l’équipe propriétaire de l’API.
Type
Type
type
Liste déroulante Type de données de la propriété de réponse d’API personnalisée
  • Valeur : 0 Étiquette : Boolean
  • Valeur : 1 Étiquette : DateTime
  • Valeur : 2 Étiquette : Décimal
  • Valeur : 3 Étiquette : Entité
  • Valeur : 4 Étiquette : EntityCollection
  • Valeur : 5 Étiquette : EntityReference
  • Valeur : 6 Étiquette : Float
  • Valeur : 7 Étiquette : Entier
  • Valeur : 8 Libellé : Argent
  • Valeur : 9 Étiquette : Liste de choix
  • Valeur : 10 Étiquette : Chaîne
  • Valeur : 11 Étiquette : StringArray
  • Valeur : 12 Étiquette : Guid
Impossible de modifier une fois qu’il est enregistré.
Nom unique
UniqueName
uniquename
Texto
Chaîne
Nom unique pour la propriété de réponse de l’API personnalisée. Cette valeur est le nom du paramètre lorsque vous appelez l’API personnalisée.
Cette valeur ne peut contenir aucun caractère spécial.
Impossible de modifier une fois qu’il est enregistré.

Voir aussi

Créer et utiliser des API personnalisées
Créez une API personnalisée à l’aide de l’outil d’enregistrement de plug-in
Créer une API personnalisée dans Power Apps
Créer une API personnalisée avec du code
Créer une API personnalisée avec des fichiers de solution
Créer vos propres messages