Funções de Compartilhamento de Dados do Destinatário

Criar Procedimento do Destinatário

Esta função cria um Destinatário de Compartilhamento de Dados.

Sintaxe

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

A seguir estão seus parâmetros e descrições:

name: O nome do Destinatário. Esse campo é obrigatório.
e-mail: Este campo exibe o endereço de e-mail do Destinatário.
descrição: Este campo exibe a descrição do Destinatário. Se este campo estiver ausente, a ferramenta usará uma string vazia.
proprietário: Este campo exibe o proprietário do Destinatário. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.
shares: Você pode exibir os seguintes campos no dicionário de compartilhamentos de destinatários: "[{"name","shareNameValue"},...]". Se um parâmetro estiver ausente, a ferramenta usará um dicionário vazio "[]".
token_lifetime: A ferramenta usa a vida útil do token do destinatário neste formato 'D HH:MM:SS'. Se este campo estiver ausente, a ferramenta usará '0 00:60:00'.

Exemplo

Neste exemplo, você pode criar um Destinatário de Compartilhamento de Dados:

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

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

Atualizar Procedimento de Compartilhamento do Destinatário

Esta função atualiza um Destinatário de Compartilhamento de Dados.

Sintaxe

Share.update_recipient_shares(name, shares, owner)

A seguir estão seus parâmetros e descrições:

name: O nome do Destinatário. Esse campo é obrigatório.
proprietário: Este campo exibe o proprietário do Destinatário. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.
shares: Você pode exibir os seguintes campos no dicionário de compartilhamentos de destinatários: "[{"name","shareNameValue"},...]". Se um parâmetro estiver ausente, a ferramenta usará um dicionário vazio "[]".

Exemplo

Neste exemplo, você pode atualizar um Destinatário do Compartilhamento de Dados:

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

Excluir Procedimento do Destinatário

Esta função exclui um Destinatário de Compartilhamento de Dados.

Sintaxe

Share.delete_recipient(name, owner)

A seguir estão seus parâmetros e descrições:

name: O nome do Destinatário. Esse campo é obrigatório.
proprietário: Este campo exibe o proprietário do Destinatário. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode excluir um Destinatário de Compartilhamento de Dados:

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

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

Renomear procedimento do destinatário

Esta função renomeia um Destinatário de Compartilhamento de Dados.

Sintaxe

Share.rename_recipient(name, new_name, owner)

A seguir estão seus parâmetros e descrições:

name: O nome do Destinatário. Esse campo é obrigatório.
new_name: O nome do Destinatário desejado. Esse campo é obrigatório.
proprietário: Este campo exibe o proprietário do Destinatário. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode renomear um Destinatário do Compartilhamento de Dados:

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

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

Obter Procedimento do Destinatário

Esta função recebe detalhes do Destinatário do Compartilhamento de Dados.

Sintaxe

Share.get_recipient(name, owner)

A seguir estão seus parâmetros e descrições:

name: O nome do Destinatário. Esse campo é obrigatório.
proprietário: Este campo exibe o proprietário do Destinatário. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode receber detalhes de um Destinatário do Compartilhamento de Dados:

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

Procedimento Obter Destinatários

Esta função recebe uma lista de Destinatários de Compartilhamento de Dados com base no proprietário dos destinatários do esquema de dados.

Sintaxe

Share.get_recipients(owner)

A seguir estão seus parâmetros e descrições:

proprietário: Este campo exibe o proprietário do Destinatário. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode receber uma lista de Destinatários do Compartilhamento de Dados:

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

Obter Procedimento do Perfil de Compartilhamento do Destinatário

Essa função recebe o perfil de Compartilhamento de Dados do Destinatário.

Sintaxe

Share.get_recipient_sharing_profile(name, owner)

A seguir estão seus parâmetros e descrições:

name: O nome do Destinatário. Esse campo é obrigatório.
proprietário: Este campo exibe o proprietário do Destinatário. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode receber o perfil Compartilhamento de Dados de um Destinatário do Compartilhamento de Dados:

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