Points de terminaison DCME
Points de terminaison et paramètres DCME
Les points de terminaison DCME sont divisés en deux groupes : les points de terminaison DCME pour les utilisateurs et les points de terminaison DCME pour les administrateurs . Tous les points de terminaison DCME 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 .
Points de terminaison DCME pour les utilisateurs
Ces points de terminaison peuvent être utilisés par les utilisateurs disposant d'un accès à l'API :
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).
Pour récupérer un enregistrement de connexion DCM, utilisez le point de terminaison GET {baseURL}/v3/dcm/connections/{id} . Le point de terminaison renvoie toutes les informations sur la connexion DCM, y compris la source de données et les informations d'identification associées ainsi que les informations de partage.
Paramètres
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'
Pour récupérer un enregistrement de connexion DCM 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 DCM, 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.
Paramètres
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'
Pour partager une connexion DCM 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 retirer le partage existant, utilisez le point de terminaison DELETE.
Paramètres
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"]}'
Pour annuler le partage d'une connexion DCM, utilisez le point de terminaison DELETE {baseURL}/v3/dcm/connections/{id}/sharing/execution .
Paramètres
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'
Pour créer ou mettre à jour une connexion DCM, 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.
Paramètres
upsertConnectionContract (chaîne) : obligatoire. La connexion DCM est une combinaison d'une source de données (décrivant l'hôte de l'instance cible) et d'informations d'identification (par exemple, nom d'utilisateur et mot de passe) en définissant la combinaison de schémas possible.
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 (string) : obligatoire. Saisissez le nom de votre connexion.
schemaName (chaîne) : obligatoire. Saisissez un nom de schéma de connexion à utiliser. Le schéma définit les paramètres obligatoires de la connexion ainsi que les schémas de source de données et d'informations d'identification à utiliser pour cette connexion.
allowInSdks (booléen) : facultatif.
parameters (objet) : obligatoire. Divers paramètres peuvent être requis en fonction de la valeur sélectionnée pour le paramètre « schemaName ».
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 (string) : 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.
paramètres supplémentaires spécifiques au schéma : en fonction du schéma utilisé, vous devrez fournir des paramètres de source de données supplémentaires.
credentials (chaîne) : facultatif, en fonction de la valeur sélectionnée pour le paramètre « schemaName » dans upsertConnectionContract. Certaines connexions peuvent ne pas nécessiter d'informations d'identification, tandis que d'autres peuvent avoir plusieurs objets imbriqués (emplacements).
main (objet) : facultatif (voir ci-dessus). « main » n'est qu'un seul nom (le plus courant) d'emplacement d'informations d'identification. Il peut cependant porter un autre nom ou il peut y avoir plusieurs emplacements d'informations d'identification pour la connexion en fonction de ce qui est défini dans le schéma de 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 (string) : 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.
paramètres supplémentaires spécifiques au schéma : en fonction du schéma utilisé, vous devrez fournir des paramètres de source de données supplémentaires.
Exemple de demande : 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":{}}}}}}}'
Pour supprimer une connexion DCM, 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.
Paramètres
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 DCME pour les administrateurs
Points de terminaison qui peuvent être utilisés par les administrateurs disposant d'un accès à l'API :
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.
Pour récupérer un enregistrement de connexion DCM, utilisez le point de terminaison GET {baseURL}/v3/dcm/admin/connections/{objectId} .
Paramètres
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'
Pour récupérer une liste de tous les enregistrements de connexion DCM présents sur Server, utilisez le point de terminaison GET {baseURL}/v3/dcm/admin/connections .
Paramètres
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 (string) : 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'
Pour créer ou mettre à jour un enregistrement de connexion DCM au nom d'un utilisateur, utilisez le point de terminaison POST {baseURL}/v3/dcm/admin/connections .
Paramètres
upsertConnectionContract (chaîne) : obligatoire.
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.
ownerId (chaîne) : obligatoire.
Lors de la création d'une connexion DCM, saisissez l'ID de l'utilisateur pour le compte duquel la connexion doit être créée.
Lors de la mise à jour d'une connexion DCM, 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 les pages Récupérer un enregistrement de connexion DCM ou Récupérer une liste des enregistrements de connexion DCM .
name (string) : obligatoire. Saisissez le nom de votre connexion.
schemaName (chaîne) : obligatoire. Saisissez un nom de schéma de connexion à utiliser. Le schéma définit les paramètres obligatoires de la connexion ainsi que les schémas de source de données et d'informations d'identification à utiliser pour cette connexion.
allowInSdks (booléen) : facultatif.
parameters (objet) : obligatoire. Divers paramètres peuvent être requis en fonction de la valeur sélectionnée pour le paramètre « schemaName ».
dataSource (objet) : obligatoire. La source de données utilisée pour la connexion
object (objet) : obligatoire.
id (chaîne) : saisissez un ID de source de données si vous mettez à 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 (string) : 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.
paramètres supplémentaires spécifiques au schéma : en fonction du schéma utilisé, vous devrez fournir des paramètres de source de données supplémentaires.
credentials (chaîne) : facultatif, en fonction de la valeur sélectionnée pour le paramètre « schemaName » dans upsertConnectionContract. Certaines connexions peuvent ne pas nécessiter d'informations d'identification, tandis que d'autres peuvent en avoir plusieurs.
main (objet) : facultatif (voir ci-dessus).
id (chaîne) : saisissez un ID d'informations d'identification si vous mettez à 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 (string) : 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.
paramètres supplémentaires spécifiques au schéma : en fonction du schéma utilisé, vous devrez fournir des paramètres d'informations d'identification supplémentaires.
Exemple de demande : 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":{}}}}}}}'
Pour annuler le partage d'une connexion DCM 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.
Paramètres
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'
Pour annuler le partage d'une connexion DCM 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 .
Paramètres
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'
Pour supprimer un enregistrement de connexion DCM, 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.
Paramètres
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'
To retrieve all DCM Connection handling rules, use the GET {baseURL}/v3/dcm/admin/connectionhandlingrules endpoint.
Go to DCM Connection Handling for more information.
Parameters
No parameters.
Request Example: cURL
curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules \ --header 'Authorization: Bearer BearerTokenGoesHere'
To retrieve a single specific DCM Connection handling rule, use the GET {baseURL}/v3/dcm/admin/connectionhandlingrules/{id} endpoint.
Parameters
id (string): Required. Specify the ID of the DCM connection handling rule to return.
Request Example: cURL
curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules/{id} \ --header 'Authorization: Bearer BearerTokenGoesHere'
To add a new DCM Connection handling rule or update an existing one, use the POST {baseURL}/v3/dcm/admin/connectionhandlingrules endpoint.
Paramaters
Enter the following parameters to create or update a DCM connection handling rule:
rule (body): Required. The DCM ConnectionHandlingRule to create or update.
id (string): Optional. The DCM connection handling rule ID. Enter a DCM connection handling rule ID if you wish to update an existing connection handling rule. Skip if you wish to create a new connection handling rule.
sourceConnectionId (string): Enter a sourceConnectionId, referencing a ConnectionId to be replaced at workflow execution. The Connection doesn’t have to exist on the Server (workflows referencing it can still be executed). It can’t be used in another existing rule, be it as a source connection or target connection.
sourceConnectionTitle (string): Enter a custom name or description of the source connection.
targetConnectionId (string): Enter a targetConnectionId. Must be referencing a DCM connection present on the Server.
targetConnectionTitle (string): Enter a custom name or description of the target connection.
Request Example: cURL
curl --location --request POST 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules/{id} \ --header 'Authorization: Bearer BearerTokenGoesHere'
To delete an existing DCM connection handling rule, use the DELETE {baseURL}/v3/dcm/admin/connectionhandlingrules/{id} endpoint.
Parameters
id (string): Required. Specify the DCM connection handling rule ID you want to delete.
Request Example: 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 DCM, 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 :
id si vous souhaitez récupérer un enregistrement de connexion DCM .
connectionId si vous souhaitez récupérer une connexion DCM comme référencée dans les workflows .
id si vous souhaitez partager une connexion DCM avec des utilisateurs et des groupes spécifiés .
id si vous souhaitez mettre à jour une connexion DCM .
id si vous souhaitez supprimer une connexion DCM .
id si vous souhaitez annuler le partage d'une connexion DCM .
Administrateur :
id si vous souhaitez récupérer un enregistrement de connexion DCM .
ownerId (userId) si vous souhaitez créer une connexion DCM au nom d'un utilisateur .
id si vous souhaitez mettre à jour une connexion DCM au nom d'un utilisateur .
id si vous souhaitez annuler le partage d'une connexion DCM partagée pour l'exécution .
id si vous souhaitez annuler le partage d'une connexion DCM partagée pour la collaboration .
id si vous souhaitez supprimer une connexion DCM .