Tables CustomAPI

Article
03/14/2024

Les données qui définissent les API personnalisées se trouvent 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 personnalisée
Colonnes de la table CustomAPIRequestParameter
Colonnes de table la CustomAPIResponseProperty

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

Diagramme illustrant les relations entre les tables.

La relation avec la table CatalogAssignment permet d’utiliser l’API personnalisée avec les événements d’entreprise Microsoft Dataverse. Plus d’information : Tables Catalog et CatalogAssignment.

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

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

Plus d’informations : 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)

Pour plus d’informations : Générer des requêtes avec QueryExpression

string conn = $@"
    Url = {url};
    AuthType = OAuth;
    UserName = {userName};
    Password = {password};
    AppId = 51f81489-12ee-4a9e-aaae-a2591f45987d;
    RedirectUri = app://58145B91-0C36-4500-8554-080854F2AC97;
    LoginPrompt=Auto;
    RequireNewInstance = True";

// using (var svc = new ServiceClient(conn))
using (var svc = new CrmServiceClient(conn))
{

    // Instantiate QueryExpression query
    var query = new QueryExpression("customapi");

    // Add columns to query.ColumnSet
    query.ColumnSet.AddColumns("isprivate",
    "description",
    "displayname",
    "executeprivilegename",
    "iscustomizable",
    "isfunction",
    "allowedcustomprocessingsteptype",
    "boundentitylogicalname",
    "bindingtype",
    "uniquename",
    "workflowsdkstepenabled");

    // Add link-entity req
    var req = query.AddLink("customapirequestparameter",
    "customapiid",
    "customapiid",
    JoinOperator.LeftOuter);
    req.EntityAlias = "req";

    // Add columns to req.Columns
    req.Columns.AddColumns("description",
    "displayname",
    "iscustomizable",
    "logicalentityname",
    "name",
    "uniquename",
    "type",
    "isoptional");

    // Add link-entity query_customapiresponseproperty
    var query_customapiresponseproperty = query
        .AddLink("customapiresponseproperty",
    "customapiid",
    "customapiid",
    JoinOperator.LeftOuter);

    // Add columns to query_customapiresponseproperty.Columns
    query_customapiresponseproperty.Columns
        .AddColumns("description",
    "displayname",
    "iscustomizable",
    "logicalentityname",
    "name",
    "uniquename",
    "type");

    // Add link-entity plugintype
    var plugintype = query.AddLink("plugintype",
    "plugintypeid",
    "plugintypeid",
    JoinOperator.LeftOuter);

    plugintype.EntityAlias = "plugintype";

    // Add columns to plugintype.Columns
    plugintype.Columns.AddColumns("name",
    "assemblyname",
    "version",
    "plugintypeid",
    "typename");

    EntityCollection results = svc.RetrieveMultiple(query);

    Console.WriteLine("Press any key to exit.");
    Console.ReadLine();
}

Plus d’informations : Interroger des données à l’aide de FetchXml

<fetch>
  <entity name='customapi' >
    <attribute name='isprivate' />
    <attribute name='description' />
    <attribute name='displayname' />
    <attribute name='executeprivilegename' />
    <attribute name='iscustomizable' />
    <attribute name='isfunction' />
    <attribute name='allowedcustomprocessingsteptype' />
    <attribute name='boundentitylogicalname' />
    <attribute name='bindingtype' />
    <attribute name='uniquename' />
    <attribute name='workflowsdkstepenabled' />
    <link-entity name='customapirequestparameter' from='customapiid' to='customapiid' link-type='outer' alias='req' >
      <attribute name='description' />
      <attribute name='displayname' />
      <attribute name='iscustomizable' />
      <attribute name='logicalentityname' />
      <attribute name='name' />
      <attribute name='uniquename' />
      <attribute name='type' />
      <attribute name='isoptional' />
    </link-entity>
    <link-entity name='customapiresponseproperty' from='customapiid' to='customapiid' link-type='outer' >
      <attribute name='description' />
      <attribute name='displayname' />
      <attribute name='iscustomizable' />
      <attribute name='logicalentityname' />
      <attribute name='name' />
      <attribute name='uniquename' />
      <attribute name='type' />
    </link-entity>
    <link-entity name='plugintype' from='plugintypeid' to='plugintypeid' link-type='outer' alias='plugintype' >
      <attribute name='name' />
      <attribute name='assemblyname' />
      <attribute name='version' />
      <attribute name='plugintypeid' />
      <attribute name='typename' />
    </link-entity>
  </entity>
</fetch>

Pour plus d’informations : Utiliser SQL pour rechercher des données (Version préliminaire)

SELECT api.customapiid,
       api.uniquename,
       api.allowedcustomprocessingsteptype,
       api.bindingtype,
       api.boundentitylogicalname,
       api.description,
       api.displayname,
       api.executeprivilegename,
       api.iscustomizable,
       api.isfunction,
       api.isprivate,
       api.workflowsdkstepenabled,
       req.customapirequestparameterid,
       req.uniquename,
       req.name,
       req.description,
       req.displayname,
       req.type,
       req.logicalentityname,
       req.iscustomizable,
       req.isoptional,
       resp.customapiresponsepropertyid,
       resp.uniquename,
       resp.name,
       resp.description,
       resp.iscustomizable,
       resp.type,
       resp.logicalentityname,
       type.plugintypeid,
       type.typename,
       type.version,
       type.name,
       type.assemblyname
FROM   customapi AS api
       LEFT JOIN
       customapirequestparameter AS req
       ON api.customapiid = req.customapiid
       LEFT JOIN
       customapiresponseproperty AS resp
       ON api.customapiid = resp.customapiid
       LEFT JOIN
       plugintype AS type
       ON api.plugintypeid = type.plugintypeid

Colonnes de table d’API personnalisée

La table suivante inclut les colonnes sélectionnées d′une table d’API personnalisée que vous pouvez définir.

Nom d′affichage Nom du schéma Nom logique	Type	Description
Type d’étape de traitement personnalisée autorisée `AllowedCustomProcessingStepType` `allowedcustomprocessingsteptype`	Option Picklist	Valeur : 0 Étiquette : Aucune Signification : Aucune étape de traitement personnalisée autorisée. Valeur : 1 Étiquette : Asynchrone uniquement Signification : Seules les étapes de traitement personnalisée asynchrones Valeur : 2 Étiquette : Synchrone et asynchrone Signification : Pas de 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ée Modification impossible après l’enregistrement
Type de liaison `BindingType` `bindingtype`	Option Picklist	Valeur : 0 Étiquette : Global Valeur : 1 Étiquette : Entité Valeur : 2 Étiquette : EntityCollection Voir Sélectionnez un type de liaison Modification impossible après l’enregistrement
Nom logique de l’entité liée `BoundEntityLogicalName` `boundentitylogicalname`	Texte Chaîne	Nom logique de la table liée à l’API personnalisée si autre que Global. Modification impossible après l’enregistrement
API personnalisée `CustomAPIId` `customapiid`	Identificateur unique Guid	Identificateur unique des instances d’API personnalisées Modification impossible après l’enregistrement
Description `Description` `description`	Texte 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`	Texte 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`	Texte Chaîne	(Facultatif) Nom du privilège autorisant l’exécution de l’API personnalisée. Voir : Sécurisez 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 lorsqu’elle fait partie d’un solution gérée.
Est une fonction `IsFunction` `isfunction`	Oui/non Booléenne	Valeur : 0 Étiquette : Non Valeur : 1 Étiquette : Oui Voir Quand créer une fonction Modification impossible après l’enregistrement
Est privé `IsPrivate` `isprivate`	Oui/non Entier	Valeur : 0 Étiquette : Non Valeur : 1 Étiquette : Oui Voir Quand rendre votre API personnalisée privée
Name `Name` `name`	Texte Chaîne	Nom principal de l’API personnalisée. Cette valeur s’affiche dans la liste des API personnalisées lors de l’affichage dans la solution.
Propriétaire `OwnerId` `ownerid`	Propriétaire	Une référence à l’utilisateur ou à l’équipe propriétaire de l’API.
Type de plug-in `PluginTypeId` `plugintypeid`	Rechercher	Une référence au type de plug-in qui fournit l’opération principale à cette API personnalisée. Voir : Utiliser un plug-in pour inclure une logique dans votre API personnalisée
Nom unique `UniqueName` `uniquename`	Texte 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 préfixe défini pour votre éditeur de solutions. Cette valeur ne peut contenir aucun caractère spécial. Modification impossible après l’enregistrement
Activé pour le workflow `WorkflowSdkStepEnabled` `workflowsdkstepenabled`	Oui/non Boolean	Indique si l’API personnalisée est activée en tant qu’action de workflow. Voir : Utiliser une API personnalisée dans un workflow Modification impossible après l’enregistrement

Colonnes de table CustomAPIRequestParameter

Il n’est pas nécessaire qu’une API personnalisée contienne un paramètre. Il n’y a pas d’ordre spécifié pour les paramètres. Ils sont identifiés par leur nom.

Un paramètre est lié à une seule API personnalisée. 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 valeur UniqueName s’ils sont utilisés par des API personnalisées différentes.

Notes

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

La table suivante inclut les colonnes (attributs) de la table Paramètre de requête d’API personnalisée que vous pouvez définir.

Nom d′affichage Nom du schéma Nom logique	Type	Description
Paramètre de demande d’API personnalisée `CustomAPIRequestParameterId` `customapirequestparameterid`	Identificateur unique Guid	Identificateur unique des instances de paramètre de requête d’API personnalisée. Modification impossible après l’enregistrement
API personnalisée `CustomAPIId` `customapiid`	Lookup	Identificateur unique de l’API personnalisée à laquelle ce paramètre de requête d’API personnalisée est associé. Modification impossible après l’enregistrement
Description `Description` `description`	Texte Chaîne	Description localisée des instances de paramètre de requête d’API personnalisée. 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`	Texte Chaîne	Nom d’affichage localisé des instances de paramètre de requête 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 le paramètre de requête d’API personnalisée peut être personnalisé ou supprimé lorsqu’il fait partie d’une solution gérée. Voir Personnalisation de l’API personnalisée
Est facultatif `IsOptional` `isoptional`	Oui/non Booléen	Indique si le paramètre de requête d’API personnalisée est facultatif. S’il n’est pas facultatif, il est nécessaire de transmettre une valeur pour ce paramètre lors de l’utilisation du message. Valeur : 0 Étiquette : Non Valeur : 1 Étiquette : Oui Modification impossible après l’enregistrement
Nom logique de l’entité `LogicalEntityName` `logicalentityname`	Texte Chaîne	Nom logique de la table liée au paramètre de demande de l’API personnalisée. Modification impossible après l’enregistrement
Nom `Name` `name`	Texte Chaîne	Nom principal du paramètre de requête de l’API personnalisée. Cette valeur s’afficher dans la liste des paramètres de requête d’API personnalisée lors de l’affichage dans la solution. Utilisez cette valeur pour différencier ce paramètre des autres qui partagent un nom unique commun. Cette convention de dénomination est recommandée : `{custom API Unique Name}.{Parameter UniqueName}`
Propriétaire `OwnerId` `ownerid`	Propriétaire	Une référence à l’utilisateur ou à l’équipe propriétaire de l’API.
Type `Type` `type`	Option Picklist	Type de données du paramètre de requête de l’API personnalisée. Valeur : 0 Étiquette : Booléen Valeur : 1 Étiquette : DateHeure Valeur : 2 Étiquette : Décimal Valeur : 3 Étiquette : Entité Valeur : 4 Étiquette : EntityCollection Valeur : 5 Étiquette : EntityReference Valeur : 6 Étiquette : Flottant Valeur :7 Étiquette : Entier Valeur :8 Étiquette : Argent Valeur : 9 Étiquette : Liste de choix Valeur : 10 Étiquette : Chaîne Valeur : 11 Étiquette : StringArray Valeur : 12 Étiquette : Guid Modification impossible après l’enregistrement
Nom unique `UniqueName` `uniquename`	Texte Chaîne	Nom unique du paramètre de requête de l’API personnalisée. Cette valeur est le nom du paramètre lorsque vous appellez l’API personnalisée. Cette valeur ne peut contenir aucun caractère spécial. Modification impossible après l’enregistrement

Colonnes de table CustomAPIResponseProperty

L’objet renvoyé pour votre message d’API personnalisée inclut toutes les propriétés de réponse que vous définissez. Il n’est pas nécessaire qu’une action API personnalisée renvoie une valeur, mais elle doit renvoyer 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 renvoie un type complexe où chaque propriété de réponse est une propriété de ce type complexe.

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

La table suivante inclut les colonnes (attributs) de la table Propriété de réponse d’API personnalisée que vous pouvez définir.

Nom d′affichage Nom du schéma Nom logique	Type	Description
Propriété de réponse de l’API personnalisée `CustomAPIResponsePropertyId` `customapiresponsepropertyid`	Identificateur unique Guid	Identificateur unique des instances de propriété de réponse de l’API personnalisée. Modification impossible après l’enregistrement
API personnalisée `CustomAPIId` `customapiid`	Lookup	Identificateur unique de l’API personnalisée à laquelle cette propriété de réponse de l’API personnalisée est associée. Modification impossible après l’enregistrement
Description `Description` `description`	Texte Chaîne	Description localisée des instances de propriété de réponse de l’API personnalisée. 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`	Texte Chaîne	Nom d’affichage localisé des instances de propriété de réponse de l’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 lorsqu’elle fait partie d’un solution gérée.
Nom logique de l’entité `LogicalEntityName` `logicalentityname`	Texte Chaîne	Si 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 un Nom d’entité logique si vous sélectionnez EntityCollection comme Type. Modification impossible après l’enregistrement
Name `Name` `name`	Chaîne	Nom principal de la propriété de réponse de l’API personnalisée. Cette valeur s’afficher dans la liste des paramètres de requête d’API personnalisée lors de l’affichage dans la solution. Utilisez cette valeur pour différencier ce paramètre des autres qui partagent un nom unique commun. Cette convention de dénomination est recommandée : `{custom API Unique Name}.{Property UniqueName}`
Propriétaire `OwnerId` `ownerid`	Propriétaire	Une référence à l’utilisateur ou à l’équipe propriétaire de l’API.
Type `Type` `type`	Picklist	Type de données de la propriété de réponse d’API personnalisée Valeur : 0 Étiquette : Booléen Valeur : 1 Étiquette : DateHeure Valeur : 2 Étiquette : Décimal Valeur : 3 Étiquette : Entité Valeur : 4 Étiquette : EntityCollection Valeur : 5 Étiquette : EntityReference Valeur : 6 Étiquette : Flottant Valeur :7 Étiquette : Entier Valeur :8 Étiquette : Argent Valeur : 9 Étiquette : Liste de choix Valeur : 10 Étiquette : Chaîne Valeur : 11 Étiquette : StringArray Valeur : 12 Étiquette : Guid Modification impossible après l’enregistrement
Nom unique `UniqueName` `uniquename`	Texte Chaîne	Nom unique de la propriété de réponse de l’API personnalisée. Cette valeur est le nom du paramètre lorsque vous appellez l’API personnalisée. Cette valeur ne peut contenir aucun caractère spécial. Modification impossible après l’enregistrement

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

Notes

Pouvez-vous nous indiquer vos préférences de langue pour la documentation ? Répondez à un court questionnaire. (veuillez noter que ce questionnaire est en anglais)

Le questionnaire vous prendra environ sept minutes. Aucune donnée personnelle n’est collectée (déclaration de confidentialité).

Partage via