Skip to main content

Puntos de conexión de DCM

Propiedades y puntos de conexión de DCM

Los puntos de conexión de DCM se dividen en dos grupos: puntos de conexión de DCM para usuarios y puntos de conexión de DCM para administradores. Todos los puntos de conexión de DCM 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.DCM - ServerAdministrador de conexiones de datos: Interfaz de usuario de Server

¿Qué es una conexión de DCM?

Una conexión de DCM se compone de sus propios parámetros y dos tipos de subobjetos: DataSource (siempre hay solo una) y Credentials (en situaciones comunes hay cero, una o dos credenciales. En raras ocasiones, podría haber aún más, la cantidad es específica del conector). Cada Credential tiene un credRole diferente dentro de la conexión. La API de DCM funciona en conexiones como objetos completos, incluidos DataSource y Credentials.

¿Cómo se relaciona un conector con una conexión de DCM?

Un conector es un fragmento de código que permite a Alteryx comunicarse con fuentes de datos externas. Cada conector requiere un conjunto específico de parámetros para establecer esta comunicación. Colectivamente, nos referimos a estos parámetros como una conexión de DCM. Los parámetros exactos admitidos por un conector se definen y se comunican a DCM a través de un esquema de DCM, que se identifica de forma única por su schemaName.

Un solo conector puede admitir varios métodos de autenticación o protocolos de comunicación, cada uno con su propio conjunto de parámetros. Como resultado, un conector puede registrar varios esquemas de DCM con diferentes valores de schemaName.

Un esquema de conexión está estructurado de la misma manera que otros objetos de DCM, que comprende un esquema de DataSource y esquemas de Credential. Esto significa que Connection.schemaName también determina qué DataSource.schemaName y Credential.schemaNames se deben utilizar dentro del objeto de conexión que se crea para ese esquema de conexión específico.

schemaNames para el conector ODBC a SQL Server

  • ODBC de Microsoft SQL Server sin DSN (Azure Active Directory integrada)

    schemaName: "database-odbc-mssql-adintegrated"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials: ninguna

  • ODBC de Microsoft SQL Server sin DSN (identidad de servicio administrada de Azure)

    schemaName: "database-odbc-mssql-admsi"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials:

      credRole: "main", schemaName: "azure_managed_identity"

  • ODBC de Microsoft SQL Server sin DSN (contraseña de Azure Active Directory)

    schemaName: "database-odbc-mssql-adpwd"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials:

      credRole: "main", schemaName: "username_password"

  • ODBC de Microsoft SQL Server sin DSN (entidad de servicio de Azure Active Directory)

    schemaName: "database-odbc-mssql-adsp"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials:

      credRole: "oatuhApplication", schemaName: "database-odbc-mssql-adsp"

  • ODBC de Microsoft SQL Server sin DSN (solo nombre de usuario)

    schemaName: "database-odbc-mssql-nopwd"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials:

      credRole: "main", schemaName: "username"

  • ODBC de Microsoft SQL Server sin DSN (Azure AD)

    schemaName: "database-odbc-mssql-oauth-azure-ayxapp"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials:

      credRole: "oauthTokens", schemaName: "database-ms-oauth-azure-ayxapp-tokens"

  • ODBC de Microsoft SQL Server sin DSN (Azure AD: privado)

    schemaName: "database-odbc-mssql-oauth-azure"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials:

      • credRole: "oauthApplication", schemaName: "database-ms-oauth-azure-application"

      • credRole: "oauthTokens", schemaName: "database-ms-oauth-azure-tokens"

  • ODBC de Microsoft SQL Server sin DSN (OAuth2 genérico)

    schemaName: "database-odbc-mssql-oauth-generic-configurable"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials:

      • credRole: "oauthApplication", schemaName: "generic-configurable-oauth-application"

      • credRole: "oauthTokens", schemaName: "generic-configurable-oauth-tokens"

  • ODBC de Microsoft SQL Server sin DSN (autenticación de Windows)

    schemaName: "database-odbc-mssql-winauth"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials: ninguna

  • ODBC de Microsoft SQL Server sin DSN (nombre de usuario y contraseña)

    schemaName: "database-odbc-mssql"

    • dataSource.schemaName: "database-odbc-mssql"

    • credentials:

      credRole: "main", schemaName: "username_password"

  • ODBC de Microsoft Analytics Platform System (sin credenciales)

    schemaName: "database-odbc-dsn-mssql-nocreds"

    • dataSource.schemaName: "database-odbc-dsn-mssql"

    • credentials: ninguna

  • ODBC de Microsoft SQL Server (solo nombre de usuario)

    schemaName: "database-odbc-dsn-mssql-nopwd"

    • dataSource.schemaName: "database-odbc-dsn-mssql"

    • credentials:

      credRole: "main", schemaName: "username"

  • ODBC de Microsoft SQL Server (Azure AD)

    schemaName: "database-odbc-dsn-mssql-oauth-azure-ayxapp"

    • dataSource.schemaName: "database-odbc-dsn-mssql"

    • credentials:

      credRole: "oauthTokens", schemaName: "database-ms-oauth-azure-ayxapp-tokens"

  • ODBC de Microsoft SQL Server (Azure AD: privado)

    schemaName: "database-odbc-dsn-mssql-oauth-azure"

    • dataSource.schemaName: "database-odbc-dsn-mssql"

    • credentials:

      • credRole: "oauthApplication", schemaName: "database-hana-oauth-azure-application"

      • credRole: "oauthTokens", schemaName: "database-hana-oauth-azure-tokens"

  • ODBC de Microsoft SQL Server (OAuth2 genérico)

    schemaName: "database-odbc-dsn-mssql-oauth-generic-configurable"

    • dataSource.schemaName: "database-odbc-dsn-mssql"

    • credentials:

      • credRole: "oauthApplication", schemaName: "generic-configurable-oauth-application"

      • credRole: "oauthTokens", schemaName: "generic-configurable-oauth-tokens"

  • ODBC de Microsoft SQL Server (nombre de usuario y contraseña)

    schemaName: "database-odbc-dsn-mssql"

    • dataSource.schemaName: "database-odbc-dsn-mssql"

    • credentials:

      credRole: "main", schemaName: "username_password"

Puntos de conexión de DCM para usuarios

Estos puntos de conexión los pueden utilizar usuarios con acceso a API:

Nota

  • Todos los puntos de conexión de la API devuelven datos de usuario individuales (cada usuario solo puede ver y administrar sus propias conexiones).

  • Todos los ejemplos están en PowerShell.

Obtener conexión

Para obtener un registro de conexión, 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, incluidas la fuente de datos y las credenciales relacionadas, así como la información para compartir.

Propiedades

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'

Obtener una conexión como se hace referencia en los flujos de trabajo

Para recuperar un registro de conexión 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, 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.

Propiedades

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'

Compartir conexión

Para compartir una conexión a fin de ejecutar 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.

Propiedades

  • 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 quieres 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 quieres 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"
    ]
  }'

Dejar de compartir conexión

Para dejar de compartir una conexión, utiliza el punto de conexión DELETE {baseURL}/v3/dcm/connections/{id}/sharing/execution.

Propiedades

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'

Crear o actualizar conexión

Para crear o actualizar una conexión, 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.

Propiedades

  • 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.

    Nota

    Hay varios “names” dentro de una conexión de DCM:

    • Connection.name: el nombre de la conexión. Los administradores interactúan con este nombre a través de la API.

    • Connection.dataSource.object.name: el nombre de la fuente de datos visible en la pestaña Fuentes de datos en la interfaz de usuario.

    • Connection.credentials.<credRole>.object.name: son los nombres de credenciales visibles en la pestaña de credenciales en la interfaz de usuario.

    Para obtener más información, consulta la sección ¿Qué es una conexión de DCM?.

  • schemaName (cadena): obligatorio. Este es el identificador de un esquema de DCM, que se utiliza para presentar y validar los parámetros asociados en la interfaz de usuario de DCM. Cada conector define su propio conjunto de esquemas de DCM compatibles. En el esquema de conexión seleccionado también se especifica qué esquemas de DataSource y Credential se deben utilizar para las secciones DataSource y Credential de la conexión. Para obtener más información, consulta ¿Qué es una conexión de DCM? y ¿Cómo se relaciona un conector con una conexión de DCM?

  • allowInSdks (boolean): opcional. Hace que la conexión sea accesible para las herramientas SDK de Python.

  • parameters (objeto): obligatorio. Esta propiedad contiene detalles de configuración específicos del esquema y de la tecnología a los que te conectas.

    Nota

    Hay varios objetos de parameters diferentes en una estructura de conexión de DCM, cada uno se utiliza en un contexto diferente:

    • Connection.parameters: para la conexión general (aún no es visible en la interfaz de usuario, próximamente)

    • Connection.dataSource.object.parameters: para la parte Fuente de datos de la conexión.

    • Connection.credentials.<credRole>.object.parameters: para cada rol de credencial.

    • Connection.credentials.<credRole>.object.secrets.<secretType>.parameters: para secretos de credenciales, por tipo de secreto.

    Cada objeto de parámetros tiene su propia estructura y campos obligatorios, que dependen de la tecnología y del schemaName definidos en esa parte de la conexión. Son independientes y pueden (y con frecuencia lo hacen) contener diferentes campos.

    La propiedad parameters es obligatoria, pero se puede proporcionar como objetos vacíos ({}) si no se necesitan parámetros para un esquema determinado.

    Sugerencia:

    Para determinar los campos correctos para cualquier objeto de parámetros:

    1. Crea una conexión de DCM en la interfaz de usuario de Alteryx Server para tu tecnología objetivo.

    2. Consulta la conexión a través de la API: GET /v3/dcm/connections/{id}

    3. Revisa la estructura y los campos devueltos para cada objeto de parameters en la respuesta.

    Esta es la forma más confiable de descubrir los campos necesarios y disponibles para tu fuente de datos o credencial específica.

    Debido a que los campos de parameters son específicos de la fuente de datos y las credenciales, un ejemplo completo para cada tecnología no es práctico en esta documentación. Utiliza el flujo de trabajo anterior para obtener ejemplos actualizados y específicos de la fuente.

  • 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 quieres 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. Para obtener una descripción detallada, consulta la propiedad de Connection.schemaName.

      • parameters (objeto): obligatorio. Parámetros para la parte de DataSource de la conexión. Consulta la propiedad de Connection.parameters para obtener más información. Proporciona un objeto vacío {} si no se necesitan parámetros.

  • credentials (objeto): obligatorio. Pares de valores clave de <credRole>: object. Los <credRole> se definen por el esquema de DCM seleccionado. El object tiene solo una propiedad llamada "object" que luego contiene todas las propiedades de las credenciales. Es posible que algunas conexiones no requieran credenciales, mientras que otras pueden tener varios objetos de credenciales anidados.

    En los siguientes ejemplos, puedes ver que la autenticación de nombre de usuario y contraseña de SQL Server (MSSQL) utiliza el <credRole> principal. La conexión de Redshift con autenticación de grupo de identidades y Snowflake con autenticación OAuth emplean oauthApplication y oauthTokens <credRoles> para sus credenciales.

    Para obtener más información, consulta ¿Qué es una conexión de DCM? y ¿Cómo se relaciona un conector con una conexión de DCM?

    • object (objeto): define las propiedades de las partes de credenciales de la conexión.

      • id (cadena): ingresa un Id. de credencial si quieres 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.

      • parameters (objeto): obligatorio. Parámetros para las partes de Credential de la conexión. Consulta la propiedad de Connection.parameters para obtener más información. Proporciona un objeto vacío {} si no se necesitan parámetros.

Ejemplo de solicitud: cURL

Crea una conexión de DCM de SQL Server con credenciales de nombre de usuario y contraseña (UserName-Password)

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": {}
            }
          }
        }
      }
    }
  }'

Crea una conexión de ODBC DCM a Redshift mediante la autenticación OAuth con AWS IAM/Cognito

curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' `
  --header 'Authorization: Bearer BearerTokenGoesHere' `
  --header 'Content-Type: application/json' `
  --data '{
    "name": "Connection Name",
    "schemaName": "database-odbc-redshift-simba-oauth-iam-identitypool",
    "allowInSdks": false,
    "parameters": {},
    "dataSource": {
        "object": {
            "name": "DataSource Name",
            "schemaName": "database-odbc-redshift-simba",
            "drvName": "Simba Amazon Redshift ODBC Driver",
            "host": "##### (my-database-host.redshift.amazonaws.com)",
            "parameters": {
                "allowSelfSignedServerCert": false,
                "checkCertRevocation": false,
                "database": "#####",
                "minTLS": 2,
                "port": 5439,
                "sslMmode": "require",
                "useSystemTrustStore": false
            }
        }
    },
    "credentials": {
        "oauthApplication": {
            "object": {
                "name": "Application Credential Name",
                "schemaName": "database-redshift-aws-oauth-iam-identitypool-application",
                "userName": "##### (Client Secret)",
                "parameters": {
                    "accountId": "#####",
                    "authorityURL": "##### (https://my-authorization-host.amazoncognito.com)",
                    "awsRegion": "##### (us-west-2)",
                    "dbUser": "#####",
                    "identityPoolId": "#####",
                    "redirectURI": "##### (http://localhost:5634)",
                    "userPoolId": "#####"
                },
                "secrets": {
                }
            }
        },
        "oauthTokens": {
            "object": {
                "name": "Tokens Credential Name",
                "schemaName": "aws-oauth-iam-identitypool-tokens",
                "parameters": {},
                "secrets": {
                }
            }
        }
    }
}'

Crea una conexión de DCM Snowflake con credenciales de cliente OAuth 2.0

curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' `
  --header 'Authorization: Bearer BearerTokenGoesHere' `
  --header 'Content-Type: application/json' `
  --data '{
    "name": "Connection Name",
    "schemaName": "database-odbc-snowflake-simba-oauth-generic-configurable",
    "allowInSdks": false,
    "parameters": {},
    "dataSource": {
        "object": {
            "name": "DataSource Name",
            "schemaName": "database-odbc-snowflake-simba",
            "drvName": "Simba Snowflake ODBC Driver",
            "host": "##### (my-domain.snowflakecomputing.com)",
            "parameters": {
                "database": "#####",
                "schema": "#####",
                "warehouse": "#####"
            }
        }
    },
    "credentials": {
        "oauthApplication": {
            "object": {
                "name": "Application Credential Name",
                "schemaName": "generic-configurable-oauth-application",
                "userName": "##### (Client Id)",
                "parameters": {
                    "clientAuthentication": "body",
                    "grantType": "clientCredentials",
                    "tokenURL": "#####"
                },
                "secrets": {
                    "clientSecret": {
                        "expiresOn": null,
                        "parameters": {},
                        "value": {
                            "text": "##### (Client Secret)"
                        }
                    }
                }
            }
        },
        "oauthTokens": {
            "object": {
                "name": "Tokens Credential Name",
                "schemaName": "generic-configurable-oauth-tokens",
                "userName": null,
                "parameters": {
                    "scope": "#####"
                },
                "secrets": {}
            }
        }
    }
}'

Eliminar conexión

Para eliminar una conexión, 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.

Propiedades

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 DCM para administradores

Puntos de conexión que pueden utilizar los administradores con acceso a API:

Nota

  • 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.

  • Todos los ejemplos están en PowerShell.

Obtener conexión

Para obtener un registro de conexión, utiliza el punto de conexión GET {baseURL}/v3/dcm/admin/connections/{objectId}.

Propiedades

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'

Lista de conexiones

Para obtener una lista de todos los registros de conexión presentes en Server, utiliza el punto de conexión GET {baseURL}/v3/dcm/admin/connections.

Propiedades

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'

Crear o actualizar una conexión en nombre del usuario

Para crear o actualizar un registro de conexión en nombre de un usuario, utiliza el punto de conexión POST {baseURL}/v3/dcm/admin/connections.

Propiedades

Utiliza las mismas propiedades que se describen en la sección Crear o actualizar conexión. La única propiedad adicional necesaria para este punto de conexión es ownerId.

ownerId (cadena): obligatorio.

  • Cuando se crea una conexión, se debe ingresar el Id. del usuario en nombre del cual se creará la conexión.

  • Cuando se actualiza una conexión, también se debe ingresar el ownerId incluso si no quieres cambiarlo. Para obtener más información sobre cómo obtener un ownerID, ve a Obtener conexión o Lista de conexiones.

Ejemplo de solicitud: cURL

curl --location --request POST 'https://localhost/webapi/v3/dcm/connections' `
  --header 'Authorization: Bearer BearerTokenGoesHere' `
  --header 'Content-Type: application/json' `
  --data '{
    "upsertConnectionContract": {
      "name": "MSSQL DEV Admin",
      "ownerId": "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": {}
              }
            }
          }
        }
      }
    }
  }'

Dejar de compartir una conexión compartida para ejecución

Para dejar de compartir una conexión cuyo tipo de uso compartido se definió como Compartido para ejecución, utiliza el punto de conexión DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/execution.

Propiedades

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'

Dejar de compartir una conexión compartida para colaboración

Para dejar de compartir una Conexión cuyo tipo de uso compartido se definió como Compartido para colaboración, utiliza el punto de conexión DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/collaboration.

Propiedades

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'

Eliminar conexión

Para eliminar un registro de conexión, 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.

Propiedades

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'

Obtener todas las reglas de manejo de conexiones

Para obtener todas las reglas de manejo de conexiones, utiliza el punto de conexión GET {baseURL}/v3/dcm/admin/connectionhandlingrules.

Ve a Manejo de conexiones de DCM para obtener más información.

Propiedades

No hay propiedades.

Ejemplo de solicitud: cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Obtener regla de manejo de conexiones

Para obtener una regla de manejo de conexiones de DCM específica, utiliza el punto de conexión GET {baseURL}/v3/dcm/admin/connectionhandlingrules/{id}.

Propiedades

id (cadena): obligatorio. Especifica el ID de la regla de manejo de conexión de DCM que debe devolverse.

Ejemplo de solicitud: cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules/{id}' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Agregar o actualizar una regla de manejo de conexiones

Para agregar una nueva regla de manejo de conexiones o actualizar una existente, utiliza el punto de conexión POST {baseURL}/v3/dcm/admin/connectionhandlingrules.

Propiedades

Ingresa las siguientes propiedades para crear o actualizar una regla de manejo de conexiones de DCM:

  • rule (cuerpo): obligatorio. La ConnectionHandlingRule de DCM que debe crearse o actualizarse.

    • id (cadena): opcional. El ID de la regla de manejo de conexión de DCM. Ingresa un ID de regla de manejo de conexión de DCM si deseas actualizar una regla de manejo de conexión existente. Omite este paso si deseas crear una nueva regla de manejo de conexión.

    • sourceConnectionId (cadena): ingresa un sourceConnectionId, con referencia a un ConnectionId que se reemplazará en la ejecución del flujo de trabajo. No es necesario que la conexión exista en el Server (los flujos de trabajo que hacen referencia a ella todavía se pueden ejecutar). No se puede utilizar en otra regla existente, ya sea una conexión fuente u objetivo.

    • sourceConnectionTitle (cadena): ingresa un nombre personalizado o una descripción de la conexión de origen.

    • targetConnectionId (cadena): ingresa un targetConnectionId. Debe hacer referencia a una conexión de DCM presente en el Server.

    • targetConnectionTitle (cadena): opcional. Ingresa un nombre personalizado o una descripción de la conexión de destino. Se completa automáticamente con el título de la conexión seleccionada.

Ejemplo de solicitud: cURL

curl --location 'https://localhost.com/webapi/v3/dcm/admin/connectionhandlingrules' `
--header 'Content-Type: application/json' `
--header 'Authorization: Bearer BearerTokenGoesHere' `
--data '{
    "sourceConnectionTitle": "MSSQL DEV",
    "sourceConnectionId": "c.cid.d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3",
    "targetConnectionId": "c.cid.cbf55382-f90b-4304-a1cd-37c5cff697e0"
}'

Eliminar la regla de manejo de conexiones

Para eliminar una regla de manejo de conexiones existente, utiliza el punto de conexión DELETE {baseURL}/v3/dcm/admin/connectionhandlingrules/{id}.

Propiedades

id (cadena): obligatorio. Especifica el ID de la regla de manejo de conexión de DCM que deseas eliminar.

Ejemplo de solicitud: 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, 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:

Administrador:

En esta sección: