Skip to main content

DCM-Endpunkte

DCM-Endpunkte und -Eigenschaften

Die DCM-Endpunkte sind in zwei Gruppen unterteilt: DCM-Endpunkte für Benutzer:innen und DCM-Endpunkte für Administrator:innen. Für alle DCM-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.DCM – ServerData Connection Manager: Server-Benutzeroberfläche

Was ist eine DCM-Verbindung?

Eine DCM-Verbindung besteht aus ihren eigenen parameters und zwei Unterobjekt-Typen: DataSource (es gibt immer nur eine) und Credentials (in gängigen Szenarien liegt die Anzahl bei null, eins oder zwei. In seltenen Fällen kann es sogar noch mehr geben; die Anzahl ist konnektorspezifisch). Jede Credential hat innerhalb der Verbindung eine andere credRole. Die DCM-API arbeitet mit Verbindungen als ganze Objekte, einschließlich DataSource und Credentials.

Wie hängt ein Konnektor mit einer DCM-Verbindung zusammen?

Ein Konnektor ist ein Code, der es Alteryx ermöglicht, mit externen Datenquellen zu kommunizieren. Jeder Konnektor benötigt einen bestimmten Parametersatz, um diese Kommunikation herzustellen. Gemeinsam bezeichnen wir diese Parameter als „DCM-Verbindung“. Die genauen Parameter, die von einem Konnektor unterstützt werden, werden festgelegt und über ein DCM-Schema, das eindeutig über seinen schemaName identifizierbar ist, an den DCM übermittelt.

Ein einzelner Konnektor kann mehrere Authentifizierungsmethoden oder Kommunikationsprotokolle mit jeweils eigenen Parametersätzen unterstützen. Daher kann ein Konnektor mehrere DCM-Schemas mit unterschiedlichen schemaName-Werten registrieren.

Ein Verbindungsschema ist genauso strukturiert wie andere DCM-Objekte und umfasst sowohl ein DataSource-Schema als auch ein Credential-Schema. Das bedeutet, dass der Connection.schemaName auch bestimmt, welchen DataSource.schemaName und welche Credential.schemaNames innerhalb des Verbindungsobjekts verwendet werden müssen, das für dieses spezifische Verbindungsschema erstellt wird.

schemaNames für ODBC-Konnektor zu SQL Server

  • Microsoft SQL Server ODBC DSN-los (Azure integrierte Active Directory-Authentifizierung)

    schemaName: "database-odbc-mssql-adintegrated"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials: keine

  • Microsoft SQL Server ODBC DSN-los (Azure verwaltete Dienst-Identität)

    schemaName: "database-odbc-mssql-admsi"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials:

      credRole: "main", schemaName: "azure_managed_identity"

  • Microsoft SQL Server ODBC DSN-los (Azure Active Directory-Kennwort)

    schemaName: "database-odbc-mssql-adpwd"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials:

      credRole: "main", schemaName: "username_password"

  • Microsoft SQL Server ODBC DSN-los (Azure Active Directory-Dienstprinzipal)

    schemaName: "database-odbc-mssql-adsp"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials:

      credRole: "oatuhApplication", schemaName: "database-odbc-mssql-adsp"

  • Microsoft SQL Server ODBC DSN-los (Nur Benutzername)

    schemaName: "database-odbc-mssql-nopwd"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials:

      credRole: "main", schemaName: "username"

  • Microsoft SQL Server ODBC DSN-los (Azure AD)

    schemaName: "database-odbc-mssql-oauth-azure-ayxapp"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials:

      credRole: "oauthTokens", schemaName: "database-ms-oauth-azure-ayxapp-tokens"

  • Microsoft SQL Server ODBC DSN-los (Azure AD – Privat)

    schemaName: "database-odbc-mssql-oauth-azure"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials:

      • credRole: "oauthApplication", schemaName: "database-ms-oauth-azure-application"

      • credRole: "oauthTokens", schemaName: "database-ms-oauth-azure-tokens"

  • Microsoft SQL Server ODBC DSN-los (Generisches OAuth2)

    schemaName: "database-odbc-mssql-oauth-generic-configurable"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials:

      • credRole: "oauthApplication", schemaName: "generic-configurable-oauth-application"

      • credRole: "oauthTokens", schemaName: "generic-configurable-oauth-tokens"

  • Microsoft SQL Server ODBC DSN-los (Windows-Authentifizierung)

    schemaName: "database-odbc-mssql-winauth"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials: keine

  • Microsoft SQL Server ODBC DSN-los (Benutzername – Kennwort)

    schemaName: "database-odbc-mssql"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials:

      credRole: "main", schemaName: "username_password"

  • Microsoft SQL Server ODBC (Keine Anmeldedaten)

    schemaName: "database-odbc-dsn-mssql-nocreds"

    • dataSource.schemaName: "database-odbc-dsn-mssql"

    • credentials: keine

  • Microsoft SQL Server ODBC (nur Benutzername)

    schemaName: "database-odbc-dsn-mssql-nopwd"

    • dataSource.schemaName: "database-odbc-dsn-mssql"

    • credentials:

      credRole: "main", schemaName: "username"

  • Microsoft SQL Server ODBC (Azure AD)

    schemaName: "database-odbc-dsn-mssql-oauth-azure-ayxapp"

    • dataSource.schemaName: "database-odbc-dsn-mssql"

    • credentials:

      credRole: "oauthTokens", schemaName: "database-ms-oauth-azure-ayxapp-tokens"

  • Microsoft SQL Server ODBC (Azure AD – Privat)

    schemaName: "database-odbc-dsn-mssql-oauth-azure"

    • dataSource.schemaName: "database-odbc-dsn-mssql"

    • credentials:

      • credRole: "oauthApplication", schemaName: "database-hana-oauth-azure-application"

      • credRole: "oauthTokens", schemaName: "database-hana-oauth-azure-tokens"

  • Microsoft SQL Server ODBC (Generisches OAuth2)

    schemaName: "database-odbc-dsn-mssql-oauth-generic-configurable"

    • dataSource.schemaName: "database-odbc-dsn-mssql"

    • credentials:

      • credRole: "oauthApplication", schemaName: "generic-configurable-oauth-application"

      • credRole: "oauthTokens", schemaName: "generic-configurable-oauth-tokens"

  • Microsoft SQL Server ODBC (Benutzername – Kennwort)

    schemaName: "database-odbc-dsn-mssql"

    • dataSource.schemaName: "database-odbc-dsn-mssql"

    • credentials:

      credRole: "main", schemaName: "username_password"

DCM-Endpunkte für Benutzer:innen

Diese Endpunkte können von Benutzern mit API-Zugriff verwendet werden:

Anmerkung

  • Alle API-Endpunkte geben individuelle Benutzerdaten zurück (jeder Benutzer kann nur seine eigenen Verbindungen sehen und verwalten).

  • Alle Beispiele sind in PowerShell enthalten.

Verbindung abrufen

Um einen Verbindungsdatensatz abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/dcm/connections/{id}. Der Endpunkt gibt alle Informationen über die Verbindung zurück, einschließlich der zugehörigen Datenquelle und Anmeldedaten sowie der Informationen zur Freigabe.

Eigenschaften

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'

Verbindung wie in Workflows referenziert abrufen

Um einen 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 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.

Eigenschaften

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'

Verbindung teilen

Um eine Verbindung für die Server-Ausführung für angegebene Benutzer:innen 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:innen und Gruppen darf nicht leer sein. Um eine vorhandene Freigabe zu entfernen, verwenden Sie den DELETE-Endpunkt.

Eigenschaften

  • 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"
    ]
  }'

Freigabe einer Verbindung aufheben

Um die Freigabe einer Verbindung aufzuheben, verwenden Sie den Endpunkt DELETE {baseURL}/v3/dcm/connections/{id}/sharing/execution.

Eigenschaften

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'

Verbindung erstellen oder aktualisieren

Um eine 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.

Eigenschaften

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

    Anmerkung

    Es gibt mehrere „names“ innerhalb einer DCM-Verbindung:

    • Connection.name: Der Name der Verbindung selbst. Administrator:innen interagieren mit diesem Namen über die API.

    • Connection.dataSource.object.name: Name der Datenquelle, der auf der Registerkarte „Datenquellen“ in der Benutzeroberfläche sichtbar ist.

    • Connection.credentials.<credRole>.object.name: Anmeldedatennamen, die auf der Registerkarte „Anmeldedaten“ in der Benutzeroberfläche sichtbar sind.

    Weitere Informationen finden Sie im Abschnitt Was ist eine DCM-Verbindung?.

  • schemaName (Zeichenfolge): erforderlich. Dies ist die Kennung für ein DCM-Schema, das zum Anzeigen und Validieren der zugehörigen Parameter in der DCM-Benutzeroberfläche verwendet wird. Jeder Konnektor definiert seinen eigenen Satz unterstützter DCM-Schemas. Das ausgewählte Verbindungsschema gibt auch an, welche „DataSource“- und „Credential“-Schemas für die „DataSource“- und „Credential“-Abschnitte der Verbindung verwendet werden müssen. Weitere Informationen finden Sie unter Was ist eine DCM-Verbindung? und Wie hängt ein Konnektor mit einer DCM-Verbindung zusammen?

  • allowInSdks (boolescher Wert): optional. Macht die Verbindung für Python-SDK-Tools zugänglich.

  • parameters (Objekt): erforderlich. Diese Eigenschaft enthält die für das Schema spezifischen Konfigurationsdetails und die Technologie, zu der Sie eine Verbindung herstellen.

    Anmerkung

    Es gibt mehrere verschiedene parameters-Objekte in einer DCM-Verbindungsstruktur, die jeweils in einem anderen Kontext verwendet werden:

    • Connection.parameters: für die Gesamtverbindung (noch nicht in der Benutzeroberfläche sichtbar, in Kürze verfügbar).

    • Connection.dataSource.object.parameters: für den Datenquellenteil der Verbindung.

    • Connection.credentials.<credRole>.object.parameters: für jede Anmeldedatenrolle.

    • Connection.credentials.<credRole>.object.secrets.<secretType>.parameters: für Anmeldedatengeheimnisse, pro Geheimnistyp.

    Jedes Parameterobjekt verfügt über eine eigene Struktur und erforderliche Felder, die von der Technologie und dem in diesem Teil der Verbindung festgelegten schemaName abhängen. Sie sind unabhängig und können verschiedene Felder enthalten (und das tun sie auch oft).

    Die parameters-Eigenschaft ist erforderlich, kann aber als leere Objekte ({}) angegeben werden, wenn für ein bestimmtes Schema keine Parameter erforderlich sind.

    Tipp:

    So bestimmen Sie die richtigen Felder für jedes Parameterobjekt:

    1. Erstellen Sie eine DCM-Verbindung in der Alteryx Server-Benutzeroberfläche für Ihre Zieltechnologie.

    2. Fragen Sie die Verbindung über die API ab: GET /v3/dcm/connections/{id}

    3. Prüfen Sie die Struktur und die Felder, die für jedes parameters-Objekt in der Antwort zurückgegeben werden.

    Dies ist die zuverlässigste Möglichkeit, die erforderlichen und verfügbaren Felder für Ihre spezifische Datenquelle oder spezifischen Anmeldedaten zu ermitteln.

    Da parameters-Felder datenquellen- und anmeldedatenspezifisch sind, ist in dieser Dokumentation ein umfassendes Beispiel für jede Technologie nicht praktikabel. Bitte verwenden Sie den obigen Workflow, um aktuelle, quellenspezifische Beispiele zu erhalten.

  • 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. Eine detaillierte Beschreibung finden Sie in der Connection.schemaName-Eigenschaft.

      • parameters (Objekt): erforderlich. Parameter für den DataSource-Teil der Verbindung. Weitere Einzelheiten finden Sie in der Connection.parameters-Eigenschaft. Geben Sie ein leeres Objekt {} an, wenn keine Parameter erforderlich sind.

  • credentials (Objekt): erforderlich. Schlüssel-Wert-Paare von <credRole>: object. <credRole>s werden über das ausgewählte DCM-Schema festgelegt. Das object hat nur eine Eigenschaft namens „object“, die dann alle Anmeldedateneigenschaften enthält. Für manche Verbindungen sind möglicherweise keine Anmeldedaten erforderlich, während andere mehrere verschachtelte Anmeldedatenobjekte haben können.

    Anhand der folgenden Beispiele können Sie sehen, dass die Benutzername-Kennwort-Authentifizierung von SQLServer (MSSQL) die Haupt-<credRole> verwendet. Redshift-Verbindungen mit Identity Pool-Authentifizierung und Snowflake mit OAuth-Authentifizierung verwenden oauthApplication und oauthTokens <credRoles> für ihre Anmeldedaten.

    Weitere Informationen finden Sie unter Was ist eine DCM-Verbindung? und Wie hängt ein Konnektor mit einer DCM-Verbindung zusammen?

    • object (Objekt): legt Eigenschaften von Anmeldedatenteilen der Verbindung fest.

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

      • parameters (Objekt): erforderlich. Parameter für die Credential-Teile der Verbindung. Weitere Einzelheiten finden Sie in der Connection.parameters-Eigenschaft. Geben Sie ein leeres Objekt {} an, wenn keine Parameter erforderlich sind.

Anforderungsbeispiel: cURL

SQL Server-DCM-Verbindung mit den Anmeldedaten für Benutzername und Kennwort erstellen

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": {}
            }
          }
        }
      }
    }
  }'

ODBC-DCM-Verbindung zu Redshift unter Verwendung von OAuth-Authentifizierung mit AWS IAM/Cognito herstellen

curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' `
  --header 'Authorization: Bearer BearerTokenGoesHere' `
  --header 'Content-Type: application/json' `
  --data '{
    "name": "Connection Name",
    "schemaName": "database-odbc-redshift-simba-oauth-iam-identitypool",
    "allowInSdks": false,
    "parameters": {},
    "dataSource": {
        "object": {
            "name": "DataSource Name",
            "schemaName": "database-odbc-redshift-simba",
            "drvName": "Simba Amazon Redshift ODBC Driver",
            "host": "##### (my-database-host.redshift.amazonaws.com)",
            "parameters": {
                "allowSelfSignedServerCert": false,
                "checkCertRevocation": false,
                "database": "#####",
                "minTLS": 2,
                "port": 5439,
                "sslMmode": "require",
                "useSystemTrustStore": false
            }
        }
    },
    "credentials": {
        "oauthApplication": {
            "object": {
                "name": "Application Credential Name",
                "schemaName": "database-redshift-aws-oauth-iam-identitypool-application",
                "userName": "##### (Client Secret)",
                "parameters": {
                    "accountId": "#####",
                    "authorityURL": "##### (https://my-authorization-host.amazoncognito.com)",
                    "awsRegion": "##### (us-west-2)",
                    "dbUser": "#####",
                    "identityPoolId": "#####",
                    "redirectURI": "##### (http://localhost:5634)",
                    "userPoolId": "#####"
                },
                "secrets": {
                }
            }
        },
        "oauthTokens": {
            "object": {
                "name": "Tokens Credential Name",
                "schemaName": "aws-oauth-iam-identitypool-tokens",
                "parameters": {},
                "secrets": {
                }
            }
        }
    }
}'

Snowflake-DCM-Verbindung mit OAuth 2.0-Client-Anmeldedaten herstellen

curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' `
  --header 'Authorization: Bearer BearerTokenGoesHere' `
  --header 'Content-Type: application/json' `
  --data '{
    "name": "Connection Name",
    "schemaName": "database-odbc-snowflake-simba-oauth-generic-configurable",
    "allowInSdks": false,
    "parameters": {},
    "dataSource": {
        "object": {
            "name": "DataSource Name",
            "schemaName": "database-odbc-snowflake-simba",
            "drvName": "Simba Snowflake ODBC Driver",
            "host": "##### (my-domain.snowflakecomputing.com)",
            "parameters": {
                "database": "#####",
                "schema": "#####",
                "warehouse": "#####"
            }
        }
    },
    "credentials": {
        "oauthApplication": {
            "object": {
                "name": "Application Credential Name",
                "schemaName": "generic-configurable-oauth-application",
                "userName": "##### (Client Id)",
                "parameters": {
                    "clientAuthentication": "body",
                    "grantType": "clientCredentials",
                    "tokenURL": "#####"
                },
                "secrets": {
                    "clientSecret": {
                        "expiresOn": null,
                        "parameters": {},
                        "value": {
                            "text": "##### (Client Secret)"
                        }
                    }
                }
            }
        },
        "oauthTokens": {
            "object": {
                "name": "Tokens Credential Name",
                "schemaName": "generic-configurable-oauth-tokens",
                "userName": null,
                "parameters": {
                    "scope": "#####"
                },
                "secrets": {}
            }
        }
    }
}'

Verbindung löschen

Um eine 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.

Eigenschaften

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'

DCM-Endpunkte für Administrator:innen

Endpunkte, die von Administratoren mit API-Zugriff verwendet werden können:

Anmerkung

  • Alle Administrator-API-Endpunkte geben alle auf dem Server verfügbaren Daten für alle Benutzer zurück, unabhängig von der Eigentümerschaft.

  • Alle Beispiele sind in PowerShell enthalten.

Verbindung abrufen

Um einen Verbindungsdatensatz abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/dcm/admin/connections/{objectId}.

Eigenschaften

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'

Verbindungen auflisten

Um eine Liste aller auf dem Server vorhandenen Verbindungsdatensätze abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/dcm/admin/connections.

Eigenschaften

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'

Verbindung im Namen von Benutzer:in erstellen oder aktualisieren

Um einen Verbindungsdatensatz im Namen von Benutzer:innen zu erstellen oder zu aktualisieren, verwenden Sie den Endpunkt POST {baseURL}/v3/dcm/admin/connections.

Eigenschaften

Verwenden Sie dieselben Eigenschaften wie im Abschnitt Verbindung erstellen oder aktualisieren beschrieben. Die einzige zusätzliche Eigenschaft, die für diesen Endpunkt erforderlich ist, ist ownerId.

ownerId (Zeichenfolge): erforderlich.

  • Geben Sie beim Erstellen einer Verbindung die ID des/der Benutzer:in ein, in dessen Namen die Verbindung erstellt werden soll.

  • Beim Aktualisieren einer 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 Verbindung abrufen oder Verbindungen auflisten.

Anforderungsbeispiel: cURL

curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' `
  --header 'Authorization: Bearer BearerTokenGoesHere' `
  --header 'Content-Type: application/json' `
  --data '{
    "upsertConnectionContract": {
      "name": "MSSQL DEV Admin",
      "ownerId": "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": {}
              }
            }
          }
        }
      }
    }
  }'

Freigabe einer Verbindung aufheben, die zur Ausführung freigegeben wurde

Um die Freigabe einer Verbindung aufzuheben, deren Freigabetyp als „Zur Ausführung freigegeben“ definiert ist, verwenden Sie den Endpunkt DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/execution.

Eigenschaften

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'

Freigabe einer Verbindung aufheben, die für die Zusammenarbeit freigegeben wurde

Um die Freigabe einer Verbindung aufzuheben, deren Freigabetyp als „Für Zusammenarbeit freigegeben“ definiert ist, verwenden Sie den Endpunkt DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/collaboration.

Eigenschaften

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'

Verbindung löschen

Um einen 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.

Eigenschaften

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'

Alle Verbindungsbehandlungsregeln abrufen

Um alle Verbindungsbehandlungsregeln abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/dcm/admin/connectionhandlingrules.

Weitere Informationen finden Sie unter DCM-Verbindungsbehandlung.

Eigenschaften

Keine Eigenschaften.

Anforderungsbeispiel: cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Verbindungsbehandlungsregel abrufen

Um eine bestimmte DCM-Verbindungsbehandlungsregel abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/dcm/admin/connectionhandlingrules/{id}.

Eigenschaften

id (Zeichenfolge): erforderlich. Geben Sie die ID der DCM-Verbindungsbehandlungsregel an, die zurückgegeben werden soll.

Anforderungsbeispiel: cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules/{id}' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Verbindungsbehandlungsregel hinzufügen oder aktualisieren

Um eine neue Verbindungsbehandlungsregel hinzuzufügen oder eine vorhandene Regel zu aktualisieren, verwenden Sie den Endpunkt POST {baseURL}/v3/dcm/admin/connectionhandlingrules.

Eigenschaften

Mit den folgenden Eigenschaften können Sie eine DCM-Verbindungsbehandlungsregel erstellen oder aktualisieren:

  • rule (Text): erforderlich. Die DCM-Verbindungsbehandlungsregel, die erstellt oder aktualisiert werden soll.

    • id (Zeichenfolge): optional. Die ID für die DCM-Verbindungsbehandlungsregel. Geben Sie eine DCM-Verbindungsbehandlungsregel-ID ein, wenn Sie eine vorhandene Verbindungsbehandlungsregel aktualisieren möchten. Überspringen Sie dies, wenn Sie eine neue Verbindungsbehandlungsregel erstellen möchten.

    • sourceConnectionId (Zeichenfolge): Geben Sie eine sourceConnectionId ein, die auf eine ConnectionId verweist, die bei der Workflow-Ausführung ersetzt werden soll. Die Verbindung muss nicht auf dem Server vorhanden sein. Workflows, die darauf verweisen, können trotzdem ausgeführt werden. Sie kann für keine andere Regel verwendet werden, ob als Quell- oder Zielverbindung.

    • sourceConnectionTitle (Zeichenfolge): Geben Sie einen benutzerdefinierten Namen oder eine Beschreibung der Quellverbindung ein.

    • targetConnectionId (Zeichenfolge): Geben Sie eine targetConnectionId ein. Diese muss auf eine auf dem Server vorhandene DCM-Verbindung verweisen.

    • targetConnectionTitle (Zeichenfolge): optional. Geben Sie einen benutzerdefinierten Namen oder eine Beschreibung der Zielverbindung ein. Die Eingabe wird automatisch zum Titel der ausgewählten Verbindung vervollständigt.

Anforderungsbeispiel: cURL

curl --location 'https://localhost.com/webapi/v3/dcm/admin/connectionhandlingrules' `
--header 'Content-Type: application/json' `
--header 'Authorization: Bearer BearerTokenGoesHere' `
--data '{
    "sourceConnectionTitle": "MSSQL DEV",
    "sourceConnectionId": "c.cid.d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3",
    "targetConnectionId": "c.cid.cbf55382-f90b-4304-a1cd-37c5cff697e0"
}'

Regel für die Verbindungsbehandlung löschen

Um eine vorhandene Verbindungsbehandlungsregel zu löschen, verwenden Sie den Endpunkt DELETE {baseURL}/v3/dcm/admin/connectionhandlingrules/{id}.

Eigenschaften

id (Zeichenfolge): erforderlich. Geben Sie die DCM-Verbindungsbehandlungregel-ID ein, die Sie löschen möchten.

Anforderungsbeispiel: cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules/{id}' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Objektbeziehungen

Wenn Sie eine 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:

Admin:

In diesem Abschnitt: