Puntos de conexión de DCME
Puntos de conexión y parámetros de DCME
Los puntos de conexión de DCME se dividen en dos grupos: puntos de conexión de DCME para usuarios y puntos de conexión de DCME para administradores . Todos los puntos de conexión de DCME requieren que se configure TLS en 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 las páginas de ayuda de DCM: Server y Administrador de conexiones de datos: interfaz de usuario de Server .
Puntos de conexión de DCME para usuarios
Estos puntos de conexión los pueden utilizar usuarios con acceso a API:
Todos los puntos de conexión de la API devuelven datos de usuario individuales (cada usuario solo puede ver y administrar sus propias conexiones).
Para recuperar un registro de conexión de DCM, utiliza el punto de conexión GET {baseURL}/v3/dcm/connections/{id} . El punto de conexión devuelve toda la información sobre la conexión de DCM, incluidas la fuente de datos y las credenciales relacionadas, así como la información para compartir.
Parámetros
id (cadena): obligatorio. Ingresa el ID de la conexión de DCM acerca de la cual deseas obtener información.
Ejemplo de solicitud: cURL
curl --location --request GET 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Para recuperar un registro de conexión de DCM tal como se hace referencia en los flujos de trabajo, utiliza el punto de conexión GET {baseURL}/v3/dcm/connections/lookup . El punto de conexión devuelve toda la información sobre la conexión de DCM, incluidas la fuente de datos y las credenciales relacionadas, así como la información para compartir.
Nota
El ConnectionID utilizado en este punto de conexión es diferente del ID utilizado en otros puntos de conexión de DCM. El ID se utiliza para hacer referencia a varios objetos DCM, mientras que ConnectionID solo se utiliza en flujos de trabajo para hacer referencia a la conexión de DCM de usuarios específicos.
Parámetros
connectionId (cadena): obligatorio. Ingresa el ConnectionID de DCM acerca del cual deseas obtener información.
Ejemplo de solicitud: cURL
curl --location --request GET 'https://localhost/webapi/v3/dcm/connections/lookup?connectionId=d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Para compartir una conexión de DCM para la ejecución de Server con usuarios o grupos específicos, utiliza el punto de conexión PUT {baseURL}/v3/dcm/connections/{id}/sharing/execution .
Nota
Como este es un punto de conexión PUT, sobrescribe el uso compartido existente, en lugar de agregar usuarios o grupos de usuarios adicionales a la lista existente. La lista proporcionada de usuarios y grupos no puede estar vacía; para quitar el uso compartido existente, utiliza el punto de conexión DELETE.
Parámetros
id (cadena): obligatorio. Ingresa el ID de conexión de DCM que deseas compartir con otros usuarios o grupos.
sharingContract (cuerpo): obligatorio. Para actualizar el uso compartido de la ejecución, se requiere el parámetro sharingContract. Ambas matrices son necesarias, pero solo una se puede dejar vacía.
userIds (matriz de cadena): ingresa una lista de todos los ID de usuario con los que deseas compartir la conexión. Deja una matriz vacía si no hay usuarios con los que compartir (solo grupos de usuarios).
userGroupIds (matriz de cadena): ingresa una lista de todos los ID de grupo de usuarios con los que compartir la conexión. Deja una matriz vacía si no hay grupos de usuarios con los que compartir (solo usuarios).
Ejemplo de solicitud: cURL
curl --location --request PUT 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/execution' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --header "Content-Type: application/json" \ --data '{"userIds": ["61d57bea3c15317e1a48205b", "61d564361d6d5da7ad461a32"],"userGroupIds": ["d5da7ad4"]}'
Para dejar de compartir una conexión de DCM, utiliza el punto de conexión DELETE {baseURL}/v3/dcm/connections/{id}/sharing/execution .
Parámetros
id (cadena): obligatorio. Ingresa el ID de conexión de DCM que deseas dejar de compartir de todos los usuarios y grupos.
Ejemplo de solicitud: cURL
curl --location --request DELETE 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/execution' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Para crear o actualizar una conexión de DCM, utiliza el punto de conexión POST {baseURL}/v3/dcm/connections .
Un punto de conexión único sirve tanto para crear como actualizar funciones, diferenciadas en función de si los ID de objeto se incluyen en la solicitud. La reutilización de fuentes de datos o credenciales existentes no se admite actualmente cuando se crean nuevas conexiones.
Parámetros
upsertConnectionContract (cadena): obligatorio. La conexión de DCM es una combinación de una fuente de datos (que describe el host de la instancia objetivo) y credenciales (por ejemplo, nombre de usuario y contraseña) mediante la definición de la posible combinación de esquemas.
id (cadena): opcional. Ingresa un ID de conexión si deseas actualizar una conexión existente. Omite este paso si deseas crear una nueva conexión.
name (cadena): obligatorio. Ingresa el nombre de tu conexión.
schemaName (cadena): obligatorio. Ingresa un nombre de esquema de conexión que te gustaría usar. El esquema define los parámetros necesarios de la conexión, así como los esquemas de fuentes de datos y credenciales que se permiten utilizar para esa conexión.
allowInSdks (booleano): opcional.
parameters (objeto): obligatorio. Es posible que se requieran varios parámetros en función del schemaName seleccionado.
dataSource (objeto): obligatorio. La fuente de datos utilizada para la conexión, que describe el host de instancia de fuente de datos y parámetros adicionales, como se ve en la interfaz de usuario de DCM.
object (objeto): obligatorio.
id (cadena): ingresa un ID de fuente de datos si deseas actualizar una conexión existente. Omite este paso si deseas crear una nueva conexión. El uso de una fuente de datos existente cuando se crean nuevas conexiones no está disponible actualmente.
name (cadena): obligatorio. Ingresa un nombre para la fuente de datos.
schemaName (cadena): obligatorio. Ingresa el nombre del esquema de la fuente de datos seleccionada.
parámetros adicionales específicos del esquema : dependiendo del esquema utilizado, se te pedirá que proporciones parámetros adicionales de fuente de datos.
credentials (cadena): opcional, en función del schemaName seleccionado en el upsertConnectionContract. Es posible que algunas conexiones no requieran credenciales, mientras que otras pueden tener múltiples objetos anidados (ranuras).
main (objeto): opcional (ver arriba). Este main es solo un nombre de ranura de credencial (más común). Sin embargo, puede nombrarse de manera diferente o puede haber múltiples ranuras de credenciales para la conexión en función de lo que se define en el esquema de conexión.
id (cadena): ingresa un ID de credencial si deseas actualizar una conexión existente. Omite este paso si deseas crear una nueva conexión. El uso de una credencial existente cuando se crean nuevas conexiones no está disponible actualmente.
name (cadena): obligatorio. Ingresa el nombre de tu credencial.
schemaName (cadena): obligatorio. Ingresa el nombre del esquema de la credencial seleccionada.
parámetros adicionales específicos del esquema : dependiendo del esquema utilizado, se te pedirá que proporciones parámetros adicionales de fuente de datos.
Ejemplo de solicitud: cURL
curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --header "Content-Type: application/json" \ --data '{"Name":"MSSQL DEV Admin","SchemaName":"database-odbc-dsn-mssql","Parameters":{},"DataSource":{"object":{"name":"SQL Server DEV","SchemaName":"database-odbc-dsn-mssql","parameters":{"dsn":"sql server"}}},"Credentials":{"main":{"object":{"name":"SQL Server Admin Credentials","SchemaName":"username_password","parameters":{},"userName":"admin","secrets":{"password":{"value":{"text":"password"},"Parameters":{}}}}}}}'
Para eliminar una conexión de DCM, utiliza el punto de conexión DELETE {baseURL}/v3/dcm/connections/{id} . La fuente de datos y las credenciales también se eliminarán, a menos que se utilicen en cualquier otra conexión.
Parámetros
id (cadena): obligatorio. Ingresa el ID de conexión de DCM que deseas eliminar.
Ejemplo de solicitud: cURL
curl --location --request DELETE 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Puntos de conexión de DCME para administradores
Puntos de conexión que pueden utilizar los administradores con acceso a API:
Todos los puntos de conexión de la API de administración devuelven todos los datos disponibles en Server en todos los usuarios, independientemente de la propiedad.
Para recuperar un registro de conexión de DCM, utiliza el punto de conexión GET {baseURL}/v3/dcm/admin/connections/{objectId} .
Parámetros
objectId (cadena): obligatorio. Ingresa el ID de conexión de DCM acerca del cual deseas obtener información.
Ejemplo de solicitud: cURL
curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Para recuperar una lista de todos los registros de conexión de DCM presentes en Server, utiliza el punto de conexión GET {baseURL}/v3/dcm/admin/connections .
Parámetros
Ambos parámetros son filtros que se pueden combinar. Si se utiliza connectionId y visibleBy en conjunto, se devolverá la conexión con ConnectionID especificado, visible por el usuario especificado.
connectionId (cadena): opcional. Filtra las conexiones en función de su connectionID, como se hace referencia desde un flujo de trabajo. Se pueden devolver múltiples conexiones para un único connectionID si la conexión se comparte para colaboración.
visibleBy (cadena): opcional. Ingresa el ID de usuario. Si está presente, filtra los resultados al mismo resultado que para todas las conexiones disponibles para el usuario especificado.
Ejemplo de solicitud: cURL
curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connections?connectionId=d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3&visibleBy=bc7cb7b47c33' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Para crear o actualizar un registro de conexión de DCM en nombre de un usuario, utiliza el punto de conexión POST {baseURL}/v3/dcm/admin/connections .
Parámetros
upsertConnectionContract (cadena): obligatorio.
id (cadena): opcional. Ingresa un ID de conexión si deseas actualizar una conexión existente. Omite este paso si deseas crear una nueva conexión.
ownerId (cadena): obligatorio.
Cuando se crea una Conexión de DCM, se debe ingresar el ID del usuario en nombre del cual se creará la conexión.
Cuando se actualiza una Conexión de DCM, también se debe ingresar el ownerId incluso si no deseas cambiarlo. Para obtener más información sobre cómo obtener un ownerID, ve a Recuperar un registro de Conexión de DCM o Recuperar una lista de registros de Conexión de DCM .
name (cadena): obligatorio. Ingresa el nombre de tu conexión.
schemaName (cadena): obligatorio. Ingresa un nombre de esquema de conexión que te gustaría usar. El esquema define los parámetros necesarios de la conexión, así como los esquemas de fuentes de datos y credenciales que se permiten utilizar para esa conexión.
allowInSdks (booleano): opcional.
parameters (objeto): obligatorio. Es posible que se requieran varios parámetros en función del schemaName seleccionado.
dataSource (objeto): obligatorio. La fuente de datos utilizada para la conexión
object (objeto): obligatorio.
id (cadena): ingresa un ID de fuente de datos si estás actualizando una conexión existente. Omite este paso si deseas crear una nueva conexión. El uso de una fuente de datos existente cuando se crean nuevas conexiones no está disponible actualmente.
name (cadena): obligatorio. Ingresa un nombre para la fuente de datos.
schemaName (cadena): obligatorio. Ingresa el nombre del esquema de la fuente de datos seleccionada.
parámetros adicionales específicos del esquema : dependiendo del esquema utilizado, se te pedirá que proporciones parámetros adicionales de fuente de datos.
credentials (cadena): opcional, en función del schemaName seleccionado en el upsertConnectionContract. Es posible que algunas conexiones no requieran ninguna credencial, mientras que otras pueden tener múltiples.
main (objeto): opcional (ver arriba).
id (cadena): ingresa un ID de credencial si estás actualizando una conexión existente. Omite este paso si deseas crear una nueva conexión. El uso de una credencial existente cuando se crean nuevas conexiones no está disponible actualmente.
name (cadena): obligatorio. Ingresa el nombre de tu credencial.
schemaName (cadena): obligatorio. Ingresa el nombre del esquema de la credencial seleccionada.
parámetros adicionales específicos del esquema : en función del esquema utilizado, se te pedirá que proporciones parámetros de credenciales adicionales.
Ejemplo de solicitud: cURL
curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --header "Content-Type: application/json" \ --data '{"Name":"MSSQL DEV Admin","onwerId":"1b4bc56d489d9543a",SchemaName":"database-odbc-dsn-mssql","Parameters":{},"DataSource":{"object":{"name":"SQL Server DEV","SchemaName":"database-odbc-dsn-mssql","parameters":{"dsn":"sql server"}}},"Credentials":{"main":{"object":{"name":"SQL Server Admin Credentials","SchemaName":"username_password","parameters":{},"userName":"admin","secrets":{"password":{"value":{"text":"password"},"Parameters":{}}}}}}}'
Para dejar de compartir una conexión de DCM cuyo tipo de uso compartido se ha definido como Compartido para la ejecución, utiliza el punto de conexión DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/execution.
Parámetros
objectId (cadena): obligatorio. Ingresa el ID de Conexión de DCM que no se compartirá para la ejecución.
Ejemplo de solicitud: cURL
curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/execution' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Para dejar de compartir una Conexión de DCM cuyo tipo de uso compartido se ha definido como Compartido para la colaboración, utiliza el punto de conexión DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/collaboration .
Parámetros
objectId (cadena): obligatorio. Ingresa el ID de conexión de DCM que no se compartirá para la colaboración.
Ejemplo de solicitud: cURL
curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/collaboration' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Para eliminar un registro de Conexión de DCM, utiliza el punto de conexión DELETE {baseURL}/v3/dcm/admin/connections/{objectId} . La fuente de datos y las credenciales también se eliminarán, a menos que se utilicen en cualquier otra conexión.
Parámetros
objectId (cadena): obligatorio. Ingresa el ID de conexión de DCM que deseas eliminar.
Ejemplo de solicitud: cURL
curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' \ --header 'Authorization: Bearer BearerTokenGoesHere'
To retrieve all DCM Connection handling rules, use the GET {baseURL}/v3/dcm/admin/connectionhandlingrules endpoint.
Go to DCM Connection Handling for more information.
Parameters
No parameters.
Request Example: cURL
curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules \ --header 'Authorization: Bearer BearerTokenGoesHere'
To retrieve a single specific DCM Connection handling rule, use the GET {baseURL}/v3/dcm/admin/connectionhandlingrules/{id} endpoint.
Parameters
id (string): Required. Specify the ID of the DCM connection handling rule to return.
Request Example: cURL
curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules/{id} \ --header 'Authorization: Bearer BearerTokenGoesHere'
To add a new DCM Connection handling rule or update an existing one, use the POST {baseURL}/v3/dcm/admin/connectionhandlingrules endpoint.
Paramaters
Enter the following parameters to create or update a DCM connection handling rule:
rule (body): Required. The DCM ConnectionHandlingRule to create or update.
id (string): Optional. The DCM connection handling rule ID. Enter a DCM connection handling rule ID if you wish to update an existing connection handling rule. Skip if you wish to create a new connection handling rule.
sourceConnectionId (string): Enter a sourceConnectionId, referencing a ConnectionId to be replaced at workflow execution. The Connection doesn’t have to exist on the Server (workflows referencing it can still be executed). It can’t be used in another existing rule, be it as a source connection or target connection.
sourceConnectionTitle (string): Enter a custom name or description of the source connection.
targetConnectionId (string): Enter a targetConnectionId. Must be referencing a DCM connection present on the Server.
targetConnectionTitle (string): Enter a custom name or description of the target connection.
Request Example: cURL
curl --location --request POST 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules/{id} \ --header 'Authorization: Bearer BearerTokenGoesHere'
To delete an existing DCM connection handling rule, use the DELETE {baseURL}/v3/dcm/admin/connectionhandlingrules/{id} endpoint.
Parameters
id (string): Required. Specify the DCM connection handling rule ID you want to delete.
Request Example: cURL
curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules/{id} \ --header 'Authorization: Bearer BearerTokenGoesHere'
Relaciones entre objetos
Si creas una conexión de DCM, puedes utilizar los objetos creados de la siguiente manera:
Objeto creado:
“ id ” (por ejemplo, “id”: “c128cc5fca-86cc-4e7e-93a3-d500cca9a3f3”)
“ connectionId ” (por ejemplo, “id”: “c0332423423-86cc-4e7e-93a3-d500cca9a3f3”)
Puedes usarlo como:
id si deseas recuperar un registro de Conexión de DCM
connectionId si deseas recuperar una Conexión de DCM como se hace referencia en Flujos de trabajo
id si deseas compartir una Conexión de DCM con usuarios y grupos especificados
id si deseas actualizar una Conexión de DCM
id si deseas eliminar una Conexión de DCM
id si deseas dejar de compartir una Conexión de DCM
Administrador :
id si deseas recuperar un registro de Conexión de DCM
ownerId (userId) si deseas crear una Conexión de DCM en nombre de un usuario
id si deseas actualizar una Conexión de DCM en nombre de un usuario
id si deseas dejar de compartir una Conexión de DCM compartida para la ejecución
id si deseas dejar de compartir una Conexión de DCM compartida para la colaboración
id si deseas eliminar una Conexión de DCM