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 Server

Pour obtenir des informations sur tous les enregistrements de workflow, utilisez le point de terminaison  GET {baseURL}/v3/workflows/ .

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/workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Récupérer un enregistrement de connexion aux données du Server

Pour récupérer des informations sur une connexion de données de serveur spécifique, utilisez GET {baseURL}/v3/serverDataConnections /{dataConnectionId} Endpoint.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Entrez un ID de connexion de données serveur pour obtenir des informations sur une connexion de données spécifique.

Exemple de demande : cURL

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

Mettre à jour une connexion de données existante

Pour modifier le nom d' une connexion de données, utilisez le {baseURL}{dataConnectionId} noeud final PUT /v3/serverDataConnections/.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Entrez un ID de connexion de données serveur pour spécifier la connexion de données à mettre à jour.

  • updateWorkflowContract  (corps) : obligatoire. Saisir un nouveau nom pour une connexion de données :

    • name  (chaîne) : obligatoire. Entrez le nouveau nom de la connexion de 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 : BearerTokenGoesHere' \ --data-urlencode 'name=Oracle DB Connection'

Ajouter un utilisateur à une collection

Pour ajouter un utilisateur à une connexion de données serveur, utilisez le {baseURL}{dataConnectionId} noeud final POST /v3/serverDataConnections/ /users.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Entrez un ID de connexion de données serveur pour spécifier la connexion de données à laquelle ajouter un utilisateur.

  • Contrat (corps) : obligatoire. Entrez des informations sur l'utilisateur que vous souhaitez ajouter à une connexion de données :

    • workflowCredentialType (chaîne) : obligatoire. Spécifiez l'ID d'un utilisateur que vous souhaitez ajouter à une connexion de 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 : BearerTokenGoesHere' \ --data-urlencode 'userid=61dec95f5436c22101353193'

Ajouter un groupe d'utilisateurs à une connexion de données

Pour ajouter un groupe d'utilisateurs à une connexion de données de serveur, utilisez le {baseURL}{dataConnectionId} noeud final POST /v3/serverDataConnections/ /usergroups.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Entrez un ID de connexion de données serveur pour spécifier la connexion de données à laquelle ajouter un groupe d'utilisateurs.

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

    • workflowCredentialType (chaîne) : obligatoire. Spécifiez l'ID d'un groupe d'utilisateurs à ajouter à une connexion de 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 : BearerTokenGoesHere' \ --data-urlencode 'userGroupId=61decb225436c2210135336f'

Retirer un utilisateur d'un groupe d'utilisateurs

Pour supprimer un utilisateur d'une connexion de données serveur, utilisez le {baseURL}{dataConnectionId}{userId} noeud final DELETE /v3/serverDataConnections/ /users/.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Entrez un ID de connexion de données serveur pour spécifier la connexion de données à mettre à jour.

  • workflowCredentialType (chaîne) : obligatoire. Saisissez un ID utilisateur que vous souhaitez supprimer de la connexion de données.

Exemple de demande : cURL

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

Supprimer un groupe d'utilisateurs d'une connexion de données

Pour supprimer un groupe d'utilisateurs d'une connexion de données serveur, utilisez le {baseURL}{dataConnectionId}{userGroupId} noeud final DELETE /v3/serverDataConnections/ /usergroups/.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Entrez un ID de connexion de données serveur pour spécifier la connexion de données à mettre à jour.

  • workflowCredentialType (chaîne) : obligatoire. Entrez un ID de groupe d'utilisateurs que vous souhaitez supprimer de la connexion de données.

Exemple de demande : cURL

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

Supprimer une connexion aux données

Pour supprimer un workflow spécifique, utilisez le point de terminaison  DELETE {baseURL}/v3/workflows/{dataConnectionId} .

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Entrez un ID de connexion de données serveur pour spécifier la connexion de données à supprimer.

Exemple de demande : cURL

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

Relations d'objets

Il n'y a aucune référence pour les connexions de données serveur pour le moment. L'avantage d'avoir les connexions de données modifiables est que vous pouvez leur attribuer ou annuler l'attribution d'accès. Cela facilite l'intégration de certaines autorisations aux sources de données.

Exemples de demandes Postman

OBTENEZ /v3/serverDataConnections

Use the GET /v3/serverDataConnections endpoint.

METTEZ /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​: