Pontos de extremidade de conexões do Server
Pontos de extremidade de conexões do Server e parâmetros
Para saber mais sobre as relações de objetos e como usá-las na API, vá para a seção Relações de objeto .
Para obter mais informações sobre conexões de dados, visite a página de ajuda Conexões de dados .
Recuperar todos os registros de conexão de dados do Server
Para obter informações sobre todos os registros de fluxos de trabalho, use o ponto de extremidade
GET {baseURL}/v3/workflows/
.
Parâmetros
view (cadeia de caracteres): opcional. Pode ser deixado sem um valor. Você pode selecionar entre os seguintes valores: "Default" (padrão) e "Full" (completo). Se esse parâmetro for definido como "Default", um objeto de visualização reduzido será retornado. Quando não especificado, o valor "Default" é usado.
Exemplo de solicitação: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows' \ --header 'Authorization: Bearer token-bearer-aqui'
Recuperar um registro de conexão de dados do Server
Para recuperar informações sobre uma conexão de dados de servidor específica, use o
{baseURL}get /v3/serverDataConnections /{dataConnectionId}
endpoint.
Parâmetros
workflowCredentialType (cadeia de caracteres): obrigatório. Introduza uma ID de ligação de dados do servidor para obter as informações sobre uma ligação de dados específica.
Exemplo de solicitação: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer token-bearer-aqui'
Atualizar uma conexão de dados existente
Para alterar
o
nome de uma conexão de dados, use o
{baseURL}endpoint PUT /v3/serverDataConnections/{dataConnectionId}
.
Parâmetros
workflowCredentialType (cadeia de caracteres): obrigatório. Introduza um ID de ligação de dados do servidor para especificar a ligação de dados que pretende atualizar.
updateWorkflowContract (corpo): obrigatório. Introduza um novo nome para uma ligação de dados:
name (cadeia de caracteres): obrigatório. Introduza o novo nome da ligação de dados.
Exemplo de solicitação: cURL
Curl --loCALIZAÇÃO --REQUEST PUT 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c21013530fa' --header 'Content-Type: Application/x-www-form-urlencoded' --header 'Authorization: BearerTokenGoesHere' --data-urlencode 'name' Oracle DB Connection'
Adicionar um usuário a uma coleção
Para adicionar um usuário a uma conexão de dados do servidor, use o
{baseURL}endpoint POST /v3/serverDataConnections/{dataConnectionId}/users
.
Parâmetros
workflowCredentialType (cadeia de caracteres): obrigatório. Introduza um ID de ligação de dados do servidor para especificar a ligação de dados à qual pretende adicionar um utilizador.
Contrato (corpo): Obrigatório. Introduza uma informação sobre o utilizador que pretende adicionar a uma ligação de dados:
workflowCredentialType (cadeia de caracteres): obrigatório. Especifique o ID de um usuário que deseja adicionar a uma conexão de dados.
Exemplo de solicitação: cURL
Curl --localização --REQUEST post 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/users' --header 'Content-Type: Application/x-www-form-urlencoded' --header 'Authorization: BearerTokenGoesHere' --data-urlencode 'UserId 61dec95f5436c22101353193'
Adicionar um Grupo de Utilizadores a uma Ligação de Dados
Para adicionar um grupo de usuários a uma conexão de dados do servidor, use o
{baseURL}endpoint POST /v3/serverDataConnections/{dataConnectionId}/Usergroups
.
Parâmetros
workflowCredentialType (cadeia de caracteres): obrigatório. Insira um ID de conexão de dados do servidor para especificar a conexão de dados para adicionar um grupo de usuários.
Contrato (corpo): Obrigatório. Introduza uma informação sobre o grupo de utilizadores que pretende adicionar a uma ligação de dados:
workflowCredentialType (cadeia de caracteres): obrigatório. Especifique o ID de um grupo de usuários que deseja adicionar a uma conexão de dados.
Exemplo de solicitação: cURL
Curl --location --REQUEST post 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/userGroups' --header 'Content-Type: Application/x-www-form-urlencoded' --header 'Authorization: BearerTokenGoesHere' --data-urlencode 'userGroupId 61decb225436c2210135336f'
Remover um usuário de um grupo de usuários
Para remover um usuário de uma conexão de dados do servidor, use o
{baseURL}endpoint DELETE /v3/serverDataConnections/{dataConnectionId}/users/{userId}
.
Parâmetros
workflowCredentialType (cadeia de caracteres): obrigatório. Introduza um ID de ligação de dados do servidor para especificar a ligação de dados que pretende atualizar.
workflowCredentialType (cadeia de caracteres): obrigatório. Introduza uma ID de utilizador que pretende remover da ligação de dados.
Exemplo de solicitação: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer token-bearer-aqui'
Remova um Grupo de Usuários de uma Conexão de Dados
Para remover um grupo de usuários de uma conexão de dados do servidor, use o
{baseURL}endpoint DELETE /v3/serverDataConnections/{dataConnectionId}/Usergroups/{userGroupId}
.
Parâmetros
workflowCredentialType (cadeia de caracteres): obrigatório. Introduza um ID de ligação de dados do servidor para especificar a ligação de dados que pretende atualizar.
workflowCredentialType (cadeia de caracteres): obrigatório. Introduza uma ID de grupo de utilizadores que pretende remover da ligação de dados.
Exemplo de solicitação: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer token-bearer-aqui'
Excluir uma conexão de dados
Para excluir um fluxo de trabalho específico, use o ponto de extremidade
DELETE {baseURL}/v3/workflows/{dataConnectionId}
.
Parâmetros
workflowCredentialType (cadeia de caracteres): obrigatório. Introduza um ID de ligação de dados do servidor para especificar a ligação de dados que pretende eliminar.
Exemplo de solicitação: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer token-bearer-aqui'
Relações de objetos
Não há referências para conexões de dados do servidor por enquanto. O benefício de ter as conexões de dados modificáveis é que você pode atribuir ou cancelar a atribuição de acesso a elas. Isso ajuda a integrar certas permissões às fontes de dados.
Exemplos de solicitações Postman
OBTENHA /v3/serverDataConnections
COLOQUE /v3/serverDataConnections/{dataConnectionId}
Para saber mais sobre solicitações Postman, visite a página de ajuda Como usar Postman .