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 objetos .
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
Para recuperar todos os registros de conexões de dados do Server acessíveis, use o ponto de extremidade
GET {baseURL}/v3/serverDataConnections
.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Parâmetros
view (cadeia de caracteres): opcional. Pode ser deixado sem um valor. Você pode escolher 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/serverDataConnections' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Recuperar um registro de conexão de dados específico
Para recuperar detalhes sobre uma conexão de dados do Server existente, use o ponto de extremidade
GET {baseURL}/v3/serverDataConnections /{dataConnectionId}
.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Parâmetros
dataConnectionId (cadeia de caracteres): obrigatório. Insira um ID de conexão de dados do Server para obter as informações sobre uma conexão de dados específica.
Exemplo de solicitação: cURL
curl --location --request GET 'http://localhost/webapi/v3/serverDataConnections/61dec3bc536c221013530fa' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Atualizar uma conexão de dados existente
Para atualizar o
nome
de uma conexão de dados do Server existente, use o ponto de extremidade
PUT {baseURL}/v3/serverDataConnections/{dataConnectionId}
.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Parâmetros
dataConnectionId (cadeia de caracteres): obrigatório. Insira um ID de conexão de dados do Server para especificar a conexão de dados que deseja atualizar.
updateServerConnectionContract (corpo): obrigatório. Insira um novo nome para uma conexão de dados:
name (cadeia de caracteres): obrigatório. Insira o novo nome da conexão de dados.
Exemplo de solicitação: cURL
curl --location --request PUT 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c21013530fa' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Oracle DB Connection'
Compartilhar uma conexão de dados do Server com um usuário
Para compartilhar uma conexão de dados do Server existente com um usuário existente, use o ponto de extremidade
POST {baseURL}/v3/serverDataConnections/{dataConnectionId}/users
.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Parâmetros
dataConnectionId (cadeia de caracteres): obrigatório. Insira um ID de conexão de dados do Server para especificar a conexão de dados à qual deseja adicionar um usuário.
contract (corpo): obrigatório. Insira uma informação sobre o usuário que você deseja adicionar a uma conexão de dados:
userId (cadeia de caracteres): obrigatório. Especifique o ID de um usuário que você deseja adicionar a uma conexão de dados.
Exemplo de solicitação: cURL
curl --location --request POST 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/users' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'userId=61dec95f5436c22101353193'
Compartilhar uma conexão de dados do Server com um grupo de usuários
Para compartilhar uma conexão de dados do Server existente com um grupo de usuários existente, use o ponto de extremidade
POST {baseURL}/v3/serverDataConnections/{dataConnectionId}/userGroups
.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Parâmetros
dataConnectionId (cadeia de caracteres): obrigatório. Insira um ID de conexão de dados do Server para especificar a conexão de dados à qual adicionar um grupo de usuários.
contract (corpo): obrigatório. Insira uma informação sobre o grupo de usuários que você deseja adicionar a uma conexão de dados:
userGroupId (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: Bearer BearerTokenGoesHere' \ --data-urlencode 'userGroupId=61decb225436c2210135336f'
Remover as permissões de um usuário para usar uma conexão de dados do Server
Para remover as permissões de um usuário para usar uma conexão de dados do Server existente, use o ponto de extremidade
DELETE {baseURL}/v3/serverDataConnections/{dataConnectionId}/users/{userId}
.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Parâmetros
dataConnectionId (cadeia de caracteres): obrigatório. Insira um ID de conexão de dados do Server para especificar a conexão de dados que deseja atualizar.
userId (cadeia de caracteres): obrigatório. Insira o ID do usuário que deseja remover da conexão de dados.
Exemplo de solicitação: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/users/61dec95f5436c22101353193' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Remover as permissões de um grupo de usuários para usar uma conexão de dados do Server
Para remover as permissões de um grupo de usuários para usar uma conexão de dados do Server existente, use o ponto de extremidade
DELETE {baseURL}/v3/serverDataConnections/{dataConnectionId}/userGroups/{userGroupId}
.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Parâmetros
dataConnectionId (cadeia de caracteres): obrigatório. Insira um ID de conexão de dados do Server para especificar a conexão de dados que deseja atualizar.
userGroupId (cadeia de caracteres): obrigatório. Insira o ID do grupo de usuários que deseja remover da conexão de dados.
Exemplo de solicitação: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/userGroups/61decb225436c2210135336f' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Excluir uma conexão de dados do Server
Para excluir uma conexão de dados do Server existente, use o ponto de extremidade
DELETE {baseURL}/v3/serverDataConnections/{dataConnectionId}
.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Parâmetros
dataConnectionId (cadeia de caracteres): obrigatório. Insira um ID de conexão de dados do Server para especificar a conexão de dados que deseja excluir.
Exemplo de solicitação: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Relações de objetos
Não há referências para conexões de dados do Server 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 determinadas permissões às fontes de dados.
Exemplos de solicitações Postman
GET /v3/serverDataConnections
PUT /v3/serverDataConnections/{dataConnectionId}
Para saber mais sobre solicitações Postman, visite a página de ajuda Como usar o Postman.