Server-Verbindungsendpunkte
Server-Verbindung-Endpunkte und Parameter
Weitere Informationen zu Objektbeziehungen und deren Verwendung in der API finden Sie im Abschnitt Objektbeziehungen .
Weitere Informationen zu Datenverbindungen finden Sie auf der Hilfeseite Datenverbindungen .
Alle Serverdatenverbindungsdatensätze abrufen
Um Informationen zu allen Workflow-Datensätzen abzurufen, verwenden Sie den Endpunkt
GET {baseURL}/v3/workflows/
.
Parameter
view (Zeichenfolge): Optional. Kann ohne Wert belassen werden. Sie können aus den folgenden Werten wählen: „Standard“ und „Vollständig“. Wenn dieser Parameter auf „Standard“ gesetzt ist, wird ein reduziertes Ansichtsobjekt zurückgegeben. Wenn keine Angaben gemacht werden, wird der Standardwert verwendet.
Anforderungsbeispiel: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Einen Server-Datenverbindungsdatensatz abrufen
Um Informationen über eine bestimmte Serverdatenverbindung abzurufen, verwenden Sie
GET {baseURL}/v3/serverDataConnections /{dataConnectionId}
Endpoint.
Parameter
workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Server-Datenverbindungs-ID ein, um Informationen über eine bestimmte Datenverbindung abzurufen.
Anforderungsbeispiel: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Aktualisieren Sie eine vorhandene Datenverbindung
Um den
Namen
einer Datenverbindung zu ändern, verwenden Sie
PUT {baseURL}/v3/serverDataConnections/{dataConnectionId}
Endpoint.
Parameter
workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Server-Datenverbindungs-ID ein, um die Datenverbindung anzugeben, die aktualisiert werden soll.
updateWorkflowContract (Haupttext): Erforderlich. Geben Sie einen neuen Namen für eine Datenverbindung ein:
name (Zeichenfolge): Erforderlich. Geben Sie den neuen Namen der Datenverbindung ein.
Anforderungsbeispiel: cURL
Curl --location --Request PUT 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c21013530fa' \ --Header 'Content-Type: Application/x-www-Form-urlencoded' \ --Header 'Autorisierung: Bearer BearerTokenGoesHere' \ --Data-urlencode 'Name=Oracle DB-Verbindung'
Einen Benutzer einer Sammlung hinzufügen
Um einen Benutzer zu einer Serverdatenverbindung hinzuzufügen, verwenden Sie den
{baseURL}{dataConnectionId}
Endpunkt POST /v3/serverDataConnections/ /users.
Parameter
workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Server-Datenverbindungs-ID ein, um die Datenverbindung anzugeben, zu der ein Benutzer hinzugefügt werden soll.
Vertrag (Körper): Erforderlich. Geben Sie Informationen über den Benutzer ein, den Sie einer Datenverbindung hinzufügen möchten:
workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die ID eines Benutzers an, den Sie einer Datenverbindung hinzufügen möchten.
Anforderungsbeispiel: cURL
Curl --location --Request POST 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/users' \ --Header 'Content-Type: Application/x-www-Form-urlencoded' \ --Header 'Autorisierung: Bearer BearerTokenGoesHere' \ --Data-urlencode 'userid=61dec95f5436c22101353193'
Fügen Sie einer Datenverbindung eine Benutzergruppe hinzu
Um eine Benutzergruppe zu einer Serverdatenverbindung hinzuzufügen, verwenden Sie den
{baseURL}{dataConnectionId}
Endpunkt POST /v3/serverDataConnections/ /usergroups.
Parameter
workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Server-Datenverbindungs-ID ein, um die Datenverbindung anzugeben, zu der eine Benutzergruppe hinzugefügt werden soll.
Vertrag (Körper): Erforderlich. Geben Sie Informationen zu der Benutzergruppe ein, die Sie einer Datenverbindung hinzufügen möchten:
workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die ID einer Benutzergruppe an, die Sie einer Datenverbindung hinzufügen möchten.
Anforderungsbeispiel: cURL
Curl --location --Request POST 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/userGroups' \ --Header 'Content-Type: Application/x-www-Form-urlencoded' \ --Header 'Autorisierung: Bearer BearerTokenGoesHere' \ --Data-urlencode 'userGroupId=61decb225436c2210135336f'
Einen Benutzer aus einer Benutzergruppe entfernen
Um einen Benutzer aus einer Server-Datenverbindung zu entfernen, verwenden Sie den Befehl
DELETE {baseURL}/v3/serverDataConnections/{dataConnectionId}/users/{userId}
Endpunkt.
Parameter
workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Server-Datenverbindungs-ID ein, um die Datenverbindung anzugeben, die aktualisiert werden soll.
workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Benutzer-ID ein, die Sie aus der Datenverbindung entfernen möchten.
Anforderungsbeispiel: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Entfernen Sie eine Benutzergruppe aus einer Datenverbindung
Um eine Benutzergruppe aus einer Serverdatenverbindung zu entfernen, verwenden Sie den Befehl
DELETE {baseURL}/v3/serverDataConnections/{dataConnectionId}/usergroups/{userGroupId}
Endpoint.
Parameter
workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Server-Datenverbindungs-ID ein, um die Datenverbindung anzugeben, die aktualisiert werden soll.
workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Benutzergruppen-ID ein, die Sie aus der Datenverbindung entfernen möchten.
Anforderungsbeispiel: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Eine Datenverbindung löschen
Um einen spezifischen Workflow zu löschen, verwenden Sie den Endpunkt
DELETE {baseURL}/v3/workflows/{dataConnectionId}
.
Parameter
workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Server-Datenverbindungs-ID ein, um die Datenverbindung anzugeben, die Sie löschen möchten.
Anforderungsbeispiel: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Objektbeziehungen
Derzeit sind keine Referenzen für Serverdatenverbindungen vorhanden. Der Vorteil, dass die Datenverbindungen geändert werden können, besteht darin, dass Sie Zugriff auf diese Verbindungen zuweisen oder deren Zuweisung aufheben können. Dies hilft beim Onboarding bestimmter Berechtigungen für Datenquellen.
Beispiele für eine Postman-Anforderung
RUFEN SIE /v3/serverDataConnections AB
PUT /v3/serverDataConnections/{dataConnectionId}
Weitere Informationen zu Postman-Anforderungen finden Sie auf der Hilfeseite Postman verwenden .