CustomAPI-Tabellen

Die Daten, die Custom-APIs definieren, befinden sich in den folgenden Tabellen/Entitäten:

• CustomAPI-Referenz
• CustomAPIRequestParameter-Referenz
• CustomAPIResponseProperty-Referenz

Die Abschnitte in diesem Thema unten enthalten detaillierte Informationen zu den Spaltenwerten, die Sie am häufigsten verwenden werden.

• Benutzerdefinierte API-Tabellenspalten
• CustomAPIRequestParameter Tabellenspalten
• CustomAPIResponseProperty-Tabellenspalten

Dieses Diagramm zeigt, wie die Tabellen mit diesen und anderen Tabellen zusammenhängen:

Das Verhältnis zur CatalogAssignment-Tabelle ermöglicht die Verwendung der benutzerdefinierten API mit Microsoft Dataverse geschäftliche Veranstaltungen. Weitere Informationen: Catalog- und CatalogAssignment-Tabellen.

Daten zu benutzerdefinierten APIs abrufen

Mit den folgenden Abfragen können Sie Daten zu benutzerdefinierten APIs abrufen.

Web-API

Mehr Informationen: Datenabfrage über die Web API

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)

QueryExpression

Weitere Informationen: Erstellen von Abfragen mit 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();
}

FetchXML

Weitere Informationen finden Sie unter Verwendung von FetchXML, um eine Abfrage zu erstellen

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

SQL

Weitere Informationen: SQL verwenden, um Daten abzufragen (Vorschau)

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

Benutzerdefinierte API-Tabellenspalten

Die Tabelle unten enthält ausgewählte Spalten/Attribute einer Custom-API-Tabelle/Entität, die Sie festlegen können.

Anzeigename Schemaname Logischer Name	Art	Beschreibung des Dataflows
Typ des zulässigen benutzerdefinierten Verarbeitungsschritts AllowedCustomProcessingStepType allowedcustomprocessingsteptype	Auswahl Auswahlliste	Wert: 0 Etikett: Keines Bedeutunug: Keine benutzerdefinierten Verarbeitungsschritte erlaubt. Wert: 1 Etikett: Nur Async Bedeutunug: Nur asynchrone benutzerdefinierte Verarbeitungsschritte erlaubt Wert: 2 Etikett: Synchron und asynchron Bedeutung: Keine Einschränkung. Plug-Ins von Drittanbietern können synchrone Logik hinzufügen, um das Verhalten der Nachricht zu ändern. Siehe Wählen Sie einen benutzerdefinierten Verarbeitungsschritttyp aus Kann nach dem Speichern nicht geändert werden.
Bindungstyp BindingType bindingtype	Auswahl Auswahlliste	Wert: 0 Beschriftung: Global Wert: 1 Beschriftung: Entität Wert: 2 Beschriftung: EntityCollection Siehe Wählen Sie einen Bindungstyp aus Kann nach dem Speichern nicht geändert werden.
Logischer Name der gebundenen Entität BoundEntityLogicalName boundentitylogicalname	Text String	Der logische Name der Tabelle, die an den benutzerdefinierten API-Anforderungsparameter gebunden ist, wenn er nicht global ist. Kann nach dem Speichern nicht geändert werden.
Benutzerdefinierte API CustomAPIId customapiid	Eindeutiger Bezeichner GUID	Eindeutiger Bezeichner für angepasste Custom-API-Instanzen Kann nach dem Speichern nicht geändert werden.
Beschreibung Description description	Text String	Lokalisierte Beschreibung für diese benutzerdefinierte API. Zur Verwendung, wenn die Nachricht in einer App aufgerufen werden soll. Zum Beispiel als QuickInfo.
Anzeigename DisplayName displayname	Text String	Lokalisierter Anzeigename für diese benutzerdefinierte API. Zur Verwendung, wenn die Nachricht in einer App aufgerufen werden soll.
Name der Ausführungsberechtigung ExecutePrivilegeName executeprivilegename	Text String	(Optional) Name der Berechtigung, mit der die benutzerdefinierte API ausgeführt werden kann. Siehe: Sichern Sie Ihre benutzerdefinierte API mit einem Privileg
Ist anpassbar IsCustomizable iscustomizable	ManagedProperty	Ob die Custom-API angepasst oder gelöscht werden kann, wenn sie Teil einer verwalteten Lösung ist.
Ist Funktion IsFunction isfunction	Ja/Nein Boolesch	Wert: 0 Beschriftung: Nein Wert: 1 Beschriftung: Ja Siehe Wann eine Funktion erstellen Kann nach dem Speichern nicht geändert werden.
Ist privat IsPrivate isprivate	Ja/Nein Boolesch	Wert: 0 Beschriftung: Nein Wert: 1 Beschriftung: Ja Siehe: Wann Sie Ihre benutzerdefinierte API privat machen sollten
Name des Dataflows Name name	Text String	Der primäre Name der benutzerdefinierten API. Dieser wird in der Liste der benutzerdefinierten APIs angezeigt, wenn er in der Lösung angezeigt wird.
Besitzer OwnerId ownerid	Besitzer	Ein Verweis auf den Benutzer oder das Team, dem die API gehört.
Plug-In-Typ PluginTypeId plugintypeid	Nachschlagen	Ein Verweis auf den Plug-In-Typ, der den Hauptvorgang für diese benutzerdefinierte API bereitstellt. Siehe: Verwenden Sie ein Plug-In, um Logik in Ihre benutzerdefinierte API einzufügen
Eindeutiger Name UniqueName uniquename	Text String	Eindeutiger Name der benutzerdefinierten API. Dies ist der Name der erstellten Nachricht. Dieser Wert muss ein Anpassungspräfix enthalten, das dem für Ihren Lösungsherausgeber festgelegten Präfix entspricht. Kann nach dem Speichern nicht geändert werden.
Für Workflow aktiviert WorkflowSdkStepEnabled workflowsdkstepenabled	Ja/Nein Boolesch	Gibt an, ob die benutzerdefinierte API als Workflowaktion aktiviert ist. Siehe: Verwenden Sie eine benutzerdefinierte API in einem Workflow Kann nach dem Speichern nicht geändert werden.

CustomAPIRequestParameter Tabellenspalten

Eine benutzerdefinierte API muss keine Parameter haben. Es gibt keine festgelegte Reihenfolge für die Parameter, sie werden durch den Namen identifiziert.

Ein Parameter bezieht sich auf eine einzelne benutzerdefinierte API. Sie können nicht für mehrere benutzerdefinierte APIs definieren, dieselbe Parameterdefinition zu verwenden. Sie können mehrere Anforderungsparameter mit demselben UniqueName-Wert definieren, wenn sie von verschiedenen benutzerdefinierten APIs verwendet werden.

Hinweis

Wenn Sie eine gebundene Tabelle für Ihre Custom-API definieren, wird der Anfrageparameter für Sie generiert. Sie brauchen keinen Eingabeparameter für die Tabelle zu erstellen, wenn die Custom-API an eine Tabelle gebunden ist. Weitere Informationen finden Sie unter: Bindungstyp auswählen

Die unten dargestellte Tabelle enthält Spalten (Attribute) der Tabelle Custom-API Request Parameter/Entität, die Sie festlegen können.

Anzeigename Schemaname Logischer Name	Art	Beschreibung
Benutzerdefinierter API-Anforderungsparameter CustomAPIRequestParameterId customapirequestparameterid	Eindeutiger Bezeichner GUID	Eindeutiger Bezeichner für benutzerdefinierte API-Anforderungsparameterinstanzen. Kann nach dem Speichern nicht geändert werden.
Benutzerdefinierte API CustomAPIId customapiid	Nachschlagen	Eindeutiger Bezeichner für die benutzerdefinierte API, der dieser benutzerdefinierte API-Anforderungsparameter zugeordnet ist. Kann nach dem Speichern nicht geändert werden.
Beschreibung Description description	Text String	Lokalisierte Beschreibung für benutzerdefinierte API-Anforderungsparameterinstanzen. Zur Verwendung, wenn der Nachrichtenparameter in einer App aufgerufen werden soll. Zum Beispiel als QuickInfo.
Anzeigename DisplayName displayname	Text String	Lokalisierter Anzeigename für benutzerdefinierte API-Anforderungsparameterinstanzen. Zur Verwendung, wenn der Nachrichtenparameter in einer App aufgerufen werden soll.
Ist anpassbar IsCustomizable iscustomizable	ManagedProperty	Ob der Custom-API-Request-Parameter angepasst oder gelöscht werden kann, wenn er Teil einer verwalteten Lösung ist. Siehe Benutzerdefinierte API-Anpassung
Ist optional IsOptional isoptional	Ja/Nein Boolesch	Gibt an, ob der benutzerdefinierte API-Anforderungsparameter optional ist. Wenn dies nicht optional ist, muss bei Verwendung der Nachricht ein Wert für diesen Parameter übergeben werden. Wert: 0 Beschriftung: Nein Wert: 1 Beschriftung: Ja Kann nach dem Speichern nicht geändert werden.
Logischer Entitätsname LogicalEntityName logicalentityname	Text String	Der logische Name der Tabelle, die an den benutzerdefinierten API-Anforderungsparameter gebunden ist. Kann nach dem Speichern nicht geändert werden.
Name des Dataflows Name name	Text String	Der primäre Name des benutzerdefinierten API-Anforderungsparameters. Dieser wird in der Liste der benutzerdefinierten API-Anforderungsparameter angezeigt, wenn er in der Lösung angezeigt wird. Verwenden Sie diese Option, um diesen Parameter von anderen zu unterscheiden, die einen gemeinsamen eindeutigen Namen haben. Diese Namenskonvention wird empfohlen: {Custom API Unique Name}.{Parameter UniqueName}
Bes. OwnerId ownerid	Bes.	Ein Verweis auf den Benutzer oder das Team, dem die API gehört.
Art Type type	Option Picklist	Der Datentyp des benutzerdefinierten API-Anforderungsparameters. Wert: 0 Beschriftung: Boolesch Wert: 1 Beschriftung: DateTime Wert: 2 Beschriftung: Dezimal Wert: 3 Beschriftung: Entität Wert: 4 Beschriftung: EntityCollection Wert: 5 Beschriftung: EntityReference Wert: 6 Beschriftung: Gleitkomma Wert: 7 Beschriftung: Integer Wert: 8 Beschriftung: Money Wert: 9 Beschriftung: Auswahlliste Wert: 10 Beschriftung: Zeichenfolge Wert: 11 Label: StringArray Wert: 12 Label: Anleitung Kann nach dem Speichern nicht geändert werden.
Eindeutiger Name UniqueName uniquename	Text String	Eindeutiger Name für den benutzerdefinierten API-Anforderungsparameter. Dies ist der Name des Parameters, wenn Sie die benutzerdefinierte API aufrufen. Kann nach dem Speichern nicht geändert werden.

CustomAPIResponseProperty Tabellenspalten

Das für Ihre benutzerdefinierte API-Nachricht zurückgegebene Objekt enthält alle von Ihnen definierten Antworteigenschaften. Es ist nicht erforderlich, dass eine Custom-API-Aktion einen Wert zurückgibt, aber sie muss einen Wert zurückgeben, wenn sie als Funktion definiert ist.

Wenn nur eine einzige Entity- oder EntityCollection-Antworteigenschaft definiert ist, wird die Antwort von diesem Typ sein. Wenn mehrere Parameter oder ein oder mehrere Parameter eines einfachen Typs vorhanden sind, gibt die API einen komplexen Typ zurück, wobei jede Antworteigenschaft eine Eigenschaft dieses komplexen Typs ist.

Zum Beispiel, wenn Ihr eindeutiger benutzerdefinierter API-Name sample_CustomAPIExample lautet, wird ein komplexer Typ namens sample_CustomAPIExampleResponse mit Eigenschaften für jede von Ihnen definierte Antworteigenschaft zurückgegeben.

Diese Tabelle unten enthält Spalten (Attribute) der Custom-API Antwort Eigenschaftentabelle, die Sie festlegen können.

Anzeigename Schemaname Logischer Name	Art	Beschreibung
Benutzerdefinierte API-Antworteigenschaft CustomAPIResponsePropertyId customapiresponsepropertyid	Eindeutiger Bezeichner GUID	Eindeutiger Bezeichner für benutzerdefinierte API-Antworteigenschaftsinstanzen. Kann nach dem Speichern nicht geändert werden.
Benutzerdefinierte API CustomAPIId customapiid	Nachschlagen	Eindeutiger Bezeichner für die benutzerdefinierte API, der diese benutzerdefinierte API-Antworteigenschaft zugeordnet ist. Kann nach dem Speichern nicht geändert werden.
Beschreibung Description description	Text String	Lokalisierte Beschreibung für benutzerdefinierte API-Antworteigenschaftsinstanzen. Zur Verwendung, wenn der Nachrichtenparameter in einer App aufgerufen werden soll. Zum Beispiel als QuickInfo.
Anzeigename DisplayName displayname	Text String	Lokalisierter Anzeigename für benutzerdefinierte API-Antworteigenschaftsinstanzen. Zur Verwendung, wenn der Nachrichtenparameter in einer App aufgerufen werden soll.
Ist anpassbar IsCustomizable iscustomizable	ManagedProperty	Ob die Custom-API-Response-Eigenschaft angepasst oder gelöscht werden kann, wenn sie Teil einer verwalteten Lösung ist.
Logischer Entitätsname LogicalEntityName logicalentityname	Text String	Wenn Entität oder EntityReference als Typ ausgewählt wird, können Sie den logischen Namen der Tabelle angeben, die an die benutzerdefinierte API-Antworteigenschaft gebunden ist. Sie können keinen Logischen Entitätsname angeben, wenn Sie EntityCollection als Typ auswählen. Kann nach dem Speichern nicht geändert werden.
Name des Dataflows Name name	String	Der primäre Name der benutzerdefinierten API-Antworteigenschaft. Dieser wird in der Liste der benutzerdefinierten API-Anforderungsparameter angezeigt, wenn er in der Lösung angezeigt wird. Verwenden Sie diese Option, um diesen Parameter von anderen zu unterscheiden, die einen gemeinsamen eindeutigen Namen haben. Diese Namenskonvention wird empfohlen: {Custom API Unique Name}.{Property UniqueName}
Besitzer OwnerId ownerid	Besitzer	Ein Verweis auf den Benutzer oder das Team, dem die API gehört.
Typ Type type	Picklist	Der Datentyp der benutzerdefinierten API-Antworteigenschaft Wert: 0 Beschriftung: Boolesch Wert: 1 Beschriftung: DateTime Wert: 2 Beschriftung: Dezimal Wert: 3 Beschriftung: Entität Wert: 4 Beschriftung: EntityCollection Wert: 5 Beschriftung: EntityReference Wert: 6 Beschriftung: Gleitkomma Wert: 7 Beschriftung: Integer Wert: 8 Beschriftung: Money Wert: 9 Beschriftung: Auswahlliste Wert: 10 Beschriftung: Zeichenfolge Wert: 11 Label: StringArray Wert: 12 Label: Anleitung Kann nach dem Speichern nicht geändert werden.
Eindeutiger Name UniqueName uniquename	Text String	Eindeutiger Name für die benutzerdefinierte API-Antworteigenschaft. Dies ist der Name des Parameters, wenn Sie die benutzerdefinierte API aufrufen. Kann nach dem Speichern nicht geändert werden.

Siehe auch

Benutzerdefinierte APIs erstellen und verwenden
Erstellen Sie eine benutzerdefinierte API mit dem Plug-In-Registrierungstool
Erstellen einer benutzerdefinierten API in Power Apps
Eine benutzerdefinierte API mit Code erstellen
Eine benutzerdefinierte API mit Lösungsdateien erstellen
Eigene Nachrichten erstellen

Hinweis

Können Sie uns Ihre Präferenzen für die Dokumentationssprache mitteilen? Nehmen Sie an einer kurzen Umfrage teil. (Beachten Sie, dass diese Umfrage auf Englisch ist.)

Die Umfrage dauert etwa sieben Minuten. Es werden keine personenbezogenen Daten erhoben. (Datenschutzbestimmungen).