Puntos de conexión de Server
Parámetros y puntos de conexión de las conexiones de Server
Para obtener más información sobre las relaciones entre objetos y cómo utilizarlas en la API, ve a la sección Relaciones entre objetos .
Para obtener más información sobre las conexiones de datos, visita la página de ayuda Conexiones de datos .
Recuperar todos los registros de conexión de datos
Para obtener información sobre todos los registros de conexiones de datos de Server, utiliza el punto de conexión
GET {baseURL}/v3/serverDataConnections
.
Parámetros
view (cadena): opcional. Se puede dejar sin un valor. Puedes elegir entre los siguientes valores: “Default" (predeterminado) y "Full" (completo). Si este parámetro se define como “Default" (predeterminado), entonces se devolverá un objeto de vista reducida. Cuando no se especifica, se utiliza el valor “Default" (predeterminado).
Ejemplo de solicitud: cURL
curl --location --request GET 'http://localhost/webapi/v3/serverDataConnections' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Recuperar un registro de conexión de datos específico
Para recuperar información acerca de una conexión de datos de Server específica, utiliza el punto de conexión
GET {baseURL}/v3/serverDataConnections /{dataConnectionId}
.
Parámetros
dataConnectionId (cadena): obligatorio. Ingresa un ID de conexión de datos de Server para obtener información sobre una conexión de datos específica.
Ejemplo de solicitud: cURL
curl --location --request GET 'http://localhost/webapi/v3/serverDataConnections/61dec3bc536c221013530fa' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Actualizar una conexión de datos existente
Para cambiar el
nombre
de una conexión de datos, utiliza el punto de conexión
PUT {baseURL}/v3/serverDataConnections/{dataConnectionId}
.
Parámetros
dataConnectionId (cadena): obligatorio. Ingresa un ID de conexión de datos de Server para especificar la conexión de datos que deseas actualizar.
updateServerConnectionContract (cuerpo): obligatorio. Ingresa un nuevo nombre para una conexión de datos:
name (cadena): obligatorio. Ingresa el nuevo nombre de la conexión de datos.
Ejemplo de solicitud: 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'
Agregar un usuario a una conexión de datos
Para agregar un usuario a una conexión de datos de Server, utiliza el punto de conexión
POST {baseURL}/v3/serverDataConnections/{dataConnectionId}/users
.
Parámetros
dataConnectionId (cadena): obligatorio. Ingresa un ID de conexión de datos de Server para especificar la conexión de datos a la que deseas agregar un usuario.
contract (cuerpo): obligatorio. Ingresa información sobre el usuario que quieres agregar a una conexión de datos:
userId (cadena): obligatorio. Especifica el ID de un usuario que desees agregar a una conexión de datos.
Ejemplo de solicitud: 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'
Agregar un grupo de usuarios a una conexión de datos
Para agregar un grupo de usuarios a una conexión de datos de Server, utiliza el punto de conexión
POST {baseURL}/v3/serverDataConnections/{dataConnectionId}/userGroups
.
Parámetros
dataConnectionId (cadena): obligatorio. Ingresa un ID de conexión de datos de Server para especificar la conexión de datos a la que deseas agregar un grupo de usuarios.
contract (cuerpo): obligatorio. Ingresa información sobre el grupo de usuarios que deseas agregar a una conexión de datos:
userGroupId (cadena): obligatorio. Especifica el ID de un grupo de usuarios que deseas agregar a una conexión de datos.
Ejemplo de solicitud: 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'
Quitar un usuario de una conexión de datos
Para quitar un usuario de una conexión de datos de Server, utiliza el punto de conexión
DELETE {baseURL}/v3/serverDataConnections/{dataConnectionId}/users/{userId}
.
Parámetros
dataConnectionId (cadena): obligatorio. Ingresa un ID de conexión de datos de Server para especificar la conexión de datos que deseas actualizar.
userId (cadena): obligatorio. Ingresa un ID de usuario que desees quitar de la conexión de datos.
Ejemplo de solicitud: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/users/61dec95f5436c22101353193' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Quitar un grupo de usuarios de una conexión de datos
Para quitar un grupo de usuarios de una conexión de datos de Server, utiliza el punto de conexión
DELETE {baseURL}/v3/serverDataConnections/{dataConnectionId}/userGroups/{userGroupId}
.
Parámetros
dataConnectionId (cadena): obligatorio. Ingresa un ID de conexión de datos de Server para especificar la conexión de datos que deseas actualizar.
userGroupId (cadena): obligatorio. Ingresa un ID de grupo de usuarios que desees quitar de la conexión de datos.
Ejemplo de solicitud: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/userGroups/61decb225436c2210135336f' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Eliminar una conexión de datos
Para eliminar una conexión de datos de Server específica, utiliza el punto de conexión
DELETE {baseURL}/v3/serverDataConnections/{dataConnectionId}
.
Parámetros
dataConnectionId (cadena): obligatorio. Ingresa un ID de conexión de datos de Server para especificar la conexión de datos que deseas eliminar.
Ejemplo de solicitud: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Relaciones entre objetos
No hay referencias para las conexiones de datos de Server por ahora. El beneficio de tener las conexiones de datos modificables es que puedes asignar o anular el acceso a estas. Esto ayuda a incorporar ciertos permisos a fuentes de datos.
Ejemplos de solicitudes de Postman
GET /v3/serverDataConnections
PUT /v3/serverDataConnections/{dataConnectionId}
Para obtener más información sobre las solicitudes de Postman, visita la página de ayuda Cómo utilizar Postman.