11.1.5.1 受信者データ共有関数

ここに示す手順では、データ共有の受信者が必要とするすべての関数について説明します。

受信者の作成手順

この関数は、データ共有受信者を作成します。

構文

Share.create_recipient(name, email, description, owner, shares,
    token_lifetime)

パラメータと説明を次に示します:

• name: 受信者の名前。このフィールドは必須です。
• email: このフィールドには、受信者のメール・アドレスが表示されます。
• description: このフィールドには、受信者の説明が表示されます。このフィールドがない場合、空の文字列が使用されます。
• owner: このフィールドには、受信者所有者が表示されます。このフィールドがない場合、現在のスキーマ所有者が使用されます。
• shares: 受信者共有ディクショナリのフィールド"[{"name","shareNameValue"},...]"が表示されます。パラメータがない場合、空のディクショナリ"[]"が使用されます。
• token_lifetime: 受信者トークン存続時間が'D HH:MM:SS'の形式で使用されます。このフィールドがない場合、'0 00:60:00'が使用されます。

例

この例では、データ共有受信者を作成できます:

adp.Share.create_recipient(
    name  = 'test_py_api_recipient_1',
    email = '[e-mail]'
)

//Output:
'{"createRecipient":true,"name":"TEST_PY_API_RECIPIENT_1"}'

受信者共有の更新手順

この関数は、データ共有受信者を更新します。

構文

Share.update_recipient_shares(name, shares, owner)

パラメータと説明を次に示します:

• name: 受信者の名前。このフィールドは必須です。
• owner: このフィールドには、受信者所有者が表示されます。このフィールドがない場合、現在のスキーマ所有者が使用されます。
• shares: 受信者共有ディクショナリのフィールド"[{"name","shareNameValue"},...]"が表示されます。パラメータがない場合、空のディクショナリ"[]"が使用されます。

例

この例では、データ共有受信者を更新できます:

recipient_name = 'test_py_api_recipient_1'
shares = json.dumps([{"name":'share_py_api_7'}])
adp.Share.update_recipient_shares(name = recipient_name, shares = shares)

//Output:
'{"status" : true}'

受信者の削除手順

この関数は、データ共有受信者を削除します。

構文

Share.delete_recipient(name, owner)

パラメータと説明を次に示します:

• name: 受信者の名前。このフィールドは必須です。
• owner: このフィールドには、受信者所有者が表示されます。このフィールドがない場合、現在のスキーマ所有者が使用されます。

例

この例では、データ共有受信者を削除できます:

adp.Share.delete_recipient (name  = 'renamed_test_py_api_recipient_2')

//Output:
'{ "status": true }'

受信者の名前変更手順

この関数は、データ共有受信者の名前を変更します。

構文

Share.rename_recipient(name, new_name, owner)

パラメータと説明を次に示します:

• name: 受信者の名前。このフィールドは必須です。
• new_name: 使用する受信者の名前。このフィールドは必須です。
• owner: このフィールドには、受信者所有者が表示されます。このフィールドがない場合、現在のスキーマ所有者が使用されます。

例

この例では、データ共有受信者の名前を変更できます:

adp.Share.rename_recipient(name = 'test_py_api_recipient_1', new_name = 'test_py_api_recipient_2')

//Output:
'{ "status": true }'

受信者の取得手順

この関数は、データ共有受信者の詳細を受け取ります。

構文

Share.get_recipient(name, owner)

パラメータと説明を次に示します:

• name: 受信者の名前。このフィールドは必須です。
• owner: このフィールドには、受信者所有者が表示されます。このフィールドがない場合、現在のスキーマ所有者が使用されます。

例

この例では、データ共有受信者の詳細を受け取ることができます:

s = adp.Share.get_recipient('test_py_api_recipient_2')
json.loads(s)

//Output:
{'name': 'TEST_PY_API_RECIPIENT_2',
 'id': 40436,
 'type': 'DELTA_SHARING',
 'description': None,
 'email': '[e-mail]',
 'clientId': 'xxxxxxxxxxxx..',
 'clientSecret': 'xxxxxxxxxxxxxx..',
 'tokenDuration': None,
 'shares': [{'name': 'SHARE_PY_API_7',
   'id': 40419,
   'description': 'desc_share_py_api_7',
   'tablesCount': 2}],
 'created': '2024-11-12T15:34:08',
 'updated': '2024-11-12T15:36:13'}

受信者(複数)の取得手順

この関数は、データ・スキーマ受信者所有者に基づいてデータ共有受信者のリストを受け取ります。

構文

Share.get_recipients(owner)

パラメータと説明を次に示します:

• owner: このフィールドには、受信者所有者が表示されます。このフィールドがない場合、現在のスキーマ所有者が使用されます。

例

この例では、データ共有受信者のリストを受け取ることができます:

s = adp.Share.get_recipients()
json.loads(s)

//Output:
[{'id': 40436,
  'name': 'TEST_PY_API_RECIPIENT_2',
  'type': 'DELTA_SHARING',
  'description': None,
  'email': '[e-mail]'}]

受信者共有プロファイルの取得手順

この関数は、受信者のデータ共有プロファイルを受け取ります。

構文

Share.get_recipient_sharing_profile(name, owner)

パラメータと説明を次に示します:

• name: 受信者の名前。このフィールドは必須です。
• owner: このフィールドには、受信者所有者が表示されます。このフィールドがない場合、現在のスキーマ所有者が使用されます。

例

この例では、データ共有受信者のデータ共有プロファイルを受け取ることができます:

s = adp.Share.get_recipient_sharing_profile('test_py_api_recipient_2')
json.loads(s)

//Output:
{'shareCredentialsVersion': 2,
 'type': 'persistent_oauth2.0',
 'endpoint': 'https://abc-xyz//xx/delta_sharing',
 'tokenEndpoint': 'https://abcdefg.xx.com/adp/admin/oauth/token',
 'clientId': 'abcdefghijklmnopg..',
 'clientSecret': 'abcdefrtyuioohh..'}