Freigeben über


CustomAPI-Tabellen

Die Daten, die Custom-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.

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

Diagramm mit Beziehungen zwischen Tabellen.

Die Beziehung zur Tabelle CatalogAssignment ermöglicht die Verwendung einer Custom-API mit Microsoft Dataverse geschäftlichen Ereignissen. Weitere Informationen: Catalog- und CatalogAssignment-Tabellen.

Abrufen von Daten über angepasste Custom-APIs

Sie können die folgenden Abfragen verwenden, um Daten über Custom-APIs abzurufen.

Weitere Informationen: Datenabfragen mithilfe der 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)

Benutzerdefinierte API-Tabellenspalten

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

Anzeigenname
SchemaName
Logischer Name
Art Beschreibung
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
Zeichenfolge
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.
Custom-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
Zeichenfolge
Lokalisierte Beschreibung für diese Custom-API. Verwenden Sie diesen Wert, wenn die Nachricht in einer App sichtbar ist. Zum Beispiel als QuickInfo.
Anzeigenname
DisplayName
displayname
Text
Zeichenfolge
Lokalisierter Anzeigename für diese Custom-API. Verwenden Sie diesen Wert, wenn die Nachricht in einer App sichtbar ist.
Name der Ausführungsberechtigung
ExecutePrivilegeName
executeprivilegename
Text
Zeichenfolge
(Optional) Name der Berechtigung, mit der die benutzerdefinierte API ausgeführt werden kann. Siehe: Sichern Sie Ihre Custom-API mit einer Berechtigung
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 Custom-API privat machen
Name des Dataflows
Name
name
Text
Zeichenfolge
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.
Bes.
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 Typ des Plug-ins, das den Hauptvorgang für diese Custom-API bereitstellt. Siehe: Verwenden Sie ein Plug-In, um Logik in Ihre Custom-API einzubinden
Eindeutiger Name
UniqueName
uniquename
Text
Zeichenfolge
Eindeutiger Name der benutzerdefinierten API. Dieser Wert ist der Name der erstellten Nachricht.
Dieser Wert muss ein Anpassungspräfix enthalten, das dem für Ihren Lösungsherausgeber festgelegten Präfix entspricht.
Dieser Wert darf keine Sonderzeichen enthalten.
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 Custom-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 namentlich identifiziert.

Ein Parameter ist mit einer einzelnen Custom-API verbunden. 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 Abfrageparameter 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 folgende Tabelle enthält Spalten (Attribute) der Tabelle „Anfrageparameter für benutzerdefinierte API”, die Sie festlegen können.

Anzeigenname
SchemaName
Logischer Name
Type Beschreibung
Custom-API-Anfrage Parameter
CustomAPIRequestParameterId
customapirequestparameterid
Eindeutiger Bezeichner
GUID
Eindeutiger Bezeichner für benutzerdefinierte API-Anforderungsparameterinstanzen.
Kann nach dem Speichern nicht geändert werden.
Custom-API
CustomAPIId
customapiid
Nachschlagefeld 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
Zeichenfolge
Lokalisierte Beschreibung für benutzerdefinierte API-Anforderungsparameterinstanzen. Verwenden Sie diesen Wert, wenn der Nachrichtparameter in einer App sichtbar ist. Zum Beispiel als QuickInfo.
Anzeigenname
DisplayName
displayname
Text
Zeichenfolge
Lokalisierter Anzeigename für benutzerdefinierte API-Anforderungsparameterinstanzen. Verwenden Sie diesen Wert, wenn der Nachrichtparameter in einer App sichtbar ist.
Ist anpassbar
IsCustomizable
iscustomizable
ManagedProperty Ob der Anforderungsparameter für die benutzerdefinierte API angepasst oder gelöscht werden kann, wenn er Teil einer verwalteten Lösung ist. Siehe Custom-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
Zeichenfolge
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
Zeichenfolge
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 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
Zeichenfolge
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.

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 Aktion für eine benutzerdefinierte API 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, ist die Antwort von diesem Typ. 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.

Die folgende Tabelle enthält Spalten (Attribute) der Antwort-Eigenschaftentabelle für benutzerdefinierte APIs, die Sie festlegen können.

Anzeigenname
SchemaName
Logischer Name
Type Beschreibung
Custom-API-Antwort-Eigenschaft
CustomAPIResponsePropertyId
customapiresponsepropertyid
Eindeutiger Bezeichner
GUID
Eindeutiger Bezeichner für benutzerdefinierte API-Antworteigenschaftsinstanzen.
Kann nach dem Speichern nicht geändert werden.
Custom-API
CustomAPIId
customapiid
Nachschlagefeld 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
Zeichenfolge
Lokalisierte Beschreibung für benutzerdefinierte API-Antworteigenschaftsinstanzen. Verwenden Sie diesen Wert, wenn der Nachrichtparameter in einer App sichtbar ist. Zum Beispiel als QuickInfo.
Anzeigenname
DisplayName
displayname
Text
Zeichenfolge
Lokalisierter Anzeigename für benutzerdefinierte API-Antworteigenschaftsinstanzen. Verwenden Sie diesen Wert, wenn der Nachrichtparameter in einer App sichtbar ist.
Ist anpassbar
IsCustomizable
iscustomizable
ManagedProperty Ob die Antwort-Eigenschaft für die benutzerdefinierte API angepasst oder gelöscht werden kann, wenn sie Teil einer verwalteten Lösung ist.
Logischer Entitätsname
LogicalEntityName
logicalentityname
Text
Zeichenfolge
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ätsnamen angeben, wenn Sie EntityCollection als Typ auswählen.
Kann nach dem Speichern nicht geändert werden.
Name des Dataflows
Name
name
Zeichenfolge 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 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
Zeichenfolge
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 Sie eine benutzerdefinierte API mit dem Plug-In-Registrierungstool
Erstellen Sie eine angepasste Custom-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).