Funktionen für die gemeinsame Verwendung von Empfängerdaten

Die hier aufgeführten Verfahren decken alle Funktionen ab, die ein Empfänger einer Datenfreigabe benötigt.

Empfänger erstellen - Vorgehensweise

Mit dieser Funktion wird ein Datenfreigabeempfänger erstellt.

Syntax

Share.create_recipient(name, email, description, owner, shares,
    token_lifetime)
Es gibt folgende Parameter und Beschreibungen:
  • Name: Der Name des Empfängers. Dieses Feld ist ein Pflichtfeld.
  • E-Mail: In diesem Feld wird die E-Mail-Adresse des Empfängers angezeigt.
  • Beschreibung: In diesem Feld wird die Beschreibung des Empfängers angezeigt. Wenn dieses Feld fehlt, verwendet das Tool eine leere Zeichenfolge.
  • Eigentümer: In diesem Feld wird der Eigentümer des Empfängers angezeigt. Wenn dieses Feld fehlt, verwendet das Tool den aktuellen Schemaeigentümer.
  • shares: Sie können die folgenden Felder im Empfänger-Shares-Dictionary anzeigen: "[{"name","shareNameValue"},...]". Wenn ein Parameter fehlt, verwendet das Tool ein leeres Wörterbuch "[]".
  • token_lifetime: Das Tool verwendet die Lebensdauer des Empfängertokens im Format "D HH:MM:SS". Wenn dieses Feld fehlt, verwendet das Tool '0 00:60:00'.

Beispiel
In diesem Beispiel können Sie einen Datenfreigabeempfänger erstellen:
adp.Share.create_recipient(
    name  = 'test_py_api_recipient_1',
    email = 'test@gmail.com'
)

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

Prozedur "Empfängerfreigabe aktualisieren"

Diese Funktion aktualisiert einen Datenfreigabeempfänger.

Syntax

Share.update_recipient_shares(name, shares, owner)
Es gibt folgende Parameter und Beschreibungen:
  • Name: Der Name des Empfängers. Dieses Feld ist ein Pflichtfeld.
  • Eigentümer: In diesem Feld wird der Eigentümer des Empfängers angezeigt. Wenn dieses Feld fehlt, verwendet das Tool den aktuellen Schemaeigentümer.
  • shares: Sie können die folgenden Felder im Empfänger-Shares-Dictionary anzeigen: "[{"name","shareNameValue"},...]". Wenn ein Parameter fehlt, verwendet das Tool ein leeres Wörterbuch "[]".

Beispiel
In diesem Beispiel können Sie einen Datenfreigabeempfänger aktualisieren:
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}'

Empfänger löschen - Vorgehensweise

Diese Funktion löscht einen Datenfreigabeempfänger.

Syntax

Share.delete_recipient(name, owner)
Es gibt folgende Parameter und Beschreibungen:
  • Name: Der Name des Empfängers. Dieses Feld ist ein Pflichtfeld.
  • Eigentümer: In diesem Feld wird der Eigentümer des Empfängers angezeigt. Wenn dieses Feld fehlt, verwendet das Tool den aktuellen Schemaeigentümer.

Beispiel
In diesem Beispiel können Sie einen Datenfreigabeempfänger löschen:
adp.Share.delete_recipient (name  = 'renamed_test_py_api_recipient_2')

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

Empfängerprozedur umbenennen

Diese Funktion benennt einen Datenfreigabeempfänger um.

Syntax

Share.rename_recipient(name, new_name, owner)
Es gibt folgende Parameter und Beschreibungen:
  • Name: Der Name des Empfängers. Dieses Feld ist ein Pflichtfeld.
  • new_name: Der Name des gewünschten Empfängers. Dieses Feld ist ein Pflichtfeld.
  • Eigentümer: In diesem Feld wird der Eigentümer des Empfängers angezeigt. Wenn dieses Feld fehlt, verwendet das Tool den aktuellen Schemaeigentümer.

Beispiel
In diesem Beispiel können Sie einen Datenfreigabeempfänger umbenennen:
adp.Share.rename_recipient(name = 'test_py_api_recipient_1', new_name = 'test_py_api_recipient_2')
//Output:
'{ "status": true }'

Empfängerprozedur abrufen

Diese Funktion erhält Details zum Datenfreigabeempfänger.

Syntax

Share.get_recipient(name, owner)
Es gibt folgende Parameter und Beschreibungen:
  • Name: Der Name des Empfängers. Dieses Feld ist ein Pflichtfeld.
  • Eigentümer: In diesem Feld wird der Eigentümer des Empfängers angezeigt. Wenn dieses Feld fehlt, verwendet das Tool den aktuellen Schemaeigentümer.

Beispiel
In diesem Beispiel können Sie Details zu einem Datenfreigabeempfänger erhalten:
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'}

Empfänger abrufen - Vorgehensweise

Diese Funktion erhält eine Liste der Datenfreigabeempfänger basierend auf dem Eigentümer der Datenschemaempfänger.

Syntax

Share.get_recipients(owner)
Es gibt folgende Parameter und Beschreibungen:
  • Eigentümer: In diesem Feld wird der Eigentümer des Empfängers angezeigt. Wenn dieses Feld fehlt, verwendet das Tool den aktuellen Schemaeigentümer.

Beispiel
In diesem Beispiel können Sie eine Liste der Datenfreigabeempfänger erhalten:
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'}]

Profil für Empfängerfreigabe abrufen - Vorgehensweise

Diese Funktion erhält das Datenfreigabeprofil des Empfängers.

Syntax

Share.get_recipient_sharing_profile(name, owner)
Es gibt folgende Parameter und Beschreibungen:
  • Name: Der Name des Empfängers. Dieses Feld ist ein Pflichtfeld.
  • Eigentümer: In diesem Feld wird der Eigentümer des Empfängers angezeigt. Wenn dieses Feld fehlt, verwendet das Tool den aktuellen Schemaeigentümer.

Beispiel
In diesem Beispiel können Sie das Profil "Datenfreigabe" eines Datenfreigabeempfängers erhalten:
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..'}

Übergeordnetes Thema: Datenfreigabefunktionen