Skip to main content

Pontos de extremidade do DCM.E

Pontos de extremidade do DCM.E e parâmetros

Os pontos de extremidade do DCM.E são divididos em dois grupos: pontos de extremidade do DCM.E para usuários e pontos de extremidade do DCM.E para administradores . Todos os pontos de extremidade do DCM.E 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 .

Pontos de extremidade do DCM.E para usuários

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

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

Recuperar um registro de conexão do DCM

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

Parâmetros

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

Recuperar uma conexão do DCM como referenciada em fluxos de trabalho

Para recuperar um registro de conexão do DCM 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 do DCM, 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.

Parâmetros

  • 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 uma conexão do DCM com usuários e grupos especificados

Para compartilhar uma conexão do DCM 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 fornecida de usuários e grupos não pode estar vazia; para remover o compartilhamento existente, use o ponto de extremidade DELETE.

Parâmetros

  • 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 do usuário 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): insira uma lista de todos os IDs do grupo de usuários com quem 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"]}'

Reverter o compartilhamento de uma conexão do DCM

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

Parâmetros

  • 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 uma conexão do DCM

Para criar ou atualizar uma conexão do DCM, 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.

Parâmetros

  • upsertConnectionContract (cadeia de caracteres): obrigatório. A conexão do DCM é uma combinação de uma fonte de dados (descrevendo o host da instância de destino) e credenciais (por exemplo, nome de usuário e senha) ao definir a possível combinação de esquema.

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

    • schemaName (cadeia de caracteres): obrigatório. Insira um nome de esquema da conexão que você gostaria de usar. O esquema define os parâmetros obrigatórios da conexão, bem como os esquemas de fonte de dados e credenciais permitidos para serem usados para essa conexão.

    • allowInSdks (booleano): opcional.

    • parameters (objeto): obrigatório. Vários parâmetros podem ser obrigatórios com base no schemaName selecionado.

    • 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): 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): obrigatório. Insira o nome do esquema da fonte de dados selecionada.

        • parâmetros adicionais específicos do esquema : dependendo do esquema usado, será necessário fornecer parâmetros adicionais da fonte de dados.

    • credentials (cadeia de caracteres): opcional, dependendo do schemaName selecionado no "upsertConnectionContract". Algumas conexões podem não exigir credenciais, enquanto outras podem ter vários objetos aninhados (slots).

      • main (objeto): opcional (veja acima). Esse main é apenas um nome de slot de credencial (mais comum). No entanto, ele pode ser nomeado de forma diferente ou pode haver vários slots de credenciais para a conexão, dependendo do que é definido no esquema da conexão.

        • id (cadeia de caracteres): 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.

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

        • parâmetros adicionais específicos do esquema : dependendo do esquema usado, será necessário fornecer parâmetros adicionais da fonte de dados.

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

Excluir uma conexão do DCM

Para excluir uma conexão do DCM, 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.

Parâmetros

  • 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.E para administradores

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

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.

Recuperar um registro de conexão do DCM

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

Parâmetros

  • objectId (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/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Recuperar uma lista de registros de conexões do DCM

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

Parâmetros

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 do DCM em nome do usuário

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

Parâmetros

  • upsertConnectionContract (cadeia de caracteres): obrigatório.

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

    • ownerId (cadeia de caracteres): obrigatório.

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

    • schemaName (cadeia de caracteres): obrigatório. Insira um nome de esquema da conexão que você gostaria de usar. O esquema define os parâmetros obrigatórios da conexão, bem como os esquemas de fonte de dados e credenciais permitidos para serem usados para essa conexão.

    • allowInSdks (booleano): opcional.

    • parameters (objeto): obrigatório. Vários parâmetros podem ser obrigatórios com base no schemaName selecionado.

    • dataSource (objeto): obrigatório. A fonte de dados utilizada para a conexão

      • object (objeto): obrigatório.

        • id (cadeia de caracteres): insira um ID da fonte de dados, se estiver atualizando 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): obrigatório. Insira o nome do esquema da fonte de dados selecionada.

        • parâmetros adicionais específicos do esquema : dependendo do esquema usado, será necessário fornecer parâmetros adicionais da fonte de dados.

    • credentials (cadeia de caracteres): opcional, dependendo do schemaName selecionado no "upsertConnectionContract". Algumas conexões podem não exigir nenhuma credencial, enquanto outras podem ter várias.

      • main (objeto): opcional (veja acima).

        • id (cadeia de caracteres): insira um ID da credencial se estiver atualizando 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.

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

        • parâmetros adicionais específicos do esquema : dependendo do esquema usado, será necessário fornecer parâmetros adicionais da credencial.

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

Reverter o compartilhamento de uma conexão do DCM compartilhada para execução

Para reverter o compartilhamento de uma conexão do DCM 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 endpoint.

Parâmetros

  • objectId (cadeia de caracteres): 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'

Reverter o compartilhamento de uma conexão do DCM compartilhada para colaboração

Para reverter o compartilhamento de uma conexão do DCM 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 .

Parâmetros

  • objectId (cadeia de caracteres): 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 uma conexão do DCM

Para excluir um registro de conexão do DCM, 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.

Parâmetros

  • objectId (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/admin/connections/d8cc5fca-86cc-4e7e-93a3-d500cca9a3f3' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Relações de objetos

Se estiver criando uma conexão do DCM, você 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: