Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
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.
- Colonnes de table d’API personnalisées
- Colonnes de table CustomAPIRequestParameter
- Colonnes de table CustomAPIResponseProperty
Ce diagramme montre comment les tables sont liées à ces tables et d’autres :
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éAllowedCustomProcessingStepTypeallowedcustomprocessingsteptype |
Choix Liste déroulante |
Impossible de modifier une fois qu’il est enregistré. |
Type de liaisonBindingTypebindingtype |
Choix Liste déroulante |
Impossible de modifier une fois qu’il est enregistré. |
Nom logique de l’entité liéeBoundEntityLogicalNameboundentitylogicalname |
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éeCustomAPIIdcustomapiid |
Identificateur unique GUID |
Identificateur unique pour les instances d’API personnalisées Impossible de modifier une fois qu’il est enregistré. |
DescriptionDescriptiondescription |
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’affichageDisplayNamedisplayname |
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écutionExecutePrivilegeNameexecuteprivilegename |
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 personnalisableIsCustomizableiscustomizable |
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 fonctionIsFunctionisfunction |
Oui/non Booléen |
Impossible de modifier une fois qu’il est enregistré. |
Est privéIsPrivateisprivate |
Oui/non Booléen |
|
NomNamename |
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. |
OwnerOwnerIdownerid |
Propriétaire | Référence à l’utilisateur ou à l’équipe propriétaire de l’API. |
Type de plug-inPluginTypeIdplugintypeid |
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 uniqueUniqueNameuniquename |
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 workflowWorkflowSdkStepEnabledworkflowsdkstepenabled |
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éCustomAPIRequestParameterIdcustomapirequestparameterid |
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 CustomAPIIdcustomapiid |
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é. |
DescriptionDescriptiondescription |
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 DisplayNamedisplayname |
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 personnalisableIsCustomizableiscustomizable |
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 facultatifIsOptionalisoptional |
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.
|
Nom d’entité logiqueLogicalEntityNamelogicalentityname |
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é. |
NomNamename |
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 OwnerIdownerid |
Propriétaire | Référence à l’utilisateur ou à l’équipe propriétaire de l’API. |
TypeTypetype |
Choix Liste déroulante |
Type de données du paramètre de requête d’API personnalisée.
|
Nom unique UniqueNameuniquename |
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éeCustomAPIResponsePropertyIdcustomapiresponsepropertyid |
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 CustomAPIIdcustomapiid |
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é. |
DescriptionDescriptiondescription |
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 DisplayNamedisplayname |
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 personnalisableIsCustomizableiscustomizable |
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é logiqueLogicalEntityNamelogicalentityname |
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é. |
NomNamename |
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 OwnerIdownerid |
Propriétaire | Référence à l’utilisateur ou à l’équipe propriétaire de l’API. |
TypeTypetype |
Liste déroulante | Type de données de la propriété de réponse d’API personnalisée
|
Nom unique UniqueNameuniquename |
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