DCMEエンドポイント
DCMEエンドポイントとパラメーター
DCMEエンドポイントは、 ユーザー向けDCMEエンドポイント と 管理者向けDCMEエンドポイント の2つのグループに分けられます。すべてのDCMEエンドポイントについて、TLSをServer上で設定する必要があります。
オブジェクト関係に関する詳細とAPIでの使用方法については、 オブジェクト関係 のセクションを参照してください。
データ接続の詳細については、 DCM - Server および データ接続マネージャー: Server UI のヘルプページを参照してください。
ユーザー向けDCMEエンドポイント
これらのエンドポイントは、APIアクセスを持つユーザーが使用できます。
すべてのAPIエンドポイントは、個々のユーザーデータを返します(各ユーザーは自分の接続のみを表示および管理できます)。
DCM接続レコードを取得するには、 GET {baseURL}/v3/dcm/connections/{id} エンドポイントを使用します。このエンドポイントは、関連するデータソースや資格情報、共有情報など、DCM接続に関するすべての情報を返します。
パラメーター
id (文字列): 必須です。情報を取得するDCM接続のIDを入力します。
リクエストの例: cURL
curl --location --request GET 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' \ --header 'Authorization: Bearer BearerTokenGoesHere'
ワークフローで参照されているDCM接続レコードを取得するには、 GET {baseURL}/v3/dcm/connections/lookup エンドポイントを使用しますこのエンドポイントは、関連するデータソースや資格情報、共有情報など、DCM接続に関するすべての情報を返します。
注記
このエンドポイントで使用される接続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の実行のためのDCM接続を共有するには、 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"]}'
DCM接続の共有を解除するには、 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'
DCM接続を作成または更新するには、 POST {baseURL}/v3/dcm/connections エンドポイントを使用します。
単一のエンドポイントが作成と更新の両方の機能を備えており、その区別はオブジェクトIDがリクエストに含まれているかどうかでされます。新しい接続を作成する際の、既存のデータソースまたは資格情報の再利用は、現在サポートされていません。
パラメーター
upsertConnectionContract (文字列): 必須です。DCM接続は、データソース(移行先のインスタンスホストを示す)と資格情報(ユーザー名とパスワードなど)を組み合わせたもので、可能なスキーマの組み合わせを定義します。
id (文字列): オプションです。既存の接続を更新する場合は、接続IDを入力します。新しい接続を作成する場合はスキップします。
name (文字列): 必須です。接続名を入力します。
schemaName (文字列): 必須です。使用する接続スキーマ名を入力します。スキーマは、接続およびデータソースに必要なパラメーターと、その接続に使用できる資格情報スキーマを定義します。
allowInSdks (ブール型): オプションです。
parameters (オブジェクト): 必須です。選択したschemaNameに応じて、さまざまなパラメーターが必要になる場合があります。
dataSource (オブジェクト): 必須です。接続に使用されるデータソースで、DCM UIに表示されるデータソースインスタンスホストと追加パラメーターを示します。
object (オブジェクト): 必須です。
id (文字列): 既存の接続を更新する場合は、データソースIDを入力します。新しい接続を作成する場合はスキップします。新しい接続の作成時に既存のデータソースを使用することは現在できません。
name (文字列): 必須です。データソースの名前を入力します。
schemaName (文字列): 必須です。選択したデータソースのスキーマ名を入力します。
スキーマ固有の追加パラメーター : 使用するスキーマに応じて、追加のデータソースパラメーターを指定する必要があります。
credentials (文字列): オプションです。upsertConnectionContractで選択されたschemaNameに基づきます。接続によっては、資格情報を必要としないものもあれば、複数のネストされたオブジェクト(スロット)を持つものもあります。
main (オブジェクト): オプションです(上記参照)。このmainは、1つの(最も一般的な)資格情報スロット名にすぎません。ただし、接続スキーマで定義されているものに応じて、異なる名前が付けられることも、接続に複数の資格情報スロットが存在することもあります。
id (文字列): 既存の接続を更新する場合は、資格情報IDを入力します。新しい接続を作成する場合はスキップします。新しい接続の作成時に既存の資格情報を使用することは現在できません。
name (文字列): 必須です。資格情報名を入力します。
schemaName (文字列): 必須です。選択した資格情報のスキーマ名を入力します。
スキーマ固有の追加パラメーター : 使用するスキーマに応じて、追加のデータソースパラメーターを指定する必要があります。
リクエストの例: cURL
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":{}}}}}}}'
DCM接続を削除するには、 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'
管理者向けDCMEエンドポイント
APIアクセスを持つ管理者が使用できるエンドポイントです。
すべての管理者APIエンドポイントは、所有権に関係なく、Server上ですべてのユーザーが利用可能なすべてのデータを返します。
DCM接続レコードを取得するには、 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に存在するすべてのDCM接続レコードのリストを取得するには、 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'
ユーザーの代わりにDCM接続レコードを作成または更新するには、 POST {baseURL}/v3/dcm/admin/connections エンドポイントを使用します。
パラメーター
upsertConnectionContract (文字列): 必須です。
id (文字列): オプションです。既存の接続を更新する場合は、接続IDを入力します。新しい接続を作成する場合はスキップします。
ownerId (文字列): 必須です。
DCM接続を作成するときは、代わって接続を作成するユーザーのIDを入力します。
DCM接続を更新する場合は、変更しない場合でも、 ownerId も入力する必要があります。ownerIDの取得方法の詳細については、 DCM接続レコードを取得する または DCM接続レコードのリストを取得する を参照してください。
name (文字列): 必須です。接続名を入力します。
schemaName (文字列): 必須です。使用する接続スキーマ名を入力します。スキーマは、接続およびデータソースに必要なパラメーターと、その接続に使用できる資格情報スキーマを定義します。
allowInSdks (ブール型): オプションです。
parameters (オブジェクト): 必須です。選択したschemaNameに応じて、さまざまなパラメーターが必要になる場合があります。
dataSource (オブジェクト): 必須です。接続に使用されるデータソースです。
object (オブジェクト): 必須です。
id (文字列): 既存の接続を更新する場合は、データソースIDを入力します。新しい接続を作成する場合はスキップします。新しい接続の作成時に既存のデータソースを使用することは現在できません。
name (文字列): 必須です。データソースの名前を入力します。
schemaName (文字列): 必須です。選択したデータソースのスキーマ名を入力します。
スキーマ固有の追加パラメーター : 使用するスキーマに応じて、追加のデータソースパラメーターを指定する必要があります。
credentials (文字列): オプションです。upsertConnectionContractで選択されたschemaNameに基づきます。資格情報を必要としない接続もあれば、複数の資格情報を使用する接続もあります。
main (オブジェクト): オプションです(上記参照)。
id (文字列): 既存の接続を更新する場合は、資格情報IDを入力します。新しい接続を作成する場合はスキップします。新しい接続の作成時に既存の資格情報を使用することは現在できません。
name (文字列): 必須です。資格情報名を入力します。
schemaName (文字列): 必須です。選択した資格情報のスキーマ名を入力します。
スキーマ固有の追加パラメーター : 使用するスキーマに応じて、追加の資格情報パラメーターを指定する必要があります。
リクエストの例: cURL
curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --header "Content-Type: application/json" \ --data '{"Name":"MSSQL DEV Admin","onwerId":"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":{}}}}}}}'
共有タイプが「実行のために共有」として定義されているDCM接続の共有を解除するには、 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'
共有タイプが「コラボレーションのために共有」として定義されているDCM接続の共有を解除するには、 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'
DCM接続レコードを削除するには、 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'
オブジェクト関係
DCM接続を作成する場合、作成したオブジェクトを次のように使用することができます。
作成されたオブジェクト:
" id " (例えば、"id": "c128cc5fca-86cc-4e7e-93a3-d500cca9a3f3")
“ connectionId ” (例えば、"id": "c0332423423-86cc-4e7e-93a3-d500cca9a3f3")
次のように使用できます。
DCM接続レコードを取得する 場合、 id として。
ワークフローで参照されているDCM接続を取得する 場合、 connectionId として。
指定したユーザーおよびグループとDCM接続を共有する 場合、 id として。
DCM接続を更新する 場合、 id として。
DCM接続を削除する 場合、 id として。
DCM接続の共有を解除する 場合、 id として。
Admin (管理者):
DCM接続レコードを取得する 場合、 id として。
ユーザーの代わりにDCM接続を作成する 場合、 ownerId (userId)として。
ユーザーの代わりにDCM接続を更新する 場合、 id として。
実行のために共有されているDCM接続の共有を解除する 場合、 id として。
コラボレーションのために共有されているDCM接続の共有を解除する 場合、 id として。
DCM接続を削除する 場合、 id として。