Funzioni di condivisione dati destinatario

Le procedure qui elencate coprono tutte le funzioni richieste da un destinatario di una condivisione di dati.

Procedura di creazione destinatario

Questa funzione crea un destinatario condivisione dati.

Sintassi

Share.create_recipient(name, email, description, owner, shares,
    token_lifetime)
Di seguito sono riportati i parametri e le descrizioni.
  • nome: il nome del destinatario. Questo campo è obbligatorio.
  • E-mail: questo campo visualizza l'indirizzo di posta del destinatario.
  • descrizione: questo campo visualizza la descrizione del destinatario. Se manca questo campo, lo strumento utilizza una stringa vuota.
  • proprietario: questo campo visualizza il proprietario del destinatario. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.
  • Condivisioni: è possibile visualizzare i seguenti campi nel dizionario delle condivisioni dei destinatari: "[{"name","shareNameValue"},...]". Se manca un parametro, lo strumento utilizza un dizionario "[]" vuoto.
  • token_lifetime: lo strumento utilizza la durata del token del destinatario nel formato 'D HH:MM:SS'. Se questo campo è mancante, lo strumento utilizza '0 00:60:00'.

Esempio
In questo esempio è possibile creare un destinatario condivisione dati:
adp.Share.create_recipient(
    name  = 'test_py_api_recipient_1',
    email = 'test@gmail.com'
)

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

Procedura di aggiornamento condivisione destinatari

Questa funzione aggiorna un destinatario condivisione dati.

Sintassi

Share.update_recipient_shares(name, shares, owner)
Di seguito sono riportati i parametri e le descrizioni.
  • nome: il nome del destinatario. Questo campo è obbligatorio.
  • proprietario: questo campo visualizza il proprietario del destinatario. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.
  • Condivisioni: è possibile visualizzare i seguenti campi nel dizionario delle condivisioni dei destinatari: "[{"name","shareNameValue"},...]". Se manca un parametro, lo strumento utilizza un dizionario "[]" vuoto.

Esempio
In questo esempio è possibile aggiornare un destinatario condivisione dati:
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}'

Procedura di eliminazione destinatario

Questa funzione elimina un destinatario condivisione dati.

Sintassi

Share.delete_recipient(name, owner)
Di seguito sono riportati i parametri e le descrizioni.
  • nome: il nome del destinatario. Questo campo è obbligatorio.
  • proprietario: questo campo visualizza il proprietario del destinatario. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.

Esempio
In questo esempio è possibile eliminare un destinatario condivisione dati:
adp.Share.delete_recipient (name  = 'renamed_test_py_api_recipient_2')

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

Rinomina procedura destinatario

Questa funzione rinomina un destinatario condivisione dati.

Sintassi

Share.rename_recipient(name, new_name, owner)
Di seguito sono riportati i parametri e le descrizioni.
  • nome: il nome del destinatario. Questo campo è obbligatorio.
  • nuovo_nome: il nome del destinatario desiderato. Questo campo è obbligatorio.
  • proprietario: questo campo visualizza il proprietario del destinatario. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.

Esempio
In questo esempio è possibile rinominare un destinatario condivisione dati.
adp.Share.rename_recipient(name = 'test_py_api_recipient_1', new_name = 'test_py_api_recipient_2')
//Output:
'{ "status": true }'

Procedura di recupero destinatario

Questa funzione riceve i dettagli del destinatario condivisione dati.

Sintassi

Share.get_recipient(name, owner)
Di seguito sono riportati i parametri e le descrizioni.
  • nome: il nome del destinatario. Questo campo è obbligatorio.
  • proprietario: questo campo visualizza il proprietario del destinatario. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.

Esempio
In questo esempio è possibile ricevere i dettagli di un destinatario condivisione dati:
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'}

Procedura di recupero destinatari

Questa funzione riceve una lista di destinatari condivisione dati in base al proprietario dei destinatari dello schema dati.

Sintassi

Share.get_recipients(owner)
Di seguito sono riportati i parametri e le descrizioni.
  • proprietario: questo campo visualizza il proprietario del destinatario. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.

Esempio
In questo esempio è possibile ricevere una lista di destinatari condivisione dati:
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'}]

Procedura recupero profilo condivisione destinatari

Questa funzione riceve il profilo di condivisione dati del destinatario.

Sintassi

Share.get_recipient_sharing_profile(name, owner)
Di seguito sono riportati i parametri e le descrizioni.
  • nome: il nome del destinatario. Questo campo è obbligatorio.
  • proprietario: questo campo visualizza il proprietario del destinatario. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.

Esempio
In questo esempio è possibile ricevere il profilo Condivisione dati di un destinatario condivisione dati:
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..'}

Argomento padre: Funzioni di condivisione dati