Funciones de uso compartido de datos de destinatario

Los procedimientos enumerados aquí cubren todas las funciones requeridas por un destinatario de un recurso compartido de datos.

Crear procedimiento de destinatario

Esta función crea un destinatario de recurso compartido de datos.

Sintaxis

Share.create_recipient(name, email, description, owner, shares,
    token_lifetime)
A continuación se muestran sus parámetros y descripciones:
  • name: el nombre del destinatario. Este campo es obligatorio.
  • correo electrónico: este campo muestra la dirección de correo del destinatario.
  • descripción: este campo muestra la descripción del destinatario. Si falta este campo, la herramienta utiliza una cadena vacía.
  • owner (Propietario): este campo muestra el propietario del destinatario. Si falta este campo, la herramienta utiliza el propietario del esquema actual.
  • shares: puede ver los siguientes campos en el diccionario de recursos compartidos del destinatario: "[{"name","shareNameValue"},...]". Si falta un parámetro, la herramienta utiliza un diccionario vacío "[]".
  • token_lifetime: la herramienta utiliza la duración del token de destinatario en este formato 'D HH:MM:SS'. Si falta este campo, la herramienta utiliza '0 00:60:00'.

Ejemplo
En este ejemplo, puede crear un destinatario de recurso compartido de datos:
adp.Share.create_recipient(
    name  = 'test_py_api_recipient_1',
    email = 'test@gmail.com'
)

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

Actualizar procedimiento de uso compartido de destinatario

Esta función actualiza un destinatario de uso compartido de datos.

Sintaxis

Share.update_recipient_shares(name, shares, owner)
A continuación se muestran sus parámetros y descripciones:
  • name: el nombre del destinatario. Este campo es obligatorio.
  • owner (Propietario): este campo muestra el propietario del destinatario. Si falta este campo, la herramienta utiliza el propietario del esquema actual.
  • shares: puede ver los siguientes campos en el diccionario de recursos compartidos del destinatario: "[{"name","shareNameValue"},...]". Si falta un parámetro, la herramienta utiliza un diccionario vacío "[]".

Ejemplo
En este ejemplo, puede actualizar un destinatario de recurso compartido de datos:
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}'

Suprimir procedimiento de destinatario

Esta función suprime un destinatario de recurso compartido de datos.

Sintaxis

Share.delete_recipient(name, owner)
A continuación se muestran sus parámetros y descripciones:
  • name: el nombre del destinatario. Este campo es obligatorio.
  • owner (Propietario): este campo muestra el propietario del destinatario. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo
En este ejemplo, puede suprimir un destinatario de recurso compartido de datos:
adp.Share.delete_recipient (name  = 'renamed_test_py_api_recipient_2')

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

Cambiar nombre de procedimiento de destinatario

Esta función cambia el nombre de un destinatario de recurso compartido de datos.

Sintaxis

Share.rename_recipient(name, new_name, owner)
A continuación se muestran sus parámetros y descripciones:
  • name: el nombre del destinatario. Este campo es obligatorio.
  • new_name: nombre del destinatario que desea. Este campo es obligatorio.
  • owner (Propietario): este campo muestra el propietario del destinatario. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo
En este ejemplo, puede cambiar el nombre de un destinatario de recurso compartido de datos:
adp.Share.rename_recipient(name = 'test_py_api_recipient_1', new_name = 'test_py_api_recipient_2')
//Output:
'{ "status": true }'

Obtener procedimiento de destinatario

Esta función recibe detalles del destinatario del recurso compartido de datos.

Sintaxis

Share.get_recipient(name, owner)
A continuación se muestran sus parámetros y descripciones:
  • name: el nombre del destinatario. Este campo es obligatorio.
  • owner (Propietario): este campo muestra el propietario del destinatario. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo
En este ejemplo, puede recibir detalles de un destinatario de recurso compartido de datos:
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'}

Procedimiento para obtener destinatarios

Esta función recibe una lista de destinatarios de recursos compartidos de datos basada en el propietario de los destinatarios del esquema de datos.

Sintaxis

Share.get_recipients(owner)
A continuación se muestran sus parámetros y descripciones:
  • owner (Propietario): este campo muestra el propietario del destinatario. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo
En este ejemplo, puede recibir una lista de destinatarios de recursos compartidos de datos:
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'}]

Obtener procedimiento de perfil de uso compartido de destinatario

Esta función recibe el perfil de uso compartido de datos del destinatario.

Sintaxis

Share.get_recipient_sharing_profile(name, owner)
A continuación se muestran sus parámetros y descripciones:
  • name: el nombre del destinatario. Este campo es obligatorio.
  • owner (Propietario): este campo muestra el propietario del destinatario. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo
En este ejemplo, puede recibir el perfil de uso compartido de datos de un destinatario de uso compartido de datos:
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..'}

Tema principal: Funciones de uso compartido de datos