DCME-Endpunkte
DCME-Endpunkte und Parameter
Die DCME-Endpunkte sind in zwei Gruppen unterteilt: DCME-Endpunkte für Benutzer und DCME-Endpunkte für Administratoren . Für alle DCME-Endpunkte muss auf dem Server TLS konfiguriert sein.
Weitere Informationen zu Objektbeziehungen und deren Verwendung in der API finden Sie im Abschnitt Objektbeziehungen .
Weitere Informationen über Datenverbindungen finden Sie auf den Hilfeseiten DCM – Server und Data Connection Manager: Server-Benutzeroberfläche .
DCME-Endpunkte für Benutzer
Diese Endpunkte können von Benutzern mit API-Zugriff verwendet werden:
Alle API-Endpunkte geben individuelle Benutzerdaten zurück (jeder Benutzer kann nur seine eigenen Verbindungen sehen und verwalten).
Um einen DCM-Verbindungsdatensatz abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/dcm/connections/{id} . Der Endpunkt gibt alle Informationen über die DCM-Verbindung zurück, einschließlich der zugehörigen Datenquelle und Anmeldedaten sowie der Informationen zur Freigabe.
Parameter
id (Zeichenfolge): erforderlich. Geben Sie die ID der DCM-Verbindung ein, zu der Informationen abgerufen werden sollen.
Anforderungsbeispiel: cURL
curl --location --request GET 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Um einen DCM-Verbindungsdatensatz so abzurufen, wie er in Workflows referenziert wird, verwenden Sie den Endpunkt GET {baseURL}/v3/dcm/connections/lookup . Der Endpunkt gibt alle Informationen über die DCM-Verbindung zurück, einschließlich der zugehörigen Datenquelle und Anmeldedaten sowie der Informationen zur Freigabe.
Anmerkung
Die in diesem Endpunkt verwendete connectionId unterscheidet sich von der in anderen DCM-Endpunkten verwendeten ID. Der Parameter „id“ wird verwendet, um verschiedene DCM-Objekte zu referenzieren, während connectionId nur in Workflows verwendet wird, um die DCM-Verbindung für bestimmte Benutzer zu referenzieren.
Parameter
connectionId (Zeichenfolge): erforderlich. Geben Sie die DCM-connectionId ein, zu der Sie Informationen abrufen möchten.
Anforderungsbeispiel: cURL
curl --location --request GET 'https://localhost/webapi/v3/dcm/connections/lookup?connectionId=d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Um eine DCM-Verbindung für die Serverausführung mit angegebenen Benutzern oder Gruppen freizugeben, verwenden Sie den Endpunkt PUT {baseURL}/v3/dcm/connections/{id}/sharing/execution .
Anmerkung
Da es sich um einen PUT-Endpunkt handelt, überschreibt er die vorhandene Freigabe, statt zusätzliche Benutzer oder Benutzergruppen zur vorhandenen Liste hinzuzufügen. Die angegebene Liste der Benutzer und Gruppen darf nicht leer sein. Um die vorhandene Freigabe zu entfernen, verwenden Sie den DELETE-Endpunkt.
Parameter
id (Zeichenfolge): erforderlich. Geben Sie die DCM-Verbindungs-ID ein, die Sie für andere Benutzer oder Gruppen freigeben möchten.
sharingContract (Text): erforderlich. Zum Aktualisieren der Ausführungsfreigabe ist der Parameter „sharingContract“ erforderlich. Beide Arrays sind erforderlich, wobei nur eines leer bleiben kann.
userIds (Zeichenfolgen-Array): Geben Sie eine Liste aller Benutzer-IDs ein, für die die Verbindung freigegeben werden soll. Lassen Sie das Array leer, wenn die Verbindung für keine Benutzer (sondern nur für Benutzergruppen) freigegeben werden soll.
userGroupIds (Zeichenfolgen-Array): Geben Sie eine Liste aller Benutzergruppen-IDs ein, für die die Verbindung freigegeben werden soll. Lassen Sie das Array leer, wenn die Verbindung für keine Benutzergruppen (sondern nur für einzelne Benutzer) freigegeben werden soll.
Anforderungsbeispiel: cURL
curl --location --request PUT 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/execution' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --header "Content-Type: application/json" \ --data '{"userIds": ["61d57bea3c15317e1a48205b", "61d564361d6d5da7ad461a32"],"userGroupIds": ["d5da7ad4"]}'
Um die Freigabe einer DCM-Verbindung aufzuheben, verwenden Sie den Endpunkt DELETE {baseURL}/v3/dcm/connections/{id}/sharing/execution .
Parameter
id (Zeichenfolge): erforderlich. Geben Sie die DCM-Verbindungs-ID ein, deren Freigabe für alle Benutzer und Gruppen aufgehoben werden soll.
Anforderungsbeispiel: cURL
curl --location --request DELETE 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/execution' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Um eine DCM-Verbindung zu erstellen oder zu aktualisieren, verwenden Sie den Endpunkt POST {baseURL}/v3/dcm/connections .
Ein einzelner Endpunkt dient sowohl für Erstellungs- als auch für Aktualisierungsfunktionen, wobei danach unterschieden wird, ob in der Anforderung Objekt-IDs enthalten sind. Die Wiederverwendung vorhandener Datenquellen oder Anmeldedaten wird derzeit beim Erstellen neuer Verbindungen nicht unterstützt.
Parameter
upsertConnectionContract (Zeichenfolge): erforderlich. Die DCM-Verbindung ist eine Kombination aus einer Datenquelle (die den Host der Zielinstanz beschreibt) und aus Anmeldedaten (z. B. Benutzername und Kennwort), wobei die mögliche Schemakombination definiert wird.
id (Zeichenfolge): optional. Geben Sie eine Verbindungs-ID ein, wenn Sie eine vorhandene Verbindung aktualisieren möchten. Überspringen Sie dies, wenn Sie eine neue Verbindung erstellen möchten.
Name (Zeichenfolge): erforderlich. Wählen Sie den Namen Ihrer Verbindung aus.
schemaName (Zeichenfolge): erforderlich. Geben Sie den Namen eines Verbindungsschemas ein, das Sie verwenden möchten. Das Schema definiert die erforderlichen Parameter der Verbindung sowie die Schemas für Datenquelle und Anmeldedaten, die für diese Verbindung verwendet werden dürfen.
allowInSdks (boolescher Wert): optional.
parameters (Objekt): erforderlich. Je nach ausgewähltem schemaName sind möglicherweise verschiedene Parameter erforderlich.
dataSource (Objekt): erforderlich. Die Datenquelle, die für die Verbindung verwendet wird. Sie beschreibt den Host der Datenquelleninstanz sowie zusätzliche Parameter, wie in der DCM-Benutzeroberfläche angezeigt.
object (Objekt): erforderlich.
id (Zeichenfolge): Geben Sie eine Datenquellen-ID ein, wenn Sie eine vorhandene Verbindung aktualisieren möchten. Überspringen Sie dies, wenn Sie eine neue Verbindung erstellen möchten. Die Verwendung einer vorhandenen Datenquelle beim Erstellen neuer Verbindungen ist derzeit nicht möglich.
Name (Zeichenfolge): erforderlich. Geben Sie einen Namen für die Datenquelle ein.
schemaName (Zeichenfolge): erforderlich. Geben Sie den Schemanamen der ausgewählten Datenquelle ein.
Zusätzliche schemaspezifische Parameter : Je nach verwendetem Schema müssen Sie zusätzliche Datenquellenparameter angeben.
credentials (Zeichenfolge): optional, abhängig vom ausgewählten „schemaName“ in „upsertConnectionContract“. Einige Verbindungen erfordern möglicherweise keine Anmeldedaten, während andere mehrere verschachtelte Objekte (Slots) haben können.
main (Objekt): optional (siehe oben). Dieser Parameter „main“ ist nur ein (aber der am häufigste verwendete) Anmeldedaten-Slot-Name. Er kann aber auch anders benannt werden oder es können mehrere Anmeldedaten-Slots für die Verbindung vorhanden sein, je nachdem, was im Verbindungsschema definiert ist.
id (Zeichenfolge): Geben Sie eine Anmeldedaten-ID ein, wenn Sie eine vorhandene Verbindung aktualisieren möchten. Überspringen Sie dies, wenn Sie eine neue Verbindung erstellen möchten. Die Verwendung vorhandener Anmeldedaten beim Erstellen neuer Verbindungen ist derzeit nicht möglich.
Name (Zeichenfolge): erforderlich. Geben Sie den Namen Ihrer Anmeldedaten ein.
schemaName (Zeichenfolge): erforderlich. Geben Sie den Schemanamen der ausgewählten Anmeldedaten ein.
Zusätzliche schemaspezifische Parameter : Je nach verwendetem Schema müssen Sie zusätzliche Datenquellenparameter angeben.
Anforderungsbeispiel: cURL
curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --header "Content-Type: application/json" \ --data '{"Name":"MSSQL DEV Admin","SchemaName":"database-odbc-dsn-mssql","Parameters":{},"DataSource":{"object":{"name":"SQL Server DEV","SchemaName":"database-odbc-dsn-mssql","parameters":{"dsn":"sql server"}}},"Credentials":{"main":{"object":{"name":"SQL Server Admin Credentials","SchemaName":"username_password","parameters":{},"userName":"admin","secrets":{"password":{"value":{"text":"password"},"Parameters":{}}}}}}}'
Um eine DCM-Verbindung zu löschen, verwenden Sie den Endpunkt DELETE {baseURL}/v3/dcm/connections/{id} . Die Datenquelle und die Anmeldedaten werden ebenfalls gelöscht, es sei denn, sie werden in einer anderen Verbindung verwendet.
Parameter
id (Zeichenfolge): erforderlich. Geben Sie die DCM-Verbindungs-ID ein, die Sie löschen möchten.
Anforderungsbeispiel: cURL
curl --location --request DELETE 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' \ --header 'Authorization: Bearer BearerTokenGoesHere'
DCME-Endpunkte für Administratoren
Endpunkte, die von Administratoren mit API-Zugriff verwendet werden können:
Alle Administrator-API-Endpunkte geben alle auf dem Server verfügbaren Daten für alle Benutzer zurück, unabhängig von der Eigentümerschaft.
Um einen DCM-Verbindungsdatensatz abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/dcm/admin/connections/{objectId} .
Parameter
objectId (Zeichenfolge): erforderlich. Geben Sie die DCM-Verbindungs-ID ein, zu der Informationen abgerufen werden sollen.
Anforderungsbeispiel: cURL
curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Um eine Liste aller auf dem Server vorhandenen DCM-Verbindungsdatensätze abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/dcm/admin/connections .
Parameter
Beide Parameter sind Filter, die kombiniert werden können. Wenn connectionId und visibleBy zusammen verwendet werden, wird die Verbindung mit der angegebenen connectionId zurückgegeben, die für den angegebenen Benutzer sichtbar ist.
connectionId (Zeichenfolge): optional. Filtert Verbindungen nach der connectionId wie in einem Workflow referenziert. Für eine einzelne connectionId können mehrere Verbindungen zurückgegeben werden, wenn die Verbindung für die Zusammenarbeit freigegeben wurde.
visibleBy (Zeichenfolge): optional. Geben Sie eine Benutzer-ID ein. Wenn vorhanden, werden dadurch die Ergebnisse nach demselben Ergebnis gefiltert wie für alle Verbindungen, die dem angegebenen Benutzer zur Verfügung stehen.
Anforderungsbeispiel: cURL
curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connections?connectionId=d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3&visibleBy=bc7cb7b47c33' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Um einen DCM-Verbindungsdatensatz im Namen eines Benutzers zu erstellen oder zu aktualisieren, verwenden Sie den Endpunkt POST {baseURL}/v3/dcm/admin/connections .
Parameter
upsertConnectionContract (Zeichenfolge): erforderlich.
id (Zeichenfolge): optional. Geben Sie eine Verbindungs-ID ein, wenn Sie eine vorhandene Verbindung aktualisieren möchten. Überspringen Sie dies, wenn Sie eine neue Verbindung erstellen möchten.
ownerId (Zeichenfolge): erforderlich.
Geben Sie beim Erstellen einer DCM-Verbindung die ID des Benutzers ein, in dessen Namen die Verbindung erstellt werden soll.
Beim Aktualisieren einer DCM-Verbindung müssen Sie auch die ownerId eingeben, selbst wenn Sie sie nicht ändern möchten. Weitere Informationen zum Abrufen einer ownerId finden Sie unter DCM-Verbindungsdatensatz abrufen oder Liste der DCM-Verbindungsdatensätze abrufen .
Name (Zeichenfolge): erforderlich. Wählen Sie den Namen Ihrer Verbindung aus.
schemaName (Zeichenfolge): erforderlich. Geben Sie den Namen eines Verbindungsschemas ein, das Sie verwenden möchten. Das Schema definiert die erforderlichen Parameter der Verbindung sowie die Schemas für Datenquelle und Anmeldedaten, die für diese Verbindung verwendet werden dürfen.
allowInSdks (boolescher Wert): optional.
parameters (Objekt): erforderlich. Je nach ausgewähltem schemaName sind möglicherweise verschiedene Parameter erforderlich.
dataSource (Objekt): erforderlich. Die Datenquelle, die für die Verbindung verwendet wird
object (Objekt): erforderlich.
id (Zeichenfolge): Geben Sie eine Datenquellen-ID ein, wenn Sie eine vorhandene Verbindung aktualisieren. Überspringen Sie dies, wenn Sie eine neue Verbindung erstellen möchten. Die Verwendung einer vorhandenen Datenquelle beim Erstellen neuer Verbindungen ist derzeit nicht möglich.
Name (Zeichenfolge): erforderlich. Geben Sie einen Namen für die Datenquelle ein.
schemaName (Zeichenfolge): erforderlich. Geben Sie den Schemanamen der ausgewählten Datenquelle ein.
Zusätzliche schemaspezifische Parameter : Je nach verwendetem Schema müssen Sie zusätzliche Datenquellenparameter angeben.
credentials (Zeichenfolge): optional, abhängig vom ausgewählten „schemaName“ in „upsertConnectionContract“. Für einige Verbindungen sind möglicherweise keine Anmeldedaten erforderlich, während andere mehrere Anmeldedaten haben.
main (Objekt): optional (siehe oben).
id (Zeichenfolge): Geben Sie eine Anmeldedaten-ID ein, wenn Sie eine vorhandene Verbindung aktualisieren. Überspringen Sie dies, wenn Sie eine neue Verbindung erstellen möchten. Die Verwendung vorhandener Anmeldedaten beim Erstellen neuer Verbindungen ist derzeit nicht möglich.
Name (Zeichenfolge): erforderlich. Geben Sie den Namen Ihrer Anmeldedaten ein.
schemaName (Zeichenfolge): erforderlich. Geben Sie den Schemanamen der ausgewählten Anmeldedaten ein.
Zusätzliche schemaspezifische Parameter : Je nach verwendetem Schema müssen Sie zusätzliche Anmeldedatenparameter angeben.
Anforderungsbeispiel: cURL
curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --header "Content-Type: application/json" \ --data '{"Name":"MSSQL DEV Admin","onwerId":"1b4bc56d489d9543a",SchemaName":"database-odbc-dsn-mssql","Parameters":{},"DataSource":{"object":{"name":"SQL Server DEV","SchemaName":"database-odbc-dsn-mssql","parameters":{"dsn":"sql server"}}},"Credentials":{"main":{"object":{"name":"SQL Server Admin Credentials","SchemaName":"username_password","parameters":{},"userName":"admin","secrets":{"password":{"value":{"text":"password"},"Parameters":{}}}}}}}'
Um die Freigabe einer DCM-Verbindung aufzuheben, deren Freigabetyp als „Zur Ausführung freigegeben“ definiert ist, verwenden Sie den Endpunkt DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/execution .
Parameter
objectId (Zeichenfolge): erforderlich. Geben Sie die DCM-Verbindungs-ID ein, deren Freigabe zur Ausführung aufgehoben werden soll.
Anforderungsbeispiel: cURL
curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/execution' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Um die Freigabe einer DCM-Verbindung aufzuheben, deren Freigabetyp als „Für Zusammenarbeit freigegeben“ definiert ist, verwenden Sie den Endpunkt DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/collaboration .
Parameter
objectId (Zeichenfolge): erforderlich. Geben Sie die DCM-Verbindungs-ID ein, deren Freigabe für die Zusammenarbeit aufgehoben werden soll.
Anforderungsbeispiel: cURL
curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/collaboration' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Um einen DCM-Verbindungsdatensatz zu löschen, verwenden Sie den Endpunkt DELETE {baseURL}/v3/dcm/admin/connections/{objectId} . Die Datenquelle und die Anmeldedaten werden ebenfalls gelöscht, es sei denn, sie werden in einer anderen Verbindung verwendet.
Parameter
objectId (Zeichenfolge): erforderlich. Geben Sie die DCM-Verbindungs-ID ein, die Sie löschen möchten.
Anforderungsbeispiel: cURL
curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Objektbeziehungen
Wenn Sie eine DCM-Verbindung erstellen, können Sie erstellte Objekte wie folgt verwenden:
Erstelltes Objekt:
„ id “ (z. B. "id": "c128cc5fca-86cc-4e7e-93a3-d500cca9a3f3")
„ connectionId “ (z. B. "id": "c0332423423-86cc-4e7e-93a3-d500cca9a3f3")
Sie können sie wie folgt verwenden:
id , wenn Sie einen DCM-Verbindungsdatensatz abrufen möchten
connectionId , wenn Sie eine DCM-Verbindung wie in Workflows referenziert abrufen möchten
id , wenn Sie eine DCM-Verbindung für angegebene Benutzer und Gruppen freigeben möchten
id , wenn Sie eine DCM-Verbindung aktualisieren möchten
id , wenn Sie eine DCM-Verbindung löschen möchten
id , wenn Sie die Freigabe einer DCM-Verbindung aufheben möchten
Admin :
id , wenn Sie einen DCM-Verbindungsdatensatz abrufen möchten
ownerId (userId), wenn Sie eine DCM-Verbindung im Namen eines Benutzers erstellen möchten
id , wenn Sie eine DCM-Verbindung im Namen eines Benutzers aktualisieren möchten
id , wenn Sie die Freigabe einer DCM-Verbindung, die zur Ausführung freigegeben wurde, aufheben möchten
id , wenn Sie die Freigabe einer DCM-Verbindung, die für die Zusammenarbeit freigegeben wurde, aufheben möchten
id , wenn Sie eine DCM-Verbindung löschen möchten