收件人数据共享功能

此处列出的过程涵盖数据共享的接收者所需的所有功能。

创建收件人过程

此功能将创建数据共享收件人。

语法

Share.create_recipient(name, email, description, owner, shares,
    token_lifetime)
以下是它的参数和说明：
  • name ：收件人的姓名。此字段为必填字段。
  • 电子邮件：此字段显示收件人的邮件地址。
  • 说明：此字段显示收件人的说明。如果缺少此字段，该工具将使用空字符串。
  • 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 = 'test@gmail.com'
)

//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': 'test@gmail.com',
 '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': 'test@gmail.com'}]

获取收件人共享概要信息的过程

此功能接收接收人的“数据共享”配置文件。

语法

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..'}

父主题：数据共享功能