Skip to main content

サーバ接続エンドポイント

Server 接続のエンドポイントとパラメーター

オブジェクトの関係に関する詳細とAPIでの使用方法については、「 オブジェクトの関係 」セクションを参照してください。

データ接続の詳細については、 データ接続 のヘルプページを参照してください。

すべてのサーバーデータ接続レコードを取得

すべてのワークフローレコードに関する情報を取得するには、 GET {baseURL}/v3/workflows/ エンドポイントを使用します。

パラメーター

  • view  (文字列): オプションです。値を指定しないこともできます。値は「Default」(既定)と「Full」(完全)から選択できます。このパラメーターを「Default」(既定)に設定すると、縮小表示オブジェクトが返されます。指定しない場合は、「Default」(既定)の値が使用されます。

リクエストの例: cURL

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

サーバーデータ接続レコードを取得

特定のサーバーデータ接続に関する情報を取得するには、 get/v3/serverDataConnections/endpointを使用し {baseURL}{dataConnectionId} ます。

パラメーター

  • workflowCredentialType (文字列): 必須です。特定のデータ接続に関する情報を取得するには、サーバーデータ接続IDを入力します。

リクエストの例: cURL

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

既存のデータ接続の更新

データ接続の名前を変更するには、 put/v3/serverDataConnections/endpointを使用し {baseURL}{dataConnectionId} ます。

パラメーター

  • workflowCredentialType (文字列): 必須です。サーバーデータ接続IDを入力して、更新するデータ接続を指定します。

  • updateServerConnectionContract(body): 必須。データ接続の新しい名前を入力してください:

    • name  (文字列): 必須です。データ接続の新しい名前を入力します。

リクエストの例: cURL

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

接続を共有するユーザーを追加する

サーバーデータ接続にユーザーを追加するには、 POST {baseURL}/v3/serverDataConnections//Users{dataConnectionId} エンドポイントを使用します。

パラメーター

  • workflowCredentialType (文字列): 必須です。サーバーデータ接続IDを入力して、ユーザーを追加するデータ接続を指定します。

  • 契約 (本文):必須。データ接続に追加するユーザーに関する情報を入力します。

    • workflowCredentialType (文字列): 必須です。データ接続に追加するユーザーのIDを指定します。

リクエストの例: cURL

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

データ接続へのユーザーグループの追加

サーバーデータ接続にユーザーグループを追加するには、 POST {baseURL}/v3/serverDataConnections//usergroups{dataConnectionId} エンドポイントを使用します。

パラメーター

  • workflowCredentialType (文字列): 必須です。サーバデータ接続IDを入力して、ユーザグループを追加するデータ接続を指定します。

  • 契約 (本文):必須。データ接続に追加するユーザグループに関する情報を入力します。

    • workflowCredentialType (文字列): 必須です。データ接続に追加するユーザグループのIDを指定します。

リクエストの例: cURL

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

ユーザーをユーザーグループから削除

サーバーデータ接続からユーザーを削除するには、 delete {baseURL}/v3/serverDataConnections//users/{dataConnectionId}{userId} エンドポイントを使用します。

パラメーター

  • workflowCredentialType (文字列): 必須です。サーバーデータ接続IDを入力して、更新するデータ接続を指定します。

  • workflowCredentialType (文字列): 必須です。データ接続から削除するユーザIDを入力します。

リクエストの例: cURL

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

データ接続からのユーザーグループの削除

サーバーデータ接続からユーザーグループを削除するには、 delete {baseURL}/v3/serverDataConnections//usergroups/endpointを使用し{dataConnectionId}{userGroupId} ます。

パラメーター

  • workflowCredentialType (文字列): 必須です。サーバーデータ接続IDを入力して、更新するデータ接続を指定します。

  • workflowCredentialType (文字列): 必須です。データ接続から削除するユーザグループIDを入力します。

リクエストの例: cURL

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

データ接続の削除

特定のサーバーデータ接続を削除するには、 delete {baseURL}/v3/serverDataConnections/endpointを使用し{dataConnectionId} ます。

パラメーター

  • workflowCredentialType (文字列): 必須です。サーバデータ接続IDを入力して、削除するデータ接続を指定します。

リクエストの例: cURL

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

オブジェクト関係

現時点では、サーバーデータ接続の参照はありません。データ接続を変更可能にする利点は、アクセス権を割り当てたり割り当て解除したりできることです。これは、データソースに対する特定の権限へのオンボーディングに役立ちます。

Postmanリクエストの例

/v3/serverDataConnectionsの取得

Use the GET /v3/serverDataConnections endpoint.

/v3/serverDataConnections/{dataConnectionId}

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

Postmanリクエストの詳細については、「 Postmanの使用方法 」ヘルプページを参照してください。