DCMエンドポイント

DCMエンドポイントとプロパティ

DCMエンドポイントは、ユーザー向けDCMエンドポイントと管理者向けDCMエンドポイントの2つのグループに分けられます。すべてのDCMエンドポイントについて、TLSをServer上で設定する必要があります。

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

データ接続の詳細については、DCM - Server およびデータ接続マネージャー: Server UI のヘルプページを参照してください。DCM - Server

DCM接続とは

DCM接続は、独自のparametersと、2種類のサブオブジェクト、すなわちDataSource (常に1つだけ)と、Credential(資格情報が0、1つまたは2つある状況が一般的です。まれにそれ以上の数がある場合があり、この数はコネクタ固有)から構成されます。各Credentialは、接続内に異なるcredRoleを有します。DCM APIは、DataSourceとCredentialsを含むオブジェクト全体として接続で動作します。

コネクタとDCM接続の関連とは

コネクタは、Alteryxが外部データソースと通信できるようにするコードです。各コネクタには、この通信を確立するための特定のパラメーターセットが必要です。これらのパラメーターをまとめてDCM接続と呼んでいます。コネクタでサポートされている正確なパラメーターは、SchemaNameによって一意に識別されるDCMスキーマを介して定義され、DCMに伝達されます。

1つのコネクタで複数の認証方法や通信プロトコルをサポートすることができ、それぞれに独自のパラメーターセットがあります。その結果、1つのコネクタが異なるSchemaName値を持つ複数のDCMスキーマを登録する場合があります。

接続スキーマは、他のDCMオブジェクトと同じように構造化され、DataSourceスキーマとCredentialスキーマの両方で構成されます。つまり、Connection.SchemaNameは、接続オブジェクト内でその特定の接続スキーマ用に作成された、どのDataSource.SchemaNameとCredential.schemaNamesを使用する必要があるかも決定します。

SQL ServerへのODBCコネクタのschemaNames

Microsoft SQL Server ODBC DSNレス(Azure Active Directory統合)
schemaName: "database-odbc-mssql-adintegrated"
- dataSource.schemaName: "database-odbc-mssql"
- credentials: なし
Microsoft SQL Server ODBC DSNレス(AzureマネージドサービスID)
schemaName: "database-odbc-mssql-admsi"
- dataSource.schemaName: "database-odbc-mssql"
- credentials:
  credRole: "main"、schemaName: "azure_managed_identity"
Microsoft SQL Server ODBC DSNレス(Azure Active Directoryパスワード)
schemaName: "database-odbc-mssql-adpwd"
- dataSource.schemaName: "database-odbc-mssql"
- credentials:
  credRole: "main"、schemaName: "username_password"
Microsoft SQL Server ODBC DSNレス(Azure Active Directoryサービスプリンシパル)
schemaName: "database-odbc-mssql-adsp"
- dataSource.schemaName: "database-odbc-mssql"
- credentials:
  credRole: "oatuhApplication"、schemaName: "database-odbc-mssql-adsp"
Microsoft SQL Server ODBC DSNレス(ユーザー名のみ)
schemaName: "database-odbc-mssql-nopwd"
- dataSource.schemaName: "database-odbc-mssql"
- credentials:
  credRole: "main"、schemaName: "username"
Microsoft SQL Server ODBC DSNレス(Azure AD)
schemaName: "database-odbc-mssql-oauth-azure-ayxapp"
- dataSource.schemaName: "database-odbc-mssql"
- credentials:
  credRole: "oauthTokens"、schemaName: "database-ms-oauth-azure-ayxapp-tokens"
Microsoft SQL Server ODBC DSNレス(Azure AD—プライベート)
schemaName: "database-odbc-mssql-oauth-azure"
- dataSource.schemaName: "database-odbc-mssql"
- credentials:
  - credRole: "oauthApplication"、schemaName: "database-ms-oauth-azure-application"
  - credRole: "oauthTokens"、schemaName: "database-ms-oauth-azure-tokens"
Microsoft SQL Server ODBC DSNレス(汎用OAuth2)
schemaName: "database-odbc-mssql-oauth-generic-configurable"
- dataSource.schemaName: "database-odbc-mssql"
- credentials:
  - credRole: "oauthApplication"、schemaName: "generic-configurable-oauth-application"
  - credRole: "oauthTokens"、schemaName: "generic-configurable-oauth-tokens"
Microsoft SQL Server ODBC DSNレス(Windows認証)
schemaName: "database-odbc-mssql-winauth"
- dataSource.schemaName: "database-odbc-mssql"
- credentials: なし
Microsoft SQL Server ODBC DSNレス(ユーザー名-パスワード)
schemaName: "database-odbc-mssql"
- dataSource.schemaName: "database-odbc-mssql"
- credentials:
  credRole: "main"、schemaName: "username_password"
Microsoft SQL Server ODBC (資格情報なし)
schemaName: "database-odbc-dsn-mssql-nocreds"
- dataSource.schemaName: "database-odbc-dsn-mssql"
- credentials: なし
Microsoft SQL Server ODBC (ユーザー名のみ)
schemaName: "database-odbc-dsn-mssql-nopwd"
- dataSource.schemaName: "database-odbc-dsn-mssql"
- credentials:
  credRole: "main"、schemaName: "username"
Microsoft SQL Server ODBC (Azure AD)
schemaName: "database-odbc-dsn-mssql-oauth-azure-ayxapp"
- dataSource.schemaName: "database-odbc-dsn-mssql"
- credentials:
  credRole: "oauthTokens"、schemaName: "database-ms-oauth-azure-ayxapp-tokens"
Microsoft SQL Server ODBC (Azure AD—プライベート)
schemaName: "database-odbc-dsn-mssql-oauth-azure"
- dataSource.schemaName: "database-odbc-dsn-mssql"
- credentials:
  - credRole: "oauthApplication"、schemaName: "database-hana-oauth-azure-application"
  - credRole: "oauthTokens"、schemaName: "database-hana-oauth-azure-tokens"
Microsoft SQL Server ODBC (汎用OAuth2)
schemaName: "database-odbc-dsn-mssql-oauth-generic-configurable"
- dataSource.schemaName: "database-odbc-dsn-mssql"
- credentials:
  - credRole: "oauthApplication"、schemaName: "generic-configurable-oauth-application"
  - credRole: "oauthTokens"、schemaName: "generic-configurable-oauth-tokens"
Microsoft SQL Server ODBC (ユーザー名-パスワード)
schemaName: "database-odbc-dsn-mssql"
- dataSource.schemaName: "database-odbc-dsn-mssql"
- credentials:
  credRole: "main"、schemaName: "username_password"

ユーザー向けDCMエンドポイント

これらのエンドポイントは、APIアクセスを持つユーザーが使用できます。

注記

すべてのAPIエンドポイントは、個々のユーザーデータを返します(各ユーザーは自分の接続のみを表示および管理できます)。
すべての例はPowerShellにあります。

接続の取得

接続レコードを取得するには、GET {baseURL}/v3/dcm/connections/{id}エンドポイントを使用します。このエンドポイントは、関連するデータソースや資格情報、共有情報など、接続に関するすべての情報を返します。

プロパティ

id (文字列): 必須です。情報を取得するDCM接続のIDを入力します。

リクエストの例: cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

ワークフローで参照されている接続の取得

ワークフローで参照されている接続レコードを取得するには、GET {baseURL}/v3/dcm/connections/lookupエンドポイントを使用しますこのエンドポイントは、関連するデータソースや資格情報、共有情報など、接続に関するすべての情報を返します。

注記

このエンドポイントで使用される接続IDは、他のDCMエンドポイントで使用されるIDとは異なります。IDはさまざまなDCMオブジェクトを参照するために使用されますが、接続IDは特定のユーザーのDCM接続を参照するためにのみ、ワークフローで使用されます。

プロパティ

connectionId (文字列): 必須です。情報を取得するDCM接続IDを入力します。

リクエストの例: cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/connections/lookup?connectionId=d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

接続の共有

指定したユーザーまたはグループとServer実行のための接続を共有するには、PUT {baseURL}/v3/dcm/connections/{id}/sharing/executionエンドポイントを使用します。

注記

これはPUTエンドポイントであるため、既存のリストにユーザーやユーザーグループを追加するのではなく、既存の共有を上書きします。指定されたユーザーとグループのリストは空であってはいけません。既存の共有を削除するには、DELETEエンドポイントを使用します。

プロパティ

id (文字列): 必須です。他のユーザーまたはグループと共有するDCM接続IDを入力します。
sharingContract (本文): 必須です。実行の共有を更新するには、sharingContractパラメーターが必要になります。両方の配列が必要で、空のままにできる配列はどちらか1つだけです。
- userIds (文字列配列): 接続を共有するすべてのユーザーIDのリストを入力します。共有するユーザーがいない場合(ユーザーグループのみ)は、配列を空のままにします。
- userGroupIds (文字列配列): 接続を共有するすべてのユーザーグループIDのリストを入力します。共有するユーザーグループがない場合(ユーザーのみ)は、配列を空のままにします。

リクエストの例: cURL

curl --location --request PUT 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/execution' `
  --header 'Authorization: Bearer BearerTokenGoesHere' `
  --header 'Content-Type: application/json' `
  --data '{
    "userIds": [
      "61d57bea3c15317e1a48205b",
      "61d564361d6d5da7ad461a32"
    ],
    "userGroupIds": [
      "d5da7ad4"
    ]
  }'

接続の共有解除

接続の共有を解除するには、DELETE {baseURL}/v3/dcm/connections/{id}/sharing/executionエンドポイントを使用します。

プロパティ

id (文字列): 必須です。すべてのユーザーおよびグループから共有を解除するDCM接続IDを入力します。

リクエストの例: cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/execution' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

接続の作成または更新

接続を作成または更新するには、POST {baseURL}/v3/dcm/connectionsエンドポイントを使用します。

単一のエンドポイントが作成と更新の両方の機能を備えており、その区別はオブジェクトIDがリクエストに含まれているかどうかでされます。新しい接続を作成する際の、既存のデータソースまたは資格情報の再利用は、現在サポートされていません。

プロパティ

id (文字列): オプションです。既存の接続を更新する場合は、接続IDを入力します。新しい接続を作成する場合はスキップします。
name (文字列): 必須です。接続名を入力します。
注記
DCM接続内には複数の「name」があります。
- Connection.name: 接続自体の名前です。管理者はAPIを介してこの名前を操作します。
- Connection.dataSource.object.name: UIの[データソース]タブに表示されるデータソース名です。
- Connection.credentials.<credRole>.object.name: UIの[資格情報]タブに表示される資格情報名です。
詳細については、DCM接続とはのセクションを参照してください。
schemaName (文字列): 必須です。これはDCMスキーマの識別子であり、DCM UIで関連付けられたパラメーターのレンダリングと検証に使用されます。各コネクタは、サポートされているDCMスキーマの独自のセットを定義します。選択した接続スキーマによって、その接続のDataSourceセクションとCredentialセクションに使用する必要があるDataSourceスキーマとCredentialスキーマも決まります。詳細については、DCM接続とはおよびコネクタとDCM接続の関連とはを参照してください。
allowInSdks (ブール型): オプションです。接続がPython SDKツールにアクセスできるようにします。
parameters (オブジェクト): 必須です。このプロパティには、接続するスキーマとテクノロジーに固有の設定の詳細が保持されます。
注記
DCM接続構造にはいくつかの異なるparametersオブジェクトがあり、それぞれが異なるコンテキストで使用されます。
- Connection.parameters: 接続全体用(UIに未反映、近日提供予定)
- Connection.dataource.object.parameters: 接続のデータソース部分用。
- Connection.credentials.<credRole>.object.parameters: 各資格情報ロール用。
- Connection.credentials.<credRole>.object.secrets.<secretType>.parameters: 資格情報シークレット用、シークレットタイプごと。
各parametersオブジェクトには独自の構造と必須フィールドがあり、これらはその接続の該当部分で定義されているテクノロジーとschemaNameに依存します。これらは独立したもので、さまざまなフィールドを含むことがあります(多くの場合、含まれています)。
parametersプロパティは必須ですが、特定のスキーマにパラメーターが必要ない場合は、空のオブジェクト({})として指定できます。
ヒント：
parametersオブジェクトの正しいフィールドを判断するには、次の手順に従います。
1. ターゲットテクノロジーのAlteryx Server UIでDCM接続を作成します。
2. API経由でその接続のクエリを実行します: GET /v3/dcm/connections/{id}
3. 応答の各parametersオブジェクトに対して返された構造とフィールドを確認します。
これは、特定のデータソースまたは資格情報に必要なフィールドと使用可能なフィールドを見つけるための最も信頼性の高い方法です。
parametersフィールドはデータソースと資格情報に固有であるため、このドキュメンテーションですべてのテクノロジーに関する例を包括的に示すことは現実的ではありません。上記のワークフローを使用して、最新のソース固有の例を確認してください。
dataSource (オブジェクト): 必須です。接続に使用されるデータソースで、DCM UIに表示されるデータソースインスタンスホストと追加パラメーターを示します。
- object (オブジェクト): 必須です。
  - id (文字列): 既存の接続を更新する場合は、データソースIDを入力します。新しい接続を作成する場合はスキップします。新しい接続の作成時に既存のデータソースを使用することは現在できません。
  - name (文字列): 必須です。データソースの名前を入力します。
  - schemaName (文字列): 必須です。選択したデータソースのスキーマ名を入力します。詳細な説明は、Connection.SchemaNameのプロパティを参照してください。
  - parameters (オブジェクト): 必須です。接続のDataSource部分のパラメーターです。詳細については、Connection.parametersのプロパティを参照してください。パラメーターが不要な場合は、空のオブジェクト{}を指定します。
credentials (オブジェクト): 必須です。<credRole>: オブジェクトのキーと値のペアです。<credRole>は、選択したDCMスキーマによって定義されます。このobjectには、「object」という名前のプロパティが1つのみ含まれます。これにすべての資格情報プロパティが含まれています。接続によっては、資格情報を必要としないものもあれば、複数のネストされた資格情報オブジェクトを持つものもあります。
以下の例では、SQLServer (MSSQL)ユーザー名-パスワード認証でmain <credRole>が使用されていることがわかります。Identity Pool認証とSnowflake with OAuth認証を使用したRedshift接続では、それらの資格情報にoauthApplicationとoauthTokens <credRoles>を使用します。
詳細については、DCM接続とは、およびコネクタとDCM接続の関連とはの項目を参照してください。
- object (オブジェクト): 接続の資格情報部分のプロパティを定義します。
  - id (文字列): 既存の接続を更新する場合は、資格情報IDを入力します。新しい接続を作成する場合はスキップします。新しい接続の作成時に既存の資格情報を使用することは現在できません。
  - name (文字列): 必須です。資格情報名を入力します。
  - schemaName (文字列): 必須です。選択した資格情報のスキーマ名を入力します。
  - parameters (オブジェクト): 必須です。接続のCredential部分のパラメーターです。詳細については、Connection.parametersのプロパティを参照してください。パラメーターが不要な場合は、空のオブジェクト{}を指定します。

リクエストの例: cURL

ユーザー名とパスワードの資格情報を使用してSQL Server DCM接続を作成

curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' `
  --header 'Authorization: Bearer BearerTokenGoesHere' `
  --header 'Content-Type: application/json' `
  --data '{
    "name": "MSSQL DEV Admin",
    "schemaName": "database-odbc-dsn-mssql",
    "parameters": {},
    "dataSource": {
      "object": {
        "name": "SQL Server DEV",
        "schemaName": "database-odbc-dsn-mssql",
        "parameters": {
          "dsn": "sql server"
        }
      }
    },
    "credentials": {
      "main": {
        "object": {
          "name": "SQL Server Admin Credentials",
          "schemaName": "username_password",
          "parameters": {},
          "userName": "admin",
          "secrets": {
            "password": {
              "value": {
                "text": "password"
              },
              "parameters": {}
            }
          }
        }
      }
    }
  }'

AWS IAM / CognitoのOAuth認証を使用したRedshiftへのODBC DCM接続の作成

curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' `
  --header 'Authorization: Bearer BearerTokenGoesHere' `
  --header 'Content-Type: application/json' `
  --data '{
    "name": "Connection Name",
    "schemaName": "database-odbc-redshift-simba-oauth-iam-identitypool",
    "allowInSdks": false,
    "parameters": {},
    "dataSource": {
        "object": {
            "name": "DataSource Name",
            "schemaName": "database-odbc-redshift-simba",
            "drvName": "Simba Amazon Redshift ODBC Driver",
            "host": "##### (my-database-host.redshift.amazonaws.com)",
            "parameters": {
                "allowSelfSignedServerCert": false,
                "checkCertRevocation": false,
                "database": "#####",
                "minTLS": 2,
                "port": 5439,
                "sslMmode": "require",
                "useSystemTrustStore": false
            }
        }
    },
    "credentials": {
        "oauthApplication": {
            "object": {
                "name": "Application Credential Name",
                "schemaName": "database-redshift-aws-oauth-iam-identitypool-application",
                "userName": "##### (Client Secret)",
                "parameters": {
                    "accountId": "#####",
                    "authorityURL": "##### (https://my-authorization-host.amazoncognito.com)",
                    "awsRegion": "##### (us-west-2)",
                    "dbUser": "#####",
                    "identityPoolId": "#####",
                    "redirectURI": "##### (http://localhost:5634)",
                    "userPoolId": "#####"
                },
                "secrets": {
                }
            }
        },
        "oauthTokens": {
            "object": {
                "name": "Tokens Credential Name",
                "schemaName": "aws-oauth-iam-identitypool-tokens",
                "parameters": {},
                "secrets": {
                }
            }
        }
    }
}'

OAuth 2.0クライアント資格情報を使用したSnowflake DCM接続の作成

curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' `
  --header 'Authorization: Bearer BearerTokenGoesHere' `
  --header 'Content-Type: application/json' `
  --data '{
    "name": "Connection Name",
    "schemaName": "database-odbc-snowflake-simba-oauth-generic-configurable",
    "allowInSdks": false,
    "parameters": {},
    "dataSource": {
        "object": {
            "name": "DataSource Name",
            "schemaName": "database-odbc-snowflake-simba",
            "drvName": "Simba Snowflake ODBC Driver",
            "host": "##### (my-domain.snowflakecomputing.com)",
            "parameters": {
                "database": "#####",
                "schema": "#####",
                "warehouse": "#####"
            }
        }
    },
    "credentials": {
        "oauthApplication": {
            "object": {
                "name": "Application Credential Name",
                "schemaName": "generic-configurable-oauth-application",
                "userName": "##### (Client Id)",
                "parameters": {
                    "clientAuthentication": "body",
                    "grantType": "clientCredentials",
                    "tokenURL": "#####"
                },
                "secrets": {
                    "clientSecret": {
                        "expiresOn": null,
                        "parameters": {},
                        "value": {
                            "text": "##### (Client Secret)"
                        }
                    }
                }
            }
        },
        "oauthTokens": {
            "object": {
                "name": "Tokens Credential Name",
                "schemaName": "generic-configurable-oauth-tokens",
                "userName": null,
                "parameters": {
                    "scope": "#####"
                },
                "secrets": {}
            }
        }
    }
}'

接続の削除

接続を削除するには、 DELETE {baseURL}/v3/dcm/connections/{id}エンドポイントを使用します。他の接続で使用されていない限り、データソースと資格情報も削除されます。

プロパティ

id (文字列): 必須です。削除するDCM接続IDを入力します。

リクエストの例: cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

管理者向けDCMエンドポイント

APIアクセスを持つ管理者が使用できるエンドポイントです。

注記

すべての管理者APIエンドポイントは、所有権に関係なく、Server上ですべてのユーザーが利用可能なすべてのデータを返します。
すべての例はPowerShellにあります。

接続の取得

接続レコードを取得するには、GET {baseURL}/v3/dcm/admin/connections/{objectId}エンドポイントを使用します。

プロパティ

objectId (文字列): 必須です。情報を取得するDCM接続IDを入力します。

リクエストの例: cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

接続の一覧表示

Serverに存在するすべての接続レコードのリストを取得するには、GET {baseURL}/v3/dcm/admin/connectionsエンドポイントを使用します。

プロパティ

両方のパラメーターは、組み合わせ可能なフィルターです。connectionId と visibleBy を一緒に使用すると、指定された接続IDを持つ接続が返され、指定されたユーザーが見ることができます。

connectionId (文字列): オプションです。ワークフローから参照される接続IDで接続をフィルタリングします。接続がコラボレーションのために共有されている場合は、1つの接続IDに対して複数の接続を返すことができます。
visibleBy (文字列): オプションです。ユーザーIDを入力します。存在する場合、結果は、指定したユーザーが使用できるすべての接続と同じ結果にフィルタリングされます。

リクエストの例: cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connections?connectionId=d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3&visibleBy=bc7cb7b47c33' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

ユーザーの代わりに接続を作成または更新する

ユーザーの代わりに接続レコードを作成または更新するには、POST {baseURL}/v3/dcm/admin/connectionsエンドポイントを使用します。

プロパティ

接続の作成または更新セクションで説明したものと同じプロパティを使用します。このエンドポイントに必要とされる追加のプロパティは、ownerIdのみです。

ownerId (文字列): 必須です。

接続を作成するときは、代わって接続を作成するユーザーのIDを入力します。
接続を更新する場合は、変更しない場合でも、ownerIdも入力する必要があります。ownerIDの取得方法については、接続の取得または接続の一覧表示を参照してください。

リクエストの例: cURL

curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' `
  --header 'Authorization: Bearer BearerTokenGoesHere' `
  --header 'Content-Type: application/json' `
  --data '{
    "upsertConnectionContract": {
      "name": "MSSQL DEV Admin",
      "ownerId": "1b4bc56d489d9543a",
      "schemaName": "database-odbc-dsn-mssql",
      "parameters": {},
      "dataSource": {
        "object": {
          "name": "SQL Server DEV",
          "schemaName": "database-odbc-dsn-mssql",
          "parameters": {
            "dsn": "sql server"
          }
        }
      },
      "credentials": {
        "main": {
          "object": {
            "name": "SQL Server Admin Credentials",
            "schemaName": "username_password",
            "parameters": {},
            "userName": "admin",
            "secrets": {
              "password": {
                "value": {
                  "text": "password"
                },
                "parameters": {}
              }
            }
          }
        }
      }
    }
  }'

実行のために共有されている接続の共有を解除する

共有タイプが「実行のために共有」として定義されている接続の共有を解除するには、DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/executionエンドポイントを使用します。

プロパティ

objectId (文字列): 必須です。実行のための共有を解除するDCM接続IDを入力します。

リクエストの例: cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/execution' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

コラボレーションのために共有されている接続の共有を解除する

共有タイプが「コラボレーションのために共有」として定義されている接続の共有を解除するには、DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/collaborationエンドポイントを使用します。

プロパティ

objectId (文字列): 必須です。コラボレーションのための共有を解除するDCM接続IDを入力します。

リクエストの例: cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/collaboration' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

接続の削除

接続レコードを削除するには、DELETE {baseURL}/v3/dcm/admin/connections/{objectId}エンドポイントを使用します。他の接続で使用されていない限り、データソースと資格情報も削除されます。

プロパティ

objectId (文字列): 必須です。削除するDCM接続IDを入力します。

リクエストの例: cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

すべての接続処理ルールの取得

接続処理ルールを取得するには、GET {baseURL}/v3/dcm/admin/connectionhandlingrulesエンドポイントを使用します。

詳細については、DCM接続処理を参照してください。

プロパティ

プロパティがありません。

リクエストの例: cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

接続処理ルールの取得

特定のDCM接続処理ルールを取得するには、GET {baseURL}/v3/dcm/admin/connectionhandlingrules/{id}エンドポイントを使用します。

プロパティ

id (文字列): 必須です。返されるDCM接続処理ルールのIDを指定します。

リクエストの例: cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules/{id}' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

接続処理ルールの追加または更新

新しい接続処理ルールを追加したり、既存のルールを更新したりするには、POST {baseURL}/v3/dcm/admin/connectionhandlingrulesエンドポイントを使用します。

プロパティ

DCM接続処理ルールの作成または更新には、以下のプロパティを入力します

rule (本文): 必須です。作成または更新するDCM接続処理ルール。
- id (文字列): オプションです。DCM接続処理ルールのID。既存の接続処理ルールを更新する場合は、DCM接続処理ルールIDを入力します。新しい接続処理ルールを作成する場合はスキップします。
- sourceConnectionId (文字列): ワークフローの実行時に置換する接続IDを参照するソース接続IDを入力します。その接続がServer上に存在する必要はありません(参照するワークフローは変わらず実行できます)。この接続は、既存の他のルールで、ソース接続としてもターゲット接続としても使用できません。
- sourceConnectionTitle (文字列): ソース接続のカスタム名または説明を入力します。
- targetConnectionId (文字列): ターゲット接続IDを入力します。Server上に存在するDCM接続を参照する必要があります。
- targetConnectionTitle (文字列): オプションです。ターゲット接続のカスタム名または説明を入力します。選択した接続のタイトルに自動的に補完されます。

リクエストの例: cURL

curl --location 'https://localhost.com/webapi/v3/dcm/admin/connectionhandlingrules' `
--header 'Content-Type: application/json' `
--header 'Authorization: Bearer BearerTokenGoesHere' `
--data '{
    "sourceConnectionTitle": "MSSQL DEV",
    "sourceConnectionId": "c.cid.d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3",
    "targetConnectionId": "c.cid.cbf55382-f90b-4304-a1cd-37c5cff697e0"
}'

接続処理ルールの削除

既存の接続処理ルールを削除するには、DELETE {baseURL}/v3/dcm/admin/connectionhandlingrules/{id}エンドポイントを使用します。

プロパティ

id (文字列): 必須です。削除するDCM接続処理ルールを指定します。

リクエストの例: cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules/{id}' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

オブジェクト関係

接続を作成する場合、作成したオブジェクトを次のように使用することができます。

作成されたオブジェクト:

"id" (例えば、"id": "c128cc5fca-86cc-4e7e-93a3-d500cca9a3f3")
“connectionId” (例えば、"id": "c0332423423-86cc-4e7e-93a3-d500cca9a3f3")

次のように使用できます。

接続を取得する場合、idとして。
ワークフローで参照されている接続を取得する場合、connectionIdとして。
指定したユーザーおよびグループと接続を共有する場合、idとして。
接続を更新する場合、idとして。
接続を削除する場合、idとして。
接続の共有を解除する場合、idとして。

管理者 :

接続を取得する場合、idとして。
ユーザーの代わりに接続を作成する場合、ownerId (userId)として。
ユーザーの代わりに接続を更新する場合、idとして。
実行のために共有されている接続の共有を解除する場合、idとして。
コラボレーションのために共有されている接続の共有を解除する場合、idとして。
接続を削除する場合、idとして。

このセクションの内容:

DCMエンドポイント