Skip to main content

Points de terminaison de la connexion à Server

Points de terminaison et paramètres de connexions à 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 la page d'aide Connexion aux données .

Récupérer tous les enregistrements de connexion aux données

Pour récupérer tous les enregistrements accessibles d'une connexion aux données Server, utilisez le point de terminaison GET {baseURL}/v3/serverDataConnections .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • view (chaîne) : facultatif. Peut être laissé sans valeur. Vous pouvez choisir parmi les valeurs suivantes : « Default » et « Full ». Si ce paramètre est défini sur « Default », un objet de vue réduite est renvoyé. Lorsqu'elle n'est pas spécifiée, la valeur « Default » est utilisée.

Exemple de demande : cURL

curl --location --request GET 'http://localhost/webapi/v3/serverDataConnections' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Récupérer un enregistrement de connexion aux données spécifique

Pour récupérer des informations sur une connexion aux données Server existante, utilisez le point de terminaison GET {baseURL}/v3/serverDataConnections /{dataConnectionId} .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • dataConnectionId (chaîne) : obligatoire. Saisissez un ID de connexion aux données Server pour obtenir des informations sur une connexion aux données spécifique.

Exemple de demande : cURL

curl --location --request GET 'http://localhost/webapi/v3/serverDataConnections/61dec3bc536c221013530fa' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Mettre à jour une connexion aux données existante

Pour modifier le nom d'une connexion aux données Server existante, utilisez le point de terminaison PUT {baseURL}/v3/serverDataConnections/{dataConnectionId} .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • dataConnectionId (chaîne) : obligatoire. Saisissez un ID de connexion aux données Server pour indiquer la connexion aux données à mettre à jour.

  • updateServerConnectionContract (corps) : obligatoire. Saisissez un nouveau nom pour une connexion aux données :

    • name (chaîne) : obligatoire. Saisissez le nouveau nom de la connexion aux données.

Exemple de demande : cURL

curl --location --request PUT 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c21013530fa' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Oracle DB Connection'

Partager une connexion aux données Server avec un utilisateur

Pour partager une connexion aux données Server existante avec un utilisateur existant, utilisez le point de terminaison POST {baseURL}/v3/serverDataConnections/{dataConnectionId}/users .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • dataConnectionId (chaîne) : obligatoire. Saisissez un ID de connexion aux données Server pour indiquer la connexion aux données à laquelle ajouter un utilisateur.

  • contract (corps) : obligatoire. Saisissez des informations sur l'utilisateur que vous souhaitez ajouter à une connexion aux données :

    • userId (chaîne) : obligatoire. Indiquez un ID d'utilisateur que vous souhaitez ajouter à une connexion aux données.

Exemple de demande : cURL

curl --location --request POST 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/users' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'userId=61dec95f5436c22101353193'

Partager une connexion aux données Server avec un groupe d'utilisateurs

Pour partager une connexion aux données Server existante avec un groupe d'utilisateurs existant, utilisez le point de terminaison POST {baseURL}/v3/serverDataConnections/{dataConnectionId}/userGroups .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • dataConnectionId (chaîne) : obligatoire. Saisissez un ID de connexion aux données Server pour indiquer la connexion aux données à laquelle ajouter un groupe d'utilisateurs.

  • contract (corps) : obligatoire. Saisissez des informations sur le groupe d'utilisateurs que vous souhaitez ajouter à une connexion aux données :

    • userGroupId (chaîne) : obligatoire. Indiquez un ID de groupe d'utilisateurs que vous souhaitez ajouter à une connexion aux données.

Exemple de demande : cURL

curl --location --request POST 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/userGroups' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'userGroupId=61decb225436c2210135336f'

Retirer les autorisations d'un utilisateur d'exploiter une connexion aux données Server

Pour retirer les autorisations d'un utilisateur d'exploiter une connexion aux données Server existante, utilisez le point de terminaison DELETE {baseURL}/v3/serverDataConnections/{dataConnectionId}/users/{userId} .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • dataConnectionId (chaîne) : obligatoire. Saisissez un ID de connexion aux données Server pour indiquer la connexion aux données à mettre à jour.

  • userId (chaîne) : obligatoire. Saisissez un ID d'utilisateur que vous souhaitez retirer de la connexion aux données.

Exemple de demande : cURL

curl --location --request DELETE 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/users/61dec95f5436c22101353193' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Retirer les autorisations d'un groupe d'utilisateurs d'exploiter une connexion aux données Server

Pour retirer les autorisations d'un groupe d'utilisateurs d'exploiter une connexion aux données Server existante, utilisez le point de terminaison DELETE {baseURL}/v3/serverDataConnections/{dataConnectionId}/userGroups/{userGroupId} .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • dataConnectionId (chaîne) : obligatoire. Saisissez un ID de connexion aux données Server pour indiquer la connexion aux données à mettre à jour.

  • userGroupId (chaîne) : obligatoire. Saisissez un ID de groupe d'utilisateurs que vous souhaitez retirer de la connexion aux données.

Exemple de demande : cURL

curl --location --request DELETE 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/userGroups/61decb225436c2210135336f' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Supprimer une connexion aux données Server

Pour supprimer une connexion aux données Server existante, utilisez le point de terminaison DELETE {baseURL}/v3/serverDataConnections/{dataConnectionId} .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • dataConnectionId (chaîne) : obligatoire. Saisissez un ID de connexion aux données Server pour indiquer la connexion aux données à supprimer.

Exemple de demande : cURL

curl --location --request DELETE 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Relations d'objets

Il n'y a aucune référence pour les connexions aux données Server pour le moment. L'avantage de pouvoir modifier les connexions aux données est que vous pouvez leur donner ou leur retirer l'accès. Cela facilite l'intégration de certaines autorisations aux sources de données.

Exemples de demandes Postman

GET /v3/serverDataConnections

Use the GET /v3/serverDataConnections endpoint.

PUT /v3/serverDataConnections/{dataConnectionId}

Use the PUT /v3/serverDataConnections/{dataConnectionId} endpoint.

Pour en savoir plus sur les demandes Postman, consultez la page d'aide Comment utiliser Postman.

Dans cette section​: