Server接続のエンドポイント
Server接続のエンドポイントとパラメーター
オブジェクト関係に関する詳細とAPIでの使用方法については、 オブジェクト関係 のセクションを参照してください。
データ接続の詳細については、 データ接続 のヘルプページを参照してください。
すべてのデータ接続レコードを取得する
アクセス可能なすべてのServerデータ接続レコードを取得するには、
GET {baseURL}/v3/serverDataConnections
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
view (文字列): オプションです。値を指定しないこともできます。値は「Default」(既定)と「Full」(完全)から選択できます。このパラメーターを「Default」(既定)に設定すると、縮小表示オブジェクトが返されます。指定しない場合は、「Default」(既定)の値が使用されます。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/serverDataConnections' \ --header 'Authorization: Bearer BearerTokenGoesHere'
特定のデータ接続レコードを取得する
既存のServerデータ接続についての詳細を取得するには、
GET {baseURL}/v3/serverDataConnections /{dataConnectionId}
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
dataConnectionId (文字列): 必須です。Serverデータ接続のIDを入力して、特定のデータ接続に関する情報を取得します。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/serverDataConnections/61dec3bc536c221013530fa' \ --header 'Authorization: Bearer BearerTokenGoesHere'
既存のデータ接続を更新する
既存のServerデータ接続の接続
名
を更新するには、
PUT {baseURL}/v3/serverDataConnections/{dataConnectionId}
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
dataConnectionId (文字列): 必須です。Serverデータ接続のIDを入力して、更新するデータ接続を指定します。
updateServerConnectionContract (本文): 必須です。データ接続の新しい名前を入力します。
name (文字列): 必須です。データ接続の新しい名前を入力します。
リクエストの例: 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データ接続をユーザーと共有する
既存のServerデータ接続を既存のユーザーと共有するには、
POST {baseURL}/v3/serverDataConnections/{dataConnectionId}/users
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
dataConnectionId (文字列): 必須です。Serverデータ接続のIDを入力して、ユーザーを追加するデータ接続を指定します。
contract (本文): 必須です。データ接続に追加するユーザーに関する情報を入力します。
userId (文字列): 必須です。データ接続に追加するユーザーのIDを指定します。
リクエストの例: 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データ接続をユーザーグループと共有する
既存のServerデータ接続を既存のユーザーグループと共有するには、
POST {baseURL}/v3/serverDataConnections/{dataConnectionId}/userGroups
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
dataConnectionId (文字列): 必須です。Serverデータ接続のIDを入力して、ユーザーグループを追加するデータ接続を指定します。
contract (本文): 必須です。データ接続に追加するユーザーグループに関する情報を入力します。
userGroupId (文字列): 必須です。データ接続に追加するユーザーグループのIDを指定します。
リクエストの例: 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'
ユーザーが持っているServerデータ接続の使用権限を削除する
ユーザーが持っている既存のServerデータ接続の使用権限を削除するには、
DELETE {baseURL}/v3/serverDataConnections/{dataConnectionId}/users/{userId}
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
dataConnectionId (文字列): 必須です。Serverデータ接続のIDを入力して、更新するデータ接続を指定します。
userId (文字列): 必須です。データ接続から削除するユーザーIDを入力します。
リクエストの例: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/users/61dec95f5436c22101353193' \ --header 'Authorization: Bearer BearerTokenGoesHere'
ユーザーグループが持っているServerデータ接続の使用権限を削除する
ユーザーグループが持っている既存のServerデータ接続の使用権限を削除するには、
DELETE {baseURL}/v3/serverDataConnections/{dataConnectionId}/userGroups/{userGroupId}
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
dataConnectionId (文字列): 必須です。Serverデータ接続のIDを入力して、更新するデータ接続を指定します。
userGroupId (文字列): 必須です。データ接続から削除するユーザーグループIDを入力します。
リクエストの例: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/userGroups/61decb225436c2210135336f' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Serverデータ接続を削除する
既存のServerデータ接続を削除するには、
DELETE {baseURL}/v3/serverDataConnections/{dataConnectionId}
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
dataConnectionId (文字列): 必須です。Serverデータ接続のIDを入力して、削除するデータ接続を指定します。
リクエストの例: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa' \ --header 'Authorization: Bearer BearerTokenGoesHere'
オブジェクト関係
現時点では、Serverデータ接続の参照はありません。データ接続が変更可能であることの利点は、データ接続へのアクセス権を割り当てたり割り当てを解除したりできることです。これは、データソースに対する特定の権限へのオンボーディングに役立ちます。
Postmanリクエストの例
GET /v3/serverDataConnections
PUT /v3/serverDataConnections/{dataConnectionId}
Postmanリクエストの詳細については、 Postman の使用方法 のヘルプページを参照してください。