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 Datenverbindungsdatensätze abrufen
Um alle zugänglichen Server-Datenverbindungsdatensätze abzurufen, verwenden Sie den Endpunkt
GET {baseURL}/v3/serverDataConnections
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Parameter
view (Zeichenfolge): optional. Kann ohne Wert belassen werden. Sie können aus den folgenden Werten wählen: „Default“ und „Full“. 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/serverDataConnections' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Bestimmten Datenverbindungsdatensatz abrufen
Um Informationen über eine vorhandene Server-Datenverbindung abzurufen, verwenden Sie den Endpunkt
GET {baseURL}/v3/serverDataConnections/{dataConnectionId}
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Parameter
dataConnectionId (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/serverDataConnections/61dec3bc536c221013530fa' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Vorhandene Datenverbindung aktualisieren
Um den
Namen
einer vorhandenen Server-Datenverbindung zu aktualisieren, verwenden Sie den Endpunkt
PUT {baseURL}/v3/serverDataConnections/{dataConnectionId}
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Parameter
dataConnectionId (Zeichenfolge): erforderlich. Geben Sie eine Server-Datenverbindungs-ID ein, um die Datenverbindung anzugeben, die aktualisiert werden soll.
updateServerConnectionContract (Text): erforderlich. Geben Sie den 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 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Oracle DB Connection'
Server-Datenverbindung für einen Benutzer freigeben
Um eine vorhandene Server-Datenverbindung für einen vorhandenen Benutzer freizugeben, verwenden Sie den Endpunkt
POST {baseURL}
/v3/credentials//users.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Parameter
dataConnectionId (Zeichenfolge): erforderlich. Geben Sie eine Server-Datenverbindungs-ID ein, um die Datenverbindung anzugeben, zu der ein Benutzer hinzugefügt werden soll.
contract (Text): erforderlich. Geben Sie Informationen über den Benutzer ein, den Sie einer Datenverbindung hinzufügen möchten:
userId (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 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'userId=61dec95f5436c22101353193'
Server-Datenverbindung für eine Benutzergruppe freigeben
Um eine vorhandene Server-Datenverbindung für eine vorhandene Benutzergruppe freizugeben, verwenden Sie den Endpunkt
POST {baseURL}
/v3/credentials//userGroups.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Parameter
dataConnectionId (Zeichenfolge): erforderlich. Geben Sie eine Server-Datenverbindungs-ID ein, um die Datenverbindung anzugeben, zu der eine Benutzergruppe hinzugefügt werden soll.
contract (Text): erforderlich. Geben Sie Informationen zu der Benutzergruppe ein, die Sie einer Datenverbindung hinzufügen möchten:
userGroupId (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 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'userGroupId=61decb225436c2210135336f'
Berechtigungen eines Benutzers zur Verwendung einer Server-Datenverbindung entfernen
Um die Berechtigung eines Benutzers zur Verwendung einer vorhandenen Server-Datenverbindung zu entfernen, verwenden Sie den Endpunkt
DELETE {baseURL}/v3/credentials/{dataConnectionId}/users/{userId}
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Parameter
dataConnectionId (Zeichenfolge): erforderlich. Geben Sie eine Server-Datenverbindungs-ID ein, um die Datenverbindung anzugeben, die aktualisiert werden soll.
userId (Zeichenfolge): erforderlich. Geben Sie eine Benutzer-ID ein, die Sie aus der Datenverbindung entfernen möchten.
Anforderungsbeispiel: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/users/61dec95f5436c22101353193' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Berechtigungen einer Benutzergruppe zur Verwendung einer Server-Datenverbindung entfernen
Um die Berechtigungen einer Benutzergruppe zur Verwendung einer vorhandenen Server-Datenverbindung zu entfernen, verwenden Sie den Endpunkt
DELETE {baseURL}/v3/credentials/{dataConnectionId}/userGroups/{userGroupId}
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Parameter
dataConnectionId (Zeichenfolge): erforderlich. Geben Sie eine Server-Datenverbindungs-ID ein, um die Datenverbindung anzugeben, die aktualisiert werden soll.
userGroupId (Zeichenfolge): erforderlich. Geben Sie eine Benutzergruppen-ID ein, die Sie aus der Datenverbindung entfernen möchten.
Anforderungsbeispiel: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/userGroups/61decb225436c2210135336f' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Eine Server-Datenverbindung löschen
Um eine vorhandene Server-Datenverbindung zu löschen, verwenden Sie den Endpunkt
DELETE {baseURL}/v3/serverDataConnections/{dataConnectionId}
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Parameter
dataConnectionId (Zeichenfolge): erforderlich. Geben Sie eine Server-Datenverbindungs-ID ein, um die Datenverbindung anzugeben, die Sie löschen möchten.
Anforderungsbeispiel: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Objektbeziehungen
Derzeit sind keine Referenzen für Server-Datenverbindungen vorhanden. Wenn Datenverbindungen geändert werden können, bietet das den Vorteil, dass Sie den Zugriff auf diese Verbindungen zuweisen oder entziehen können. Dies hilft beim Gewähren bestimmter Berechtigungen für Datenquellen.
Beispiele für eine Postman-Anforderung
GET /v3/serverDataConnections
PUT /v3/serverDataConnections/{dataConnectionId}
Weitere Informationen zu Postman-Anforderungen finden Sie auf der Hilfeseite So verwenden Sie Postman.