Skip to main content

Pontos de extremidade do DCM

Pontos de extremidade do DCM e propriedades

Os pontos de extremidade do DCM são divididos em dois grupos: pontos de extremidade do DCM para usuários e pontos de extremidade do DCM para administradores. Todos os pontos de extremidade do DCM exigem que o TLS seja configurado no Server.

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 as páginas de ajuda DCM – Server e Gerenciador de Conexões de Dados: IU do Server.DCM - ServerGerenciador de Conexões de Dados: IU do Server

O que é uma conexão do DCM?

Uma conexão do DCM é composta por seus próprios parameters e dois tipos de subobjetos: DataSource (há sempre apenas uma) e Credentials (em cenários comuns, há zero, uma ou duas credenciais. Em casos raros, pode haver ainda mais, o número é específico do conector). Cada Credential tem uma credRole diferente dentro da conexão. A API do DCM funciona em conexões como objetos inteiros, incluindo DataSource e Credentials.

Como um conector está relacionado a uma conexão do DCM?

Um conector é um pedaço de código que permite que o Alteryx se comunique com fontes de dados externas. Cada conector requer um conjunto específico de parâmetros para estabelecer a comunicação. Coletivamente, referimos-nos a esses parâmetros como uma "Conexão do DCM". Os parâmetros exatos compatíveis com um conector são definidos e comunicados ao DCM por meio de um esquema do DCM, que é identificado de forma exclusiva por seu schemaName.

Um único conector pode ser compatível com múltiplos métodos de autenticação ou protocolos de comunicação, cada um com seu próprio conjunto de parâmetros. Como resultado, um conector poderá registrar múltiplos esquemas do DCM com diferentes valores de schemaName.

Um esquema de conexão é estruturado da mesma maneira que outros objetos do DCM, compreendendo tanto um esquema de DataSource quanto esquemas de Credential. Isso significa que o "Connection.schemaName" também determina quais DataSource.schemaName e Credential.schemaNames devem ser usados dentro do objeto de conexão que é criado para esse esquema de conexão específico.

schemaNames do conector do ODBC para SQL Server

  • ODBC do Microsoft SQL Server sem DSN (autenticação integrada do Azure Active Directory)

    schemaName: "database-odbc-mssql-adintegrated"

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

    • credentials: nenhuma

  • ODBC do Microsoft SQL Server sem DSN (identidade de serviço gerenciada do Azure)

    schemaName: "database-odbc-mssql-admsi"

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

    • credentials:

      credRole: "main", schemaName: "azure_managed_identity"

  • ODBC do Microsoft SQL Server sem DSN (senha do Azure Ative Directory)

    schemaName: "database-odbc-mssql-adpwd"

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

    • credentials:

      credRole: "main" (principal) , schemaName: "username_password"

  • ODBC do Microsoft SQL Server sem DSN (entidade de serviço do Azure Active Directory)

    schemaName: "database-odbc-mssql-adsp"

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

    • credentials:

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

  • ODBC do Microsoft SQL Server sem DSN (somente nome de usuário)

    schemaName: "database-odbc-mssql-nopwd"

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

    • credentials:

      credRole: "main" (principal) , schemaName: "username"

  • ODBC do Microsoft SQL Server sem 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 do Microsoft SQL Server sem 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 do Microsoft SQL Server sem 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 do Microsoft SQL Server sem DSN (autenticação do Windows)

    schemaName: "database-odbc-mssql-winauth"

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

    • credentials: nenhuma

  • ODBC do Microsoft SQL Server sem DSN (nome de usuário e senha)

    schemaName: "database-odbc-mssql"

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

    • credentials:

      credRole: "main" (principal) , schemaName: "username_password"

  • ODBC do Microsoft SQL Server (sem credenciais)

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

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

    • credentials: nenhuma

  • ODBC do Microsoft SQL Server (somente nome de usuário)

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

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

    • credentials:

      credRole: "main" (principal) , schemaName: "username"

  • ODBC do 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 do 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 do 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 do Microsoft SQL Server (nome de usuário e senha)

    schemaName: "database-odbc-dsn-mssql"

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

    • credentials:

      credRole: "main" (principal) , schemaName: "username_password"

Pontos de extremidade do DCM para usuários

Esses pontos de extremidade podem ser usados por usuários com acesso à API:

Nota

  • Todos os pontos de extremidade de API retornam dados individuais do usuário (cada usuário só pode ver e gerenciar suas próprias conexões).

  • Todos os exemplos estão no PowerShell.

Obter conexão

Para obter um registro de conexão, use o ponto de extremidade GET {baseURL}/v3/dcm/connections/{id}. O ponto de extremidade retorna todas as informações sobre a conexão, incluindo a fonte de dados e as credenciais relacionadas, bem como as informações de compartilhamento.

Propriedades

id (cadeia de caracteres): obrigatório. Insira o ID da conexão do DCM sobre a qual deseja obter informações.

Exemplo de solicitação: cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Obter conexão como referenciada em fluxos de trabalho

Para obter um registro de conexão como ela é referenciada em fluxos de trabalho, use o ponto de extremidade GET {baseURL}/v3/dcm/connections/lookup. O ponto de extremidade retorna todas as informações sobre a conexão, incluindo a fonte de dados e as credenciais relacionadas, bem como as informações de compartilhamento.

Nota

O ConnectionID usado nesse ponto de extremidade é diferente do ID usado em outros pontos de extremidade do DCM. O ID é usado para referenciar vários objetos do DCM, enquanto o ConnectionID é usado apenas em fluxos de trabalho para referenciar a conexão do DCM para usuários específicos.

Propriedades

connectionId (cadeia de caracteres): obrigatório. Insira o ConnectionID do DCM sobre o qual deseja obter informações.

Exemplo de solicitação: cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/connections/lookup?connectionId=d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Compartilhar conexão

Para compartilhar uma conexão para execução do Server com usuários ou grupos especificados, use o ponto de extremidade PUT {baseURL}/v3/dcm/connections/{id}/sharing/execution.

Nota

Como esse é um ponto de extremidade PUT, ele substitui o compartilhamento existente em vez de adicionar usuários ou grupos de usuários adicionais à lista existente. A lista de usuários e grupos fornecida não pode estar vazia. Para remover o compartilhamento existente, use o ponto de extremidade DELETE.

Propriedades

  • id (cadeia de caracteres): obrigatório. Insira o ID da conexão do DCM que deseja compartilhar com outros usuários ou grupos.

  • sharingContract (corpo): obrigatório. Para atualizar o compartilhamento de execução, o parâmetro "sharingContract" é obrigatório. Ambas as matrizes são obrigatórias, e apenas uma pode ser deixada vazia.

    • userIds (matriz de cadeia de caracteres): insira uma lista de todos os IDs de usuários com quem a conexão será compartilhada. Deixe uma matriz vazia se não houver usuários com quem compartilhar (somente userGroups).

    • userGroupIds (matriz de cadeia de caracteres (string)): insira uma lista de todos os IDs de grupos de usuários com os quais a conexão será compartilhada. Deixe uma matriz vazia se não houver grupos de usuários com quem compartilhar (somente usuários).

Exemplo de solicitação: 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"
    ]
  }'

Descompartilhar conexão

Para descompartilhar uma conexão, use o ponto de extremidade DELETE {baseURL}/v3/dcm/connections/{id}/sharing/execution.

Propriedades

id (cadeia de caracteres): obrigatório. Insira o ID da conexão do DCM da qual deseja reverter o compartilhamento com todos os usuários e grupos.

Exemplo de solicitação: cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/execution' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Criar ou atualizar conexão

Para criar ou atualizar uma conexão, use o ponto de extremidade POST {baseURL}/v3/dcm/connections.

O ponto de extremidade único serve funções de criação e atualização, diferenciadas pela existência de IDs de objeto incluídos na solicitação. A reutilização de fontes de dados ou credenciais existentes não é atualmente compatível ao criar novas conexões.

Propriedades

  • id (cadeia de caracteres): opcional. Insira o ID da conexão se desejar atualizar uma conexão existente. Ignore se desejar criar uma nova conexão.

  • name (cadeia de caracteres): obrigatório. Insira o nome da sua conexão.

    Nota

    Há múltiplos "nomes" dentro de uma conexão do DCM:

    • Connection.name: o nome da conexão em si. Os administradores interagem com esse nome por meio da API.

    • Connection.dataSource.object.name: nome da fonte de dados visível na guia "Fontes de dados" na interface do usuário (IU).

    • Connection.credentials.<credRole>.object.name: nomes de credenciais visíveis na guia "Credenciais" na IU.

    Para obter mais detalhes, consulte a seção O que é uma conexão do DCM?.

  • schemaName (cadeia de caracteres (string)): obrigatório. Esse é o identificador de um esquema do DCM, que é usado para renderizar e validar os parâmetros associados na interface do usuário (IU) do DCM. Cada conector define seu próprio conjunto de esquemas do DCM compatíveis. O esquema de conexão selecionado também especifica quais esquemas de "DataSource" (fonte de dados) e "Credential" (credencial) devem ser usados para as seções "DataSource" e "Credential" da conexão. Para obter mais detalhes, consulte O que é uma conexão do DCM? e Como um conector está relacionado a uma conexão do DCM?

  • allowInSdks (booleano): opcional. Torna a conexão acessível às ferramentas do SDK do Python.

  • parameters (objeto): obrigatório. Essa propriedade contém detalhes de configuração específicos do esquema e da tecnologia a que você está se conectando.

    Nota

    Há vários objetos de parameters (parâmetros) diferentes em uma estrutura de conexão do DCM, cada um usado em um contexto diferente:

    • Connection.parameters: para a conexão geral (ainda não visível na interface do usuário (IU), em breve).

    • Connection.dataSource.object.parameters: para a parte de fonte de dados da conexão.

    • Connection.credentials.<credRole>.object.parameters: para cada função de credencial (credential).

    • Connection.credentials.<credRole>.object.secrets.<secretType>.parameters: para segredos de credencial, por tipo de segredo.

    Cada objeto "parameters" (parâmetros) tem sua própria estrutura e campos obrigatórios, que dependem da tecnologia e do schemaName definidos nessa parte da conexão. Eles são independentes e podem conter (e muitas vezes contêm) campos diferentes.

    A propriedade parameters (parâmetros) é obrigatória, mas poderá ser fornecida como objetos vazios ({}) se nenhum parâmetro for necessário para um determinado esquema.

    Dica:

    Para determinar os campos corretos para qualquer objeto de parameters (parâmetros):

    1. Crie uma conexão do DCM na interface de usuário (IU) do Alteryx Server para sua tecnologia de destino.

    2. Consulte a conexão por meio da API: GET /v3/dcm/connections/{id}

    3. Revise a estrutura e os campos retornados para cada objeto de parameters (parâmetros) na resposta.

    Essa é a maneira mais confiável de descobrir os campos obrigatórios e disponíveis para sua fonte de dados ou credencial (credential) específica.

    Como os campos parameters são específicos da fonte de dados e da credencial (credential), um exemplo abrangente para todas as tecnologias não seria prático nesta documentação. Use o fluxo de trabalho acima para obter exemplos atualizados e específicos da fonte.

  • dataSource (objeto): obrigatório. A fonte de dados usada para a conexão, descrevendo o host da instância da fonte de dados e parâmetros adicionais, como visto na IU do DCM.

    • object (objeto): obrigatório.

      • id (cadeia de caracteres (string)): insira o ID da fonte de dados se desejar atualizar uma conexão existente. Ignore se desejar criar uma nova conexão. O uso de uma fonte de dados existente ao criar novas conexões está indisponível no momento.

      • name (cadeia de caracteres): obrigatório. Insira um nome para a fonte de dados.

      • schemaName (cadeia de caracteres (string)): obrigatório. Insira o nome do esquema da fonte de dados selecionada. Para obter uma descrição detalhada, consulte a propriedade Connection.schemaName.

      • parameters (objeto): obrigatório. Parâmetros para a parte de DataSource da conexão. Consulte a propriedade Connection.parameters para obter mais detalhes. Forneça um objeto vazio {} se nenhum parâmetro for necessário.

  • credentials (objeto): obrigatória. Pares de chave-valor de <credRole>: object. <credRole>s são definidas pelo esquema do DCM selecionado. O object tem apenas uma propriedade chamada "object", que contém todas as propriedades da credencial (credential). Algumas conexões podem não exigir credenciais (credentials), enquanto outras podem ter vários objetos de credencial aninhados.

    A partir dos exemplos abaixo, você pode ver que a autenticação com nome de usuário e senha do SQLServer (MSSQL) usa a <credRole> principal. A conexão do Redshift com autenticação com grupo de identidades e do Snowflake com autenticação OAuth usam oauthApplication e oauthTokens <credRoles> para suas credenciais (credentials).

    Para obter mais detalhes, consulte O que é uma conexão do DCM? e Como um conector está relacionado à conexão do DCM?

    • object (objeto): define as propriedades das partes de credencial (credential) da conexão.

      • id (cadeia de caracteres (string)): insira um ID de credencial se desejar atualizar uma conexão existente. Ignore se desejar criar uma nova conexão. O uso de uma credencial existente ao criar novas conexões está indisponível no momento.

      • name (cadeia de caracteres): obrigatório. Insira o nome da sua credencial (credential).

      • schemaName (cadeia de caracteres (string)): obrigatório. Insira o nome do esquema da credencial selecionada.

      • parameters (objeto): obrigatório. Parâmetros (parameters) para as partes de Credential da conexão. Consulte a propriedade Connection.parameters para obter mais detalhes. Forneça um objeto vazio {} se nenhum parâmetro for necessário.

Exemplo de solicitação: cURL

Criar uma Conexão do DCM do SQL Server usando credenciais de nome de usuário e senha

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

Criar uma conexão do DCM do ODBC para o Redshift usando a autenticação OAuth com o 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": {
                }
            }
        }
    }
}'

Criar uma conexão do DCM do Snowflake com credenciais do 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": {}
            }
        }
    }
}'

Excluir conexão

Para excluir uma conexão, use o ponto de extremidade DELETE {baseURL}/v3/dcm/connections/{id}. A fonte de dados e as credenciais também serão excluídas, a menos que sejam usadas em qualquer outra conexão.

Propriedades

id (cadeia de caracteres): obrigatório. Insira o ID da conexão do DCM que deseja excluir.

Exemplo de solicitação: cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Pontos de extremidade do DCM para administradores

Pontos de extremidade que podem ser usados por administradores com acesso à API:

Nota

  • Todos os pontos de extremidade de API de administrador retornam todos os dados disponíveis no Server para todos os usuários, independentemente da propriedade.

  • Todos os exemplos estão no PowerShell.

Obter conexão

Para obter um registro de conexão, use o ponto de extremidade GET {baseURL}/v3/dcm/admin/connections/{objectId}.

Propriedades

objectId (cadeia de caracteres (string)): obrigatório. Insira o ID da conexão do DCM sobre a qual deseja obter informações.

Exemplo de solicitação: cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Listar conexões

Para obter uma lista de todos os registros de conexões presentes no Server, use o ponto de extremidade GET {baseURL}/v3/dcm/admin/connections.

Propriedades

Ambos os parâmetros são filtros que podem ser combinados. Usar connectionId e visibleBy juntos retornará a conexão com o ConnectionID especificado, visível pelo usuário especificado.

  • connectionId (cadeia de caracteres): opcional. Filtra as conexões por seu connectionID, como referenciadas a partir de um fluxo de trabalho. Várias conexões poderão ser retornadas para um único connectionID, se a conexão for compartilhada para colaboração.

  • visibleBy (cadeia de caracteres): opcional. Insira o ID do usuário. Se presente, filtra os resultados para o mesmo resultado de todas as conexões disponíveis para o usuário especificado.

Exemplo de solicitação: cURL

curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connections?connectionId=d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3&visibleBy=bc7cb7b47c33' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Criar ou atualizar uma conexão em nome do usuário

Para criar ou atualizar um registro de conexão em nome de um usuário, use o ponto de extremidade POST {baseURL}/v3/dcm/admin/connections.

Propriedades

Use as mesmas propriedades descritas na seção Criar ou atualizar conexão. A única propriedade adicional necessária para esse ponto de extremidade é ownerId.

ownerId (cadeia de caracteres): obrigatório.

  • Ao criar uma conexão, digite o ID do usuário em nome do qual a conexão será criada.

  • Ao atualizar uma conexão, você também deve inserir o ownerId, mesmo que não queira alterá-lo. Para obter mais informações sobre como obter um "ownerID", vá para Obter conexão ou Listar conexões.

Exemplo de solicitação: 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": {}
              }
            }
          }
        }
      }
    }
  }'

Descompartilhar uma conexão compartilhada para execução

Para descompartilhar uma conexão cujo tipo de compartilhamento foi definido como "Compartilhada para execução", use o ponto de extremidade DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/execution.

Propriedades

objectId (cadeia de caracteres (string)): obrigatório. Insira o ID da conexão do DCM para a qual reverter o compartilhamento para execução.

Exemplo de solicitação: cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/execution' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Descompartilhar uma conexão compartilhada para colaboração

Para descompartilhar uma conexão cujo tipo de compartilhamento foi definido como "Compartilhada para colaboração", use o ponto de extremidade DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/collaboration.

Propriedades

objectId (cadeia de caracteres (string)): obrigatório. Insira o ID da conexão do DCM para a qual reverter o compartilhamento para colaboração.

Exemplo de solicitação: cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3/sharing/collaboration' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Excluir conexão

Para excluir um registro de conexão, use o ponto de extremidade DELETE {baseURL}/v3/dcm/admin/connections/{objectId}. A fonte de dados e as credenciais também serão excluídas, a menos que sejam usadas em qualquer outra conexão.

Propriedades

objectId (cadeia de caracteres (string)): obrigatório. Insira o ID da conexão do DCM que deseja excluir.

Exemplo de solicitação: cURL

curl --location --request DELETE 'https://localhost/webapi/v3/dcm/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' `
  --header 'Authorization: Bearer BearerTokenGoesHere'

Obter todas as regras de tratamento de conexão

Para obter todas as regras de tratamento de conexão, use o ponto de extremidade GET {baseURL}/v3/dcm/admin/connectionhandlingrules.

Acesse Tratamento de conexão do DCM para obter mais informações.

Propriedades

Nenhuma propriedade.

Exemplo de solicitação: cURL

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

Obter regra de tratamento de conexão

Para obter uma regra de tratamento de conexão do DCM específica, use o ponto de extremidade GET {baseURL}/v3/dcm/admin/connectionhandlingrules/{id}.

Propriedades

id (cadeia de caracteres): obrigatório. Especifique o ID da regra de tratamento de conexão do DCM a retornar.

Exemplo de solicitação: cURL

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

Adicionar ou atualizar uma regra de tratamento de conexão

Para adicionar uma nova regra de tratamento de conexão ou atualizar uma existente, use o ponto de extremidade POST {baseURL}/v3/dcm/admin/connectionhandlingrules.

Propriedades

Insira as seguintes propriedades para criar ou atualizar uma regra de tratamento de conexão do DCM:

  • rule (corpo): obrigatória. A "ConnectionHandlingRule" do DCM para criar ou atualizar.

    • id (cadeia de caracteres): opcional. O ID da regra de tratamento de conexão do DCM. Insira o ID da regra de tratamento de conexão do DCM se desejar atualizar regra de tratamento de conexão existente. Ignore se desejar criar uma nova regra de tratamento de conexão.

    • sourceConnectionId (cadeia de caracteres): insira um "sourceConnectionId", fazendo referência a um "ConnectionId" a ser substituído na execução do fluxo de trabalho. A conexão não precisa existir no Server (fluxos de trabalho que façam referência a ela ainda podem ser executados). Ela não pode ser usada em nenhuma outra regra existente, seja como conexão de origem ou de destino.

    • sourceConnectionTitle (cadeia de caracteres): insira um nome personalizado ou descrição da conexão de origem.

    • targetConnectionId (cadeia de caracteres (string)): insira um "targetConnectionId". Deve fazer referência a uma conexão do DCM presente no Server.

    • targetConnectionTitle (cadeia de caracteres (string)): opcional. Insira um nome personalizado ou descrição da conexão de destino. Ela é concluída automaticamente para o título da conexão selecionada.

Exemplo de solicitação: 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"
}'

Excluir regra de tratamento da conexão

Para excluir uma regra de tratamento de conexão existente, use o ponto de extremidade DELETE {baseURL}/v3/dcm/admin/connectionhandlingrules/{id}.

Propriedades

id (cadeia de caracteres): obrigatório. Especifique o ID da regra de tratamento de conexão do DCM que deseja excluir.

Exemplo de solicitação: cURL

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

Relações de objetos

Se você estiver criando uma conexão, poderá usar objetos criados da seguinte maneira:

Objeto criado:

  • "id" (por exemplo, "id": "c128cc5fca-86cc-4e7e-93a3-d500cca9a3f3")

  • “connectionId” (por exemplo, "id": "c0332423423-86cc-4e7e-93a3-d500cca9a3f3")

Você pode usá-lo como:

Administrador:

Nesta secção: