Skip to main content

Points de terminaison DCM

Points de terminaison et propriétés DCM

Les points de terminaison DCM sont divisés en deux groupes : les points de terminaison DCM pour les utilisateurs et les points de terminaison DCM pour les administrateurs. Tous les points de terminaison DCM nécessitent que TLS soit configuré sur Server.

Pour en savoir plus sur les relations d'objets et sur leur utilisation dans l'API, consultez la section Relations d'objets.

Pour plus d'informations sur les connexions aux données, consultez les pages d'aide DCM - Server et Gestionnaire de connexion aux données : interface utilisateur Server.DCM - ServerGestionnaire de connexion aux données : interface utilisateur Server

Qu'est-ce qu'une connexion DCM ?

Une connexion DCM est composée de ses propres paramètres et de deux types de sous-objets : DataSource (il n'y en a toujours qu'une) et Credentials (dans les scénarios courants, les informations d'identification sont au nombre de zéro, une ou deux. Dans de rares cas, il peut y en avoir encore plus, le nombre est spécifique au connecteur). Chaque Credential a un credRole différent dans la connexion. L'API DCM fonctionne sur les connexions comme des objets entiers, y compris DataSource et Credentials.

Comment un connecteur est-il lié à une connexion DCM ?

Un connecteur est un élément de code qui permet à Alteryx de communiquer avec des sources de données externes. Chaque connecteur nécessite un ensemble spécifique de paramètres pour établir cette communication. Collectivement, nous appelons ces paramètres une connexion DCM. Les paramètres exacts pris en charge par un connecteur sont définis et communiqués à DCM via un schéma DCM, qui est identifié de manière unique par son schemaName.

Un connecteur unique peut prendre en charge plusieurs méthodes d'authentification ou protocoles de communication, chacun avec son propre ensemble de paramètres. Par conséquent, un connecteur peut enregistrer plusieurs schémas DCM avec des valeurs schemaName différentes.

Un schéma de connexion est structuré de la même manière que d'autres objets DCM, comprenant à la fois un schéma DataSource et des schémas Credential. Cela signifie que Connection.schemaName détermine également quel DataSource.schemaName et quels Credential.schemaNames doivent être utilisés dans l'objet de connexion créé pour ce schéma de connexion spécifique.

schemaNames pour le connecteur ODBC vers SQL Server

  • ODBC Microsoft SQL Server sans DSN (authentification intégrée Azure Active Directory)

    schemaName: "database-odbc-mssql-adintegrated"

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

    • credentials: none

  • ODBC Microsoft SQL Server sans DSN (identité de service managée Azure)

    schemaName: "database-odbc-mssql-admsi"

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

    • credentials:

      credRole: "main", schemaName: "azure_managed_identity"

  • ODBC Microsoft SQL Server sans DSN (mot de passe Azure Active Directory)

    schemaName: "database-odbc-mssql-adpwd"

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

    • credentials:

      credRole: "main", schemaName: "username_password"

  • ODBC Microsoft SQL Server sans DSN (principal du service Azure Active Directory)

    schemaName: "database-odbc-mssql-adsp"

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

    • credentials:

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

  • ODBC Microsoft SQL Server sans DSN (Nom d'utilisateur uniquement)

    schemaName: "database-odbc-mssql-nopwd"

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

    • credentials:

      credRole: "main", schemaName: "username"

  • ODBC Microsoft SQL Server sans DSN (Azure AD)

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

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

    • credentials:

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

  • ODBC Microsoft SQL Server sans DSN (Azure AD - privé)

    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"

  • ODBC Microsoft SQL Server sans DSN (OAuth2 générique)

    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"

  • ODBC Microsoft SQL Server sans DSN (authentification Windows)

    schemaName: "database-odbc-mssql-winauth"

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

    • credentials: None

  • ODBC Microsoft SQL Server sans DSN (Nom d'utilisateur - Mot de passe)

    schemaName: "database-odbc-mssql"

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

    • credentials:

      credRole: "main", schemaName: "username_password"

  • Microsoft SQL Server ODBC (aucune information d'identification)

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

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

    • credentials: None

  • Microsoft SQL Server ODBC (nom d'utilisateur uniquement)

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

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

    • credentials:

      credRole: "main", schemaName: "username"

  • ODBC Microsoft SQL Server (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"

  • ODBC Microsoft SQL Server (Azure AD - privé)

    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"

  • ODBC Microsoft SQL Server (OAuth2 générique)

    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 (nom d'utilisateur - mot de passe)

    schemaName: "database-odbc-dsn-mssql"

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

    • credentials:

      credRole: "main", schemaName: "username_password"

Points de terminaison DCM pour les utilisateurs

Ces points de terminaison peuvent être utilisés par les utilisateurs disposant d'un accès à l'API :

Note

  • Tous les points de terminaison d'API renvoient des données utilisateur individuelles (chaque utilisateur ne peut voir et gérer que ses propres connexions).

  • Tous les exemples sont dans PowerShell.

Obtenir une connexion

Pour obtenir un enregistrement de connexion, utilisez le point de terminaison GET {baseURL}/v3/dcm/connections/{id}. Le point de terminaison renvoie toutes les informations sur la connexion, y compris la source de données et les informations d'identification associées ainsi que les informations de partage.

Propriétés

id (chaîne) : obligatoire. Saisissez l'ID de la connexion DCM sur laquelle vous souhaitez obtenir des informations.

Exemple de demande : cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Obtenir une connexion telle que référencée dans les workflows

Pour récupérer un enregistrement de connexion tel qu'il est référencé dans les workflows, utilisez le point de terminaison GET {baseURL}/v3/dcm/connections/lookup. Le point de terminaison renvoie toutes les informations sur la connexion, y compris la source de données et les informations d'identification associées ainsi que les informations de partage.

Note

Le connectionID utilisé dans ce point de terminaison est différent de l'ID utilisé dans les autres points de terminaison DCM. L'ID est utilisé pour référencer divers objets DCM, tandis que le connectionID est uniquement utilisé dans les workflows pour référencer la connexion DCM pour des utilisateurs spécifiques.

Propriétés

connectionId (chaîne) : obligatoire. Saisissez l'ID de connexion DCM sur lequel vous souhaitez obtenir des informations.

Exemple de demande : cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/connections/lookup?connectionId=d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Partager la connexion

Pour partager une connexion pour l'exécution de Server avec des utilisateurs ou des groupes précisés, utilisez le point de terminaison PUT {baseURL}/v3/dcm/connections/{id}/sharing/execution.

Note

Comme il s'agit d'un point de terminaison PUT, il remplace le partage existant, plutôt que d'ajouter des utilisateurs ou des groupes d'utilisateurs supplémentaires à la liste existante. La liste d'utilisateurs et de groupes fournie ne peut pas être vide. Pour supprimer un partage existant, utilisez le point de terminaison DELETE.

Propriétés

  • id (chaîne) : obligatoire. Saisissez l'ID de connexion DCM que vous souhaitez partager avec d'autres utilisateurs ou groupes.

  • sharingContract (corps) : obligatoire. Pour mettre à jour le partage d'exécution, le paramètre « sharingContract » est obligatoire. Les deux tableaux sont requis alors qu'un seul peut être laissé vide.

    • userIds (tableau de chaînes) : saisissez une liste de tous les ID d'utilisateurs avec lesquels partager la connexion. Laissez un tableau vide si vous ne souhaitez la partager avec aucun utilisateur (groupes d'utilisateurs uniquement).

    • userGroupIds (tableau de chaînes) : saisissez une liste de tous les ID de groupes d'utilisateurs avec lesquels partager la connexion. Laissez un tableau vide si vous ne souhaitez la partager avec aucun groupe d'utilisateurs (utilisateurs uniquement).

Exemple de demande : 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"
    ]
  }'

Annuler le partage d'une connexion

Pour annuler le partage d'une connexion, utilisez le point de terminaison DELETE {baseURL}/v3/dcm/connections/{id}/sharing/execution.

Propriétés

id (chaîne) : obligatoire. Saisissez l'ID de connexion DCM que vous ne souhaitez plus partager avec tous les utilisateurs et groupes.

Exemple de demande : cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/execution' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Créer ou mettre à jour la connexion

Pour créer ou mettre à jour une connexion, utilisez le point de terminaison POST {baseURL}/v3/dcm/connections.

Un seul point de terminaison sert à la fois les fonctions de création et de mise à jour, différenciées selon si les ID d'objet sont inclus ou non dans la requête. La réutilisation de sources de données ou d'informations d'identification existantes n'est actuellement pas prise en charge lors de la création de nouvelles connexions.

Propriétés

  • id (chaîne) : facultatif. Saisissez un ID de connexion si vous souhaitez mettre à jour une connexion existante. Ignorez si vous souhaitez créer une nouvelle connexion.

  • name (chaîne) : obligatoire. Saisissez le nom de votre connexion.

    Note

    Il existe plusieurs « noms » dans une connexion DCM :

    • Connection.name : nom de la connexion elle-même. Les administrateurs interagissent avec ce nom via l'API.

    • Connection.dataSource.object.name : nom de la source de données visible dans l'onglet Sources de données de l'interface utilisateur.

    • Connection.credentials.<credRole>.object.name : noms des informations d'identification visibles dans l'onglet Informations d'identification de l'interface utilisateur.

    Pour plus de détails, reportez-vous à la section Qu'est-ce qu'une connexion DCM ?.

  • schemaName (chaîne) : obligatoire. Il s'agit de l'identifiant d'un schéma DCM, utilisé pour afficher et valider les paramètres associés dans l'interface utilisateur DCM. Chaque connecteur définit son propre ensemble de schémas DCM pris en charge. Le schéma de connexion sélectionné spécifie également quels schémas DataSource et Credential doivent être utilisés pour les sections DataSource et Credential de la connexion. Pour plus d'informations, reportez-vous à la section Qu'est-ce qu'une connexion DCM ? et Comment un connecteur est-il lié à une connexion DCM ?

  • allowInSdks (booléen) : facultatif. Rend la connexion accessible aux outils SDK Python.

  • Parameters (objet) : obligatoire. Cette propriété contient les détails de configuration spécifiques au schéma et à la technologie auxquels vous vous connectez.

    Note

    Il existe plusieurs objets parameters dans une structure de connexion DCM, chacun étant utilisé dans un contexte différent :

    • Connection.parameters : pour la connexion globale (pas encore visible dans l'interface utilisateur, bientôt disponible).

    • Connection.dataSource.object.parameters : pour la partie DataSource de la connexion.

    • Connection.credentials.<credRole>.object.parameters : pour chaque rôle Credential.

    • Connection.credentials.<credRole>.object.secrets.<secretType>.parameters : pour les secrets d'identification, par type de secret.

    Chaque objet de paramètres possède sa propre structure et ses propres champs requis, qui dépendent de la technologie et du paramètre schemaName défini dans cette partie de la connexion. Ils sont indépendants et peuvent (souvent) contenir différents champs.

    La propriété parameters est requise, mais peut être fournie sous forme d'objets vides ({}) si aucun paramètre n'est nécessaire pour un schéma donné.

    Conseil :

    Pour déterminer les champs corrects pour tout objet parameters :

    1. Créez une connexion DCM dans l'interface utilisateur d'Alteryx Server pour votre technologie cible.

    2. Interrogez la connexion via l'API : GET /v3/dcm/connections/{id}

    3. Examinez la structure et les champs renvoyés pour chaque objet parameters dans la réponse.

    C'est le moyen le plus fiable de découvrir les champs requis et disponibles pour votre source de données ou vos informations d'identification spécifiques.

    Comme les champs parameters sont spécifiques à la source de données et aux informations d'identification, il est inenvisageable de donner un exemple complet de chaque technologie dans cette documentation. Veuillez utiliser le workflow ci-dessus pour obtenir des exemples à jour et spécifiques à la source.

  • dataSource (objet) : obligatoire. Source de données utilisée pour la connexion, décrivant l'hôte de l'instance de source de données et les paramètres supplémentaires, comme indiqué dans l'interface utilisateur DCM.

    • Object (objet) : obligatoire.

      • id (chaîne) : saisissez un ID de source de données si vous souhaitez mettre à jour une connexion existante. Ignorez si vous souhaitez créer une nouvelle connexion. L'utilisation d'une source de données existante lors de la création de nouvelles connexions est actuellement indisponible.

      • name (chaîne) : obligatoire. Saisissez un nom pour la source de données.

      • schemaName (chaîne) : obligatoire. Saisissez le nom de schéma de la source de données sélectionnée. Pour une description détaillée, reportez-vous à la propriété Connection.schemaName.

      • parameters (objet) : obligatoire. Paramètres de la partie DataSource de la connexion. Pour plus d'informations, reportez-vous à la propriété Connection.parameters. Fournissez un objet vide {} si aucun paramètre n'est nécessaire.

  • credentials (objet) : obligatoire. Paires clé-valeur de <credRole> : objet. Les <credRole> sont définis par le schéma DCM sélectionné. L'objet n'a qu'une seule propriété nommée « object » qui contient ensuite toutes les propriétés Credential. Certaines connexions peuvent ne pas nécessiter d'informations d'identification, tandis que d'autres peuvent avoir plusieurs objets Credential imbriqués.

    Dans les exemples ci-dessous, vous pouvez voir que l'authentification par nom d'utilisateur-mot de passe SQLServer (MSSQL) utilise le <credRole> principal. La connexion Reshift avec l'authentification par groupe d'identités et Snowflake avec l'authentification OAuth utilisent oauthApplication et oauthTokens <credRoles> pour leurs informations d'identification.

    Pour plus d'informations, reportez-vous à la section Qu'est-ce qu'une connexion DCM ? et Comment un connecteur est-il lié à une connexion DCM ?

    • object (objet) : définit les propriétés des parties Credential de la connexion.

      • id (chaîne) : saisissez un ID d'informations d'identification si vous souhaitez mettre à jour une connexion existante. Ignorez si vous souhaitez créer une nouvelle connexion. L'utilisation d'informations d'identification existantes lors de la création de nouvelles connexions est actuellement indisponible.

      • name (chaîne) : obligatoire. Saisissez le nom de vos informations d'identification.

      • schemaName (chaîne) : obligatoire. Saisissez le nom de schéma des informations d'identification sélectionnées.

      • parameters (objet) : obligatoire. Paramètres des parties Credential de la connexion. Pour plus d'informations, reportez-vous à la propriété Connection.parameters. Fournissez un objet vide {} si aucun paramètre n'est nécessaire.

Exemple de demande : cURL

Créez une connexion DCM à SQL Server à l'aide des informations d'identification nom d'utilisateur-mot de passe

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

Créer une connexion DCM ODBC à Redshift à l'aide de l'authentification OAuth avec AWS IAM / Cognito

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

Créer une connexion DCM Snowflake avec des informations d'identification de client OAuth 2.0

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

Supprimer la connexion

Pour supprimer une connexion, utilisez le point de terminaison DELETE {baseURL}/v3/dcm/connections/{id}. La source de données et les informations d'identification seront également supprimées à moins qu'elles ne soient utilisées dans une autre connexion.

Propriétés

id (chaîne) : obligatoire. Saisissez l'ID de connexion DCM à supprimer.

Exemple de demande : cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Points de terminaison DCM pour les administrateurs

Points de terminaison qui peuvent être utilisés par les administrateurs disposant d'un accès à l'API :

Note

  • Tous les points de terminaison de l'API administrateur renvoient toutes les données disponibles sur Server pour tous les utilisateurs, quel que soit le propriétaire.

  • Tous les exemples sont dans PowerShell.

Obtenir une connexion

Pour obtenir un enregistrement de connexion, utilisez le point de terminaison GET {baseURL}/v3/dcm/admin/connections/{objectId}.

Propriétés

objectId (chaîne) : obligatoire. Saisissez l'ID de connexion DCM sur lequel vous souhaitez obtenir des informations.

Exemple de demande : cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Répertorier les connexions

Pour récupérer une liste de tous les enregistrements de connexion présents sur Server, utilisez le point de terminaison GET {baseURL}/v3/dcm/admin/connections.

Propriétés

Les deux paramètres sont des filtres qui peuvent être combinés. Utiliser connectionId et visibleBy ensemble renverra la connexion avec le connectionID indiqué, visible par l'utilisateur spécifié.

  • connectionId (chaîne) : facultatif. Filtre les connexions par leur connectionID, tel qu'il est référencé à partir d'un workflow. Plusieurs connexions peuvent être renvoyées pour un connectionID unique, si la connexion est partagée pour la collaboration.

  • visibleBy (chaîne) : facultatif. Saisissez l'ID d'utilisateur. S'il est présent, il filtre les résultats pour obtenir le même résultat que pour toutes les connexions disponibles pour l'utilisateur spécifié.

Exemple de demande : cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connections?connectionId=d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3&visibleBy=bc7cb7b47c33' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Créer ou mettre à jour une connexion au nom de l'utilisateur

Pour créer ou mettre à jour un enregistrement de connexion au nom d'un utilisateur, utilisez le point de terminaison POST {baseURL}/v3/dcm/admin/connections.

Propriétés

Utilisez les mêmes propriétés que celles décrites dans la section Créer ou mettre à jour la connexion. La seule propriété supplémentaire requise pour ce point de terminaison est ownerId.

ownerId (chaîne) : obligatoire.

  • Lors de la création d'une connexion, saisissez l'ID de l'utilisateur pour le compte duquel la connexion doit être créée.

  • Lors de la mise à jour d'une connexion, vous devez également saisir le paramètre ownerId même si vous ne voulez pas le modifier. Pour plus d'informations sur l'obtention d'un ownerID, consultez la section Obtenir une connexion ou Répertorier les connexions.

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

Annuler le partage d'une connexion partagée pour l'exécution

Pour annuler le partage d'une connexion dont le type de partage a été défini sur Partagé pour l'exécution, utilisez le point de terminaison DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/execution.

Propriétés

objectId (chaîne) : obligatoire. Saisissez l'ID de connexion DCM à ne plus partager pour l'exécution.

Exemple de demande : cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/execution' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Annuler le partage d'une connexion partagée pour la collaboration

Pour annuler le partage d'une connexion dont le type de partage a été défini sur Partagé pour la collaboration, utilisez le point de terminaison DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/collaboration.

Propriétés

objectId (chaîne) : obligatoire. Saisissez l'ID de connexion DCM à ne plus partager pour la collaboration.

Exemple de demande : cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/collaboration' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Supprimer la connexion

Pour supprimer un enregistrement de connexion, utilisez le point de terminaison DELETE {baseURL}/v3/dcm/admin/connections/{objectId}. La source de données et les informations d'identification seront également supprimées à moins qu'elles ne soient utilisées dans une autre connexion.

Propriétés

objectId (chaîne) : obligatoire. Saisissez l'ID de connexion DCM à supprimer.

Exemple de demande : cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Obtenir toutes les règles de gestion des connexions

Pour obtenir toutes les règles de gestion des connexions, utilisez le point de terminaison GET {baseURL}/v3/dcm/admin/connectionhandlingrules.

Consultez la section Gestion des connexions DCM pour en savoir plus.

Propriétés

Aucune propriété.

Exemple de demande : cURL

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

Supprimer la règle de gestion des connexions

Pour obtenir une règle spécifique de gestion des connexions DCM, utilisez le point de terminaison GET {baseURL}/v3/dcm/admin/connectionhandlingrules/{id}.

Propriétés

id (chaîne) : obligatoire. Spécifiez l'ID de la règle de gestion des connexions DCM à renvoyer.

Exemple de demande : cURL

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

Ajouter ou mettre à jour une règle de gestion des connexions

Pour ajouter une nouvelle règle de gestion des connexions ou mettre à jour une règle existante, utilisez le point de terminaison POST {baseURL}/v3/dcm/admin/connectionhandlingrules.

Propriétés

Saisissez les propriétés suivantes pour créer ou mettre à jour une règle de gestion des connexions DCM :

  • rule (corps) : obligatoire. La règle de gestion des connexions DCM à créer ou mettre à jour.

    • id (chaîne) : facultatif. L'ID de la règle de gestion des connexions DCM. Saisissez un ID de règle de gestion des connexions DCM si vous souhaitez mettre à jour une règle de gestion des connexions existante. Ignorez si vous souhaitez créer une règle de gestion des connexions.

    • sourceConnectionId (chaîne) : saisissez un sourceConnectionId pour faire référence à un ConnectionId à remplacer lors de l'exécution du workflow. La connexion ne doit pas nécessairement exister sur le Server (les workflows qui la référencent peuvent toujours être exécutés). Elle ne peut pas être utilisée dans une autre règle existante, qu'il s'agisse d'une connexion source ou d'une connexion cible.

    • sourceConnectionTitle (chaîne) : saisissez un nom personnalisé ou une description de la connexion source.

    • targetConnectionId (chaîne) : saisissez un targetConnectionId. Doit faire référence à une connexion DCM présente sur le Server.

    • targetConnectionTitle (chaîne) : facultatif. Saisissez un nom personnalisé ou une description de la connexion cible. Il se complète automatiquement avec le titre de la connexion sélectionnée.

Exemple de demande : 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"
}'

Supprimer la règle de gestion des connexions

Pour supprimer une règle de gestion des connexions existante, utilisez le point de terminaison DELETE {baseURL}/v3/dcm/admin/connectionhandlingrules/{id}.

Propriétés

id (chaîne) : obligatoire. Spécifiez l'ID de règle de gestion des connexions DCM que vous souhaitez supprimer.

Exemple de demande : cURL

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

Relations d'objets

Si vous créez une connexion, vous pouvez utiliser les objets créés comme suit :

Objet créé :

  • « id » (par exemple, « id » : « 3c128cc5fca-86cc-4e7e-93a3-d500cca9a3f3 »)

  • « connectionId » (par exemple, « id » : « c0332423423-86cc-4e7e-93a3-d500cca9a3f3 »)

Vous pouvez l'utiliser comme :

Administrateur :

Dans cette section​: