CustomAPI-Tabellen

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

Die Abschnitte in diesem Artikel enthalten detaillierte Informationen zu den spaltenwerten, die Sie am häufigsten verwenden.

Benutzerdefinierte API-Tabellenspalten
CustomAPIRequestParameter-Tabellenspalten
CustomAPIResponseProperty-Tabellenspalten

Dieses Diagramm zeigt, wie die Tabellen mit diesen Tabellen und anderen verknüpft sind:

Diagramm mit Beziehungen zwischen Tabellen.

Die Beziehung zur CatalogAssignment-Tabelle ermöglicht die Verwendung benutzerdefinierter API mit Microsoft Dataverse-Geschäftsereignissen. Weitere Informationen: Katalog- und CatalogAssignment-Tabellen.

Abrufen von Daten zu benutzerdefinierten APIs

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

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)

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();
}

Weitere Informationen: Abfragen von Daten mithilfe von 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>

Weitere Informationen: Verwenden von SQL zum Abfragen von Daten (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

Spalten für benutzerdefinierte API-Tabellen

Die folgende Tabelle enthält ausgewählte Spalten einer benutzerdefinierten API-Tabelle, die Sie festlegen können.

Anzeigename SchemaName Logischer Name	Typ	Description
Zulässiger benutzerdefinierter Verarbeitungsschritttyp `AllowedCustomProcessingStepType` `allowedcustomprocessingsteptype`	Auswahl Auswahlliste	Wert: 0 Bezeichnung: Keine Bedeutung: Es sind keine benutzerdefinierten Verarbeitungsschritte zulässig. Wert: 1 Bezeichnung: Nur asynchron Bedeutung: Nur asynchrone benutzerdefinierte Verarbeitungsschritte zulässig Wert: 2 Bezeichnung: Synchronisieren und Async Bedeutung: Keine Einschränkung. Plug-Ins von Drittanbietern können synchrone Logik hinzufügen, um das Verhalten der Nachricht zu ändern. Siehe Auswählen eines benutzerdefinierten Verarbeitungsschritttyps Kann nach dem Speichern nicht geändert werden.
Bindungstyp `BindingType` `bindingtype`	Auswahl Auswahlliste	Wert: 0 Bezeichnung: Global Wert: 1 Bezeichnung: Entität Wert: 2 Bezeichnung: EntityCollection Siehe Auswählen eines Bindungstyps 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 die benutzerdefinierte API gebunden ist, wenn sie nicht global ist. Kann nach dem Speichern nicht geändert werden.
Benutzerdefinierte API `CustomAPIId` `customapiid`	Eindeutiger Bezeichner Leitfaden	Eindeutiger Bezeichner für benutzerdefinierte API-Instanzen Kann nach dem Speichern nicht geändert werden.
Beschreibung `Description` `description`	Text String	Lokalisierte Beschreibung für diese benutzerdefinierte API. Verwenden Sie diesen Wert, wenn die Nachricht in einer App sichtbar ist. Beispielsweise als QuickInfo.
Anzeigename `DisplayName` `displayname`	Text String	Lokalisierter Anzeigename für diese benutzerdefinierte API. Verwenden Sie diesen Wert, wenn die Nachricht in einer App sichtbar ist.
Name der Ausführungsberechtigung `ExecutePrivilegeName` `executeprivilegename`	Text String	(Optional) Name der Berechtigung, die die Ausführung der benutzerdefinierten API zulässt. Siehe: Sichern Ihrer benutzerdefinierten API mit einem Privileg
Ist anpassbar `IsCustomizable` `iscustomizable`	ManagedProperty	Ob die benutzerdefinierte API angepasst oder gelöscht werden kann, wenn sie Teil einer verwalteten Lösung ist.
Ist Funktion `IsFunction` `isfunction`	Ja/Nein Boolean	Wert: 0 Bezeichnung: Nein Wert: 1 Bezeichnung: Ja Siehe Wann soll eine Funktion erstellt werden Kann nach dem Speichern nicht geändert werden.
Ist privat `IsPrivate` `isprivate`	Ja/Nein Boolean	Wert: 0 Bezeichnung: Nein Wert: 1 Bezeichnung: Ja Sehen Sie wann Ihre benutzerdefinierte API privat werden sollte
Name `Name` `name`	Text String	Der primäre Name der benutzerdefinierten API. Dieser Wert wird in der Liste der benutzerdefinierten APIs angezeigt, wenn er in der Lösung angezeigt wird.
Owner `OwnerId` `ownerid`	Besitzer	Ein Verweis auf den Benutzer oder das Team, der die API besitzt.
Plug-In-Typ `PluginTypeId` `plugintypeid`	Suche	Ein Verweis auf den Plug-In-Typ, der den Hauptvorgang für diese benutzerdefinierte API bereitstellt. Siehe: Verwenden eines Plug-Ins, um Logik in Ihre benutzerdefinierte API einzuschließen
Eindeutiger Name `UniqueName` `uniquename`	Text String	Eindeutiger Name für die benutzerdefinierte API. Dieser Wert ist der Name der erstellten Nachricht. Dieser Wert muss ein Anpassungspräfix enthalten, das dem Präfixsatz für den Lösungsherausgeber entspricht. Dieser Wert darf keine Sonderzeichen enthalten. Kann nach dem Speichern nicht geändert werden.
Für Workflow aktiviert `WorkflowSdkStepEnabled` `workflowsdkstepenabled`	Ja/Nein Boolean	Gibt an, ob die benutzerdefinierte API als Workflowaktion aktiviert ist. Siehe: Verwenden einer benutzerdefinierten API in einem Workflow Kann nach dem Speichern nicht geändert werden.

CustomAPIRequestParameter-Tabellenspalten

Eine benutzerdefinierte API benötigt keine Parameter. Für die Parameter gibt es keine angegebene Reihenfolge. Sie werden anhand des Namens identifiziert.

Ein Parameter ist mit einer einzelnen benutzerdefinierten API verknüpft. Sie können nicht mehrere benutzerdefinierte APIs definieren, um 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 benutzerdefinierte API definieren, wird der Anforderungsparameter für Sie generiert. Sie müssen keinen Eingabeparameter für die Tabelle erstellen, wenn die benutzerdefinierte API an eine Tabelle gebunden ist. Weitere Informationen: Auswählen eines Bindungstyps

Die folgende Tabelle enthält Spalten (Attribute) der benutzerdefinierten API-Anforderungsparametertabelle, die Sie festlegen können.

Anzeigename SchemaName Logischer Name	Typ	Description
Benutzerdefinierter API-Anforderungsparameter `CustomAPIRequestParameterId` `customapirequestparameterid`	Eindeutiger Bezeichner Leitfaden	Eindeutiger Bezeichner für benutzerdefinierte API-Anforderungsparameterinstanzen. Kann nach dem Speichern nicht geändert werden.
Benutzerdefinierte API `CustomAPIId` `customapiid`	Suche	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. Verwenden Sie diesen Wert, wenn der Nachrichtenparameter in einer App sichtbar ist. Beispielsweise als QuickInfo.
Anzeigename `DisplayName` `displayname`	Text String	Lokalisierter Anzeigename für benutzerdefinierte API-Anforderungsparameterinstanzen. Verwenden Sie diesen Wert, wenn der Nachrichtenparameter in einer App sichtbar ist.
Ist anpassbar `IsCustomizable` `iscustomizable`	ManagedProperty	Gibt an, ob der benutzerdefinierte API-Anforderungsparameter als Teil einer verwalteten Lösung angepasst oder gelöscht werden kann. Benutzerdefinierte API-Anpassung anzeigen
Ist optional `IsOptional` `isoptional`	Ja/Nein Boolean	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 Bezeichnung: Nein Wert: 1 Bezeichnung: 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 `Name` `name`	Text String	Der primäre Name des benutzerdefinierten API-Anforderungsparameters. Dieser Wert wird in der Liste der benutzerdefinierten API-Anforderungsparameter angezeigt, wenn er in der Lösung angezeigt wird. Verwenden Sie diesen Wert, um diesen Parameter von anderen zu unterscheiden, die einen gemeinsamen eindeutigen Namen verwenden. Diese Benennungskonvention wird empfohlen: `{custom API Unique Name}.{Parameter UniqueName}`
Owner `OwnerId` `ownerid`	Besitzer	Ein Verweis auf den Benutzer oder das Team, der die API besitzt.
Typ `Type` `type`	Auswahl Auswahlliste	Der Datentyp des benutzerdefinierten API-Anforderungsparameters. Wert: 0 Bezeichnung: Boolean Wert: 1 Bezeichnung: DateTime Wert: 2 Beschriftung: Dezimalzahl Wert: 3 Bezeichnung: Entität Wert: 4 Bezeichnung: EntityCollection Wert: 5 Bezeichnung: EntityReference Wert: 6 Bezeichnung: Float Wert: 7 Beschriftung: Ganze Zahl Wert: 8 Bezeichnung: Geld Wert: 9 Bezeichnung: Auswahlliste Wert: 10 Bezeichnung: Zeichenfolge Wert: 11 Bezeichnung: StringArray Wert: 12 Bezeichnung: GUID Kann nach dem Speichern nicht geändert werden.
Eindeutiger Name `UniqueName` `uniquename`	Text String	Eindeutiger Name für den benutzerdefinierten API-Anforderungsparameter. Dieser Wert ist der Name des Parameters, wenn Sie die benutzerdefinierte API aufrufen. Dieser Wert darf keine Sonderzeichen enthalten. Kann nach dem Speichern nicht geändert werden.

Spalten der CustomAPIResponseProperty-Tabelle

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

Wenn nur eine einzelne Entitäts - oder EntityCollection-Antworteigenschaft definiert ist, ist die Antwort dieses Typs. Wenn mehrere Parameter oder mindestens ein Parameter eines einfachen Typs vorhanden sind, gibt die API einen komplexen Typ zurück, bei dem jede Antworteigenschaft eine Eigenschaft dieses komplexen Typs ist.

Wenn der eindeutige Name Ihrer benutzerdefinierten API beispielsweise sample_CustomAPIExample ist, gibt er einen komplexen Typ sample_CustomAPIExampleResponse mit Eigenschaften für jede von Ihnen definierte Antwort-Eigenschaft zurück.

Die folgende Tabelle enthält Spalten (Attribute) der benutzerdefinierten API-Antworteigenschaftstabelle, die Sie festlegen können.

Anzeigename SchemaName Logischer Name	Typ	Description
Benutzerdefinierte API-Antworteigenschaft `CustomAPIResponsePropertyId` `customapiresponsepropertyid`	Eindeutiger Bezeichner Leitfaden	Eindeutiger Bezeichner für Instanzen benutzerdefinierter API-Antworteigenschaften. Kann nach dem Speichern nicht geändert werden.
Benutzerdefinierte API `CustomAPIId` `customapiid`	Suche	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 Eigenschaften von API-Antwortinstanzen. Verwenden Sie diesen Wert, wenn der Nachrichtenparameter in einer App sichtbar ist. Beispielsweise als QuickInfo.
Anzeigename `DisplayName` `displayname`	Text String	Lokalisierter Anzeigename für die benutzerdefinierten API-Antworteigenschaften-Instanzen Verwenden Sie diesen Wert, wenn der Nachrichtenparameter in einer App sichtbar ist.
Ist anpassbar `IsCustomizable` `iscustomizable`	ManagedProperty	Gibt an, ob die benutzerdefinierte API-Antworteigenschaft angepasst oder gelöscht werden kann, wenn sie Teil einer verwalteten Lösung ist.
Logischer Entitätsname `LogicalEntityName` `logicalentityname`	Text String	Wenn "Entity" oder "EntityReference" als Typ ausgewählt sind, können Sie den logischen Namen der Tabelle angeben, die an die benutzerdefinierte API-Antworteigenschaft gebunden ist. Sie können keinen logischen Entitätsnamen angeben, wenn Sie "EntityCollection " als Typ auswählen. Kann nach dem Speichern nicht geändert werden.
Name `Name` `name`	String	Der primäre Name der benutzerdefinierten API-Antworteigenschaft. Dieser Wert wird in der Liste der benutzerdefinierten API-Anforderungsparameter angezeigt, wenn er in der Lösung angezeigt wird. Verwenden Sie diesen Wert, um diesen Parameter von anderen zu unterscheiden, die einen gemeinsamen eindeutigen Namen verwenden. Diese Benennungskonvention wird empfohlen: `{custom API Unique Name}.{Property UniqueName}`
Owner `OwnerId` `ownerid`	Besitzer	Ein Verweis auf den Benutzer oder das Team, der die API besitzt.
Typ `Type` `type`	Auswahlliste	Der Datentyp der benutzerdefinierten API-Antworteigenschaft Wert: 0 Bezeichnung: Boolean Wert: 1 Bezeichnung: DateTime Wert: 2 Beschriftung: Dezimalzahl Wert: 3 Bezeichnung: Entität Wert: 4 Bezeichnung: EntityCollection Wert: 5 Bezeichnung: EntityReference Wert: 6 Bezeichnung: Float Wert: 7 Beschriftung: Ganze Zahl Wert: 8 Bezeichnung: Geld Wert: 9 Bezeichnung: Auswahlliste Wert: 10 Bezeichnung: Zeichenfolge Wert: 11 Bezeichnung: StringArray Wert: 12 Bezeichnung: GUID Kann nach dem Speichern nicht geändert werden.
Eindeutiger Name `UniqueName` `uniquename`	Text String	Eindeutiger Name für die benutzerdefinierte API-Antworteigenschaft. Dieser Wert ist der Name des Parameters, wenn Sie die benutzerdefinierte API aufrufen. Dieser Wert darf keine Sonderzeichen enthalten. Kann nach dem Speichern nicht geändert werden.

Siehe auch

Benutzerdefinierte APIs erstellen und verwenden
Erstellen einer benutzerdefinierten API mithilfe des Plug-In-Registrierungstools
Erstellen einer benutzerdefinierten API in Power Apps
Erstellen einer benutzerdefinierten API mit Code
Erstellen einer benutzerdefinierten API mit Lösungsdateien
Erstellen eigener Nachrichten

Feedback

War diese Seite hilfreich?

Last updated on 2025-10-04