Fonctions de partage de données de destinataire

Créer une procédure destinataire

Cette fonction crée un destinataire de partage de données.

Syntaxe

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

Ses paramètres et descriptions sont les suivants :

name : nom du destinataire. Ce champ est obligatoire.
email : ce champ affiche l'adresse électronique du destinataire.
description : Ce champ affiche la description du destinataire. Si ce champ est manquant, l'outil utilise une chaîne vide.
owner : Ce champ affiche le propriétaire du destinataire. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.
shares : vous pouvez afficher les champs suivants dans le dictionnaire des partages de destinataire : "[{"name","shareNameValue"},...]". Si un paramètre est manquant, l'outil utilise un dictionnaire vide "[]".
token_lifetime : l'outil utilise la durée de vie du jeton du destinataire au format "D HH:MM:SS". Si ce champ est manquant, l'outil utilise '0 00:60:00'.

Exemple

Dans cet exemple, vous pouvez créer un destinataire de partage de données :

adp.Share.create_recipient(
    name  = 'test_py_api_recipient_1',
    email = 'test@gmail.com'
)

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

Mettre à jour la procédure de partage de destinataires

Cette fonction met à jour un destinataire de partage de données.

Syntaxe

Share.update_recipient_shares(name, shares, owner)

Ses paramètres et descriptions sont les suivants :

name : nom du destinataire. Ce champ est obligatoire.
owner : Ce champ affiche le propriétaire du destinataire. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.
shares : vous pouvez afficher les champs suivants dans le dictionnaire des partages de destinataire : "[{"name","shareNameValue"},...]". Si un paramètre est manquant, l'outil utilise un dictionnaire vide "[]".

Exemple

Dans cet exemple, vous pouvez mettre à jour un destinataire de partage de données :

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

Supprimer la procédure destinataire

Cette fonction supprime un destinataire de partage de données.

Syntaxe

Share.delete_recipient(name, owner)

Ses paramètres et descriptions sont les suivants :

name : nom du destinataire. Ce champ est obligatoire.
owner : Ce champ affiche le propriétaire du destinataire. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple

Dans cet exemple, vous pouvez supprimer un destinataire de partage de données :

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

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

Renommer la procédure destinataire

Cette fonction renomme un destinataire de partage de données.

Syntaxe

Share.rename_recipient(name, new_name, owner)

Ses paramètres et descriptions sont les suivants :

name : nom du destinataire. Ce champ est obligatoire.
new_name : nom du destinataire souhaité. Ce champ est obligatoire.
owner : Ce champ affiche le propriétaire du destinataire. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple

Dans cet exemple, vous pouvez renommer un destinataire de partage de données :

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

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

Obtenir la procédure du destinataire

Cette fonction reçoit les détails du destinataire du partage de données.

Syntaxe

Share.get_recipient(name, owner)

Ses paramètres et descriptions sont les suivants :

name : nom du destinataire. Ce champ est obligatoire.
owner : Ce champ affiche le propriétaire du destinataire. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple

Dans cet exemple, vous pouvez recevoir les détails d'un destinataire de partage de données :

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

Obtenir les destinataires - Procédure

Cette fonction reçoit la liste des destinataires de partage de données en fonction du propriétaire des destinataires de schéma de données.

Syntaxe

Share.get_recipients(owner)

Ses paramètres et descriptions sont les suivants :

owner : Ce champ affiche le propriétaire du destinataire. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple

Dans cet exemple, vous pouvez recevoir la liste des destinataires de partage de données :

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

Obtenir le profil de partage de destinataire - Procédure

Cette fonction reçoit le profil de partage de données du destinataire.

Syntaxe

Share.get_recipient_sharing_profile(name, owner)

Ses paramètres et descriptions sont les suivants :

name : nom du destinataire. Ce champ est obligatoire.
owner : Ce champ affiche le propriétaire du destinataire. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple

Dans cet exemple, vous pouvez recevoir le profil de partage de données d'un destinataire de partage de données :

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