Skip to main content

Endpoint DCM

Endpoint e proprietà DCM

Gli endpoint DCM sono suddivisi in due gruppi, ovvero endpoint DCM per gli utenti ed endpoint DCM per gli amministratori. Tutti gli endpoint DCM richiedono la configurazione di TLS su Server.

Per ulteriori informazioni sulle relazioni tra oggetti e su come utilizzarle nell'API, consulta la sezione Relazioni tra oggetti.

Per ulteriori informazioni sulle connessioni dati, consulta le pagine di assistenzaDCM - Server e Data Connection Manager (DCM): interfaccia utente di Server.DCM - ServerData Connection Manager (DCM): interfaccia utente di Server

Che cos'è una connessione DCM?

Una "connessione DCM" è composta dai suoi parametri e da due tipi di oggetti secondari: DataSource (è sempre una sola) e Credentials (negli scenari più comuni sono presenti zero, una o due credenziali, ma in rari casi potrebbero essere ancora di più e il loro numero è specifico del connettore). Ogni Credential ha un diverso credRole all'interno della connessione. L'API DCM gestisce le connessioni come oggetti completi, inclusi DataSource e Credentials.

In che modo un connettore è correlato a una connessione DCM?

Un connettore è un frammento di codice che consente ad Alteryx di comunicare con origini dati esterne. Ogni connettore richiede una serie specifica di parametri per stabilire la comunicazione. Nell'insieme, questi parametri prendono il nome di "connessione DCM". I parametri esatti supportati da un connettore vengono definiti e comunicati a DCM tramite uno schema DCM, identificato in modo univoco dal relativo schemaName.

Un singolo connettore può supportare più metodi di autenticazione o protocolli di comunicazione, ciascuno con il proprio insieme di parametri. Di conseguenza, un connettore potrebbe registrare più schemi DCM con valori schemaName diversi.

Uno schema di connessione è strutturato allo stesso modo degli altri oggetti DCM, che comprendono sia uno schema DataSource che gli schemi Credential. Ciò significa che Connection.schemaName determina anche quali DataSource.schemaName e Credential.schemaNames devono essere utilizzati nell'oggetto connessione creato per lo schema di connessione specifico.

schemaNames per il connettore ODBC a SQL Server

  • ODBC di Microsoft SQL Server senza DSN (Azure Active Directory integrato)

    schemaName: "database-odbc-mssql-adintegrated"

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

    • credentials: nessuna

  • ODBC di Microsoft SQL Server senza DSN (identità del servizio gestito Azure)

    schemaName: "database-odbc-mssql-admsi"

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

    • credentials:

      credRole: "main", schemaName: "azure_managed_identity"

  • ODBC di Microsoft SQL Server senza DSN (password Azure Active Directory)

    schemaName: "database-odbc-mssql-adpwd"

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

    • credentials:

      credRole: "main", schemaName: "username_password"

  • ODBC di Microsoft SQL Server senza DSN (entità del servizio Azure Active Directory)

    schemaName: "database-odbc-mssql-adsp"

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

    • credentials:

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

  • ODBC di Microsoft SQL Server senza DSN (solo nome utente)

    schemaName: "database-odbc-mssql-nopwd"

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

    • credentials:

      credRole: "main", schemaName: "username"

  • ODBC di Microsoft SQL Server senza 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 di Microsoft SQL Server senza DSN (Azure AD - Privato)

    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 di Microsoft SQL Server senza DSN (OAuth2 generico)

    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 di Microsoft SQL Server senza DSN (autenticazione Windows)

    schemaName: "database-odbc-mssql-winauth"

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

    • credentials: nessuna

  • ODBC di Microsoft SQL Server senza DSN (Nome utente - Password)

    schemaName: "database-odbc-mssql"

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

    • credentials:

      credRole: "main", schemaName: "username_password"

  • Microsoft SQL Server ODBC (nessuna credenziale)

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

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

    • credentials: nessuna

  • ODBC di Microsoft SQL Server (solo nome utente)

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

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

    • credentials:

      credRole: "main", schemaName: "username"

  • ODBC di 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 di Microsoft SQL Server (Azure AD - Privato)

    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 di Microsoft SQL Server (Oauth2 generico)

    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 di Microsoft SQL Server (nome utente - password)

    schemaName: "database-odbc-dsn-mssql"

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

    • credentials:

      credRole: "main", schemaName: "username_password"

Endpoint DCM per gli utenti

Questi endpoint possono essere utilizzati dagli utenti con accesso all'API:

Nota

  • Tutti gli endpoint API restituiscono dati di singoli utenti (ogni utente può solo visualizzare e gestire le proprie connessioni).

  • Tutti gli esempi sono in PowerShell.

Recupero informazioni su una connessione

Per recuperare il record di una connessione, utilizza l'endpoint GET {baseURL}/v3/dcm/connections/{id}. L'endpoint restituisce tutte le informazioni relative alla connessione, incluse l'origine dati e le credenziali, nonché le informazioni di condivisione.

Proprietà

id (stringa): obbligatorio. Immetti l'ID della connessione DCM su cui desideri avere informazioni.

Esempio di richiesta: cURL

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

Recupero informazioni su una connessione a cui viene fatto riferimento nei flussi di lavoro

Per recuperare il record di una connessione a cui viene fatto riferimento nei flussi di lavoro, utilizza l'endpoint GET {baseURL}/v3/dcm/connections/lookup. L'endpoint restituisce tutte le informazioni relative alla connessione, incluse l'origine dati e le credenziali, nonché le informazioni di condivisione.

Nota

Il parametro ConnectionID utilizzato in questo endpoint è diverso dal parametro ID utilizzato in altri endpoint DCM. ID viene utilizzato per fare riferimento a vari oggetti DCM, mentre ConnectionID è utilizzato nei flussi di lavoro solo per fare riferimento alla connessione DCM per utenti specifici.

Proprietà

connectionId (stringa): obbligatorio. Immetti l'ID della connessione DCM su cui desideri avere informazioni.

Esempio di richiesta: cURL

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

Condividi connessione

Per condividere una connessione per l'esecuzione di Server con utenti o gruppi specificati, utilizza l'endpoint PUT {baseURL}/v3/dcm/connections/{id}/sharing/execution.

Nota

Poiché si tratta di un endpoint PUT, sovrascrive la condivisione esistente anziché aggiungere altri utenti o gruppi di utenti all'elenco esistente. L'elenco di utenti e gruppi fornito non può essere vuoto. Per rimuovere la condivisione esistente, utilizza l'endpoint DELETE.

Proprietà

  • id (stringa): obbligatorio. Immetti l'ID della connessione DCM che desideri condividere con altri utenti o gruppi.

  • sharingContract (corpo): obbligatorio. Il parametro sharingContract è obbligatorio per aggiornare la condivisione delle responsabilità di esecuzione. Sono necessari entrambi gli array, ma solo uno può essere lasciato vuoto.

    • userIds (array di stringhe): immetti l'elenco degli ID di tutti gli utenti con cui condividere la connessione. Lascia un array vuoto se non sono presenti utenti per la condivisione (solo gruppi di utenti).

    • userGroupIds (array di stringhe): immetti l'elenco degli ID di tutti i gruppi di utenti con cui condividere la connessione. Lascia un array vuoto se non sono presenti gruppi di utenti per la condivisione (solo utenti).

Esempio di richiesta: 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"
    ]
  }'

Annullamento della condivisione di una connessione

Per annullare la condivisione di una connessione, utilizza l'endpoint DELETE {baseURL}/v3/dcm/connections/{id}/sharing/execution.

Proprietà

id (stringa): obbligatorio. Immetti l'ID della connessione DCM di cui desideri annullare la condivisione con altri utenti e gruppi.

Esempio di richiesta: cURL

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

Creazione o aggiornamento di una connessione

Per creare o aggiornare una connessione, utilizza l'endpoint POST {baseURL}/v3/dcm/connections.

Un unico endpoint può essere utilizzato per le funzioni di creazione e di aggiornamento, a seconda della presenza o meno degli ID degli oggetti nella richiesta. Il riutilizzo di origini dati o credenziali esistenti non è attualmente supportato durante la creazione di nuove connessioni.

Proprietà

  • id (stringa): opzionale. Immetti l'ID di una connessione che desideri aggiornare. Salta se desideri creare una nuova connessione.

  • name (stringa): obbligatorio. Immetti il nome della connessione.

    Nota

    Esistono più "nomi" all'interno di una connessione DCM:

    • Connection.name: il nome della connessione stessa. Gli amministratori interagiscono con questo nome tramite l'API.

    • Connection.dataSource.object.name: nome dell'origine dati visibile nella scheda Origini dati nell'interfaccia utente.

    • Connection.credentials.<credRole>.object.name: nomi delle credenziali visibili nella scheda Credenziali dell'interfaccia utente.

    Per ulteriori dettagli, consulta la sezione Che cos'è una connessione DCM?

  • schemaName (stringa): obbligatorio. È l'identificatore di uno schema DCM, utilizzato per il rendering e la convalida dei parametri associati nell'interfaccia utente di DCM. Ciascun connettore definisce il proprio insieme di schemi DCM supportati. Lo schema di connessione selezionato specifica anche quali schemi DataSource e Credentials devono essere utilizzati per le sezioni DataSource e Credentials della connessione. Per ulteriori dettagli, consulta Che cos'è una connessione DCM? e In che modo un connettore è correlato a una connessione DCM?

  • allowInSdks (booleano): opzionale. Rende la connessione accessibile agli strumenti SDK Python.

  • parameters (oggetto): obbligatorio. Questa proprietà contiene dettagli di configurazione specifici per lo schema e la tecnologia a cui ti stai connettendo.

    Nota

    In una struttura di connessione DCM sono presenti vari oggetti parameters, ognuno dei quali viene utilizzato in un contesto diverso:

    • Connection.parameters: per la connessione generale (non ancora visibile nell'interfaccia utente, disponibile a breve).

    • Connection.dataSource.object.parameters: per la parte relativa all'origine dati della connessione.

    • Connection.credentials.<credRole>.object.parameters: per ogni ruolo Credential.

    • Connection.credentials.<credRole>.object.secrets.<secretType>.parameters: per i segreti delle credenziali, per tipo di segreto.

    Ogni oggetto parameters ha una propria struttura e campi obbligatori, che dipendono dalla tecnologia e dallo schemaName definito in quella determinata parte della connessione. Sono indipendenti e possono, come spesso accade, contenere campi diversi.

    La proprietà parameters è obbligatoria ma può essere fornita in forma di oggetti vuoti ({}) se per un determinato schema non sono necessari parametri.

    Suggerimento:

    Per determinare i campi corretti di un oggetto parameters:

    1. Crea una connessione DCM nell'interfaccia utente di Alteryx Server per la tua tecnologia di destinazione.

    2. Esegui una query sulla connessione tramite API: GET /v3/DCM/connections/{id}

    3. Esamina la struttura e i campi restituiti per ciascun oggetto parameters nella risposta.

    Questo è il modo più affidabile per individuare i campi obbligatori e disponibili per la tua specifica origine dati o credenziale.

    Poiché i campi parameters sono specifici per l'origine dei dati e le credenziali, non è pratico in questa documentazione fornire un esempio completo per ogni tecnologia. Utilizza il flusso di lavoro sopraindicato per ottenere esempi aggiornati e specifici per la fonte.

  • dataSource (oggetto): obbligatorio. L'origine dati utilizzata per la connessione, che descrive l'host dell'istanza dell'origine dati e i parametri aggiuntivi presenti nell'interfaccia utente di DCM.

    • object (oggetto): obbligatorio.

      • id (stringa): immetti l'ID di un'origine dati se desideri aggiornare una connessione esistente. Salta se desideri creare una nuova connessione. L'utilizzo di un'origine dati esistente durante la creazione di nuove connessioni non è al momento disponibile.

      • name (stringa): obbligatorio. Immetti un nome per l'origine dati.

      • schemaName (stringa): obbligatorio. Immetti il nome dello schema dell'origine dati selezionata. Per una descrizione dettagliata, fai riferimento alla proprietà Connection.schemaName.

      • parameters (oggetto): obbligatorio. Parametri per la parte DataSource della connessione. Per ulteriori dettagli, vedi la proprietà Connection.parameters. Fornisci un oggetto vuoto {} se non sono necessari parametri.

  • credentials (oggetto): obbligatorio. Le coppie chiave-valore di <credRole>: object. <credRole> sono definite dallo schema DCM selezionato. object ha una sola proprietà denominata "object" che contiene quindi tutte le proprietà delle credenziali. Alcune connessioni potrebbero non richiedere credenziali, mentre altre potrebbero avere più oggetti Credential annidati.

    Dagli esempi riportati di seguito, puoi notare che l'autenticazione nome utente-password di SQLServer (MSSQL) utilizza <credRole> main. Le connessioni Reshift con autenticazione Identity Pool e Snowflake con autenticazione OAuth utilizzano oauthApplication e oauthTokens <credRoles> per le proprie credenziali.

    Per ulteriori dettagli, consulta Che cos'è una connessione DCM? e In che modo un connettore è correlato a una connessione DCM?

    • object (oggetto): definisce le proprietà delle parti Credentials della connessione.

      • id (stringa): immetti l'ID di una credenziale se desideri aggiornare una connessione esistente. Salta se desideri creare una nuova connessione. L'uso di una credenziale esistente durante la creazione di nuove connessioni non è al momento disponibile.

      • name (stringa): obbligatorio. Immetti il nome della credenziale.

      • schemaName (stringa): obbligatorio. Immetti il nome dello schema della credenziale selezionata.

      • parameters (oggetto): obbligatorio. Parametri per le parti Credentials della connessione. Per ulteriori dettagli, vedi la proprietà Connection.parameters. Fornisci un oggetto vuoto {} se non sono necessari parametri.

Esempio di richiesta: cURL

Creazione di una connessione SQL Server DCM con le credenziali nome utente e 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 connessione DCM ODBC a Redshift con autenticazione 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 connessione DCM Snowflake con credenziali client 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": {}
            }
        }
    }
}'

Elimina connessione

Per eliminare una connessione, utilizza l'endpoint DELETE {baseURL}/v3/dcm/connections/{id}. Verranno eliminate anche l'origine dati e le credenziali, a meno che non siano utilizzate in altre connessioni.

Proprietà

id (stringa): obbligatorio. Immetti l'ID della connessione DCM che desideri eliminare.

Esempio di richiesta: cURL

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

Endpoint DCM per gli amministratori

Endpoint che possono essere utilizzati dagli amministratori con accesso all'API:

Nota

  • Gli endpoint delle API di amministrazione restituiscono tutti i dati disponibili su Server a tutti gli utenti, indipendentemente dalla proprietà.

  • Tutti gli esempi sono in PowerShell.

Recupero informazioni su una connessione

Per recuperare un record di una connessione, utilizza l'endpoint GET {baseURL}/v3/dcm/admin/connections/{objectId}.

Proprietà

objectId (stringa): obbligatorio. Immetti l'ID della connessione DCM su cui desideri avere informazioni.

Esempio di richiesta: cURL

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

Elenco delle connessioni

Per recuperare un elenco di tutti i record delle connessioni presenti su Server, utilizza l'endpoint GET {baseURL}/v3/dcm/admin/connections.

Proprietà

Entrambi i parametri sono filtri che possono essere combinati. L'uso congiunto di connectionId e visibleBy restituirà la connessione con il parametro ConnectionID specificato, visibile dall'utente specificato.

  • collectionId (stringa): opzionale. Filtra le connessioni in base al relativo connectionID a cui fa riferimento un flusso di lavoro. Se la connessione è condivisa per la collaborazione, un singolo parametro connectionID può restituire più connessioni.

  • visibleBy (stringa): opzionale. Immetti l'ID utente. Se è presente, filtra i risultati con lo stesso risultato di tutte le connessioni disponibili per l'utente specificato.

Esempio di richiesta: cURL

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

Creazione o aggiornamento di una connessione per conto di un utente

Per creare o aggiornare il record di una connessione per conto di un utente, utilizza l'endpoint POST {baseURL}/v3/dcm/admin/connections.

Proprietà

Utilizza le stesse proprietà descritte nella sezione Creazione o aggiornamento di una connessione. L'unica proprietà aggiuntiva richiesta per questo endpoint è ownerId.

ownerId (stringa): obbligatorio.

  • Durante la creazione di una connessione, immetti l'ID dell'utente per conto del quale verrà creata la connessione.

  • Durante l'aggiornamento di una connessione, devi specificare il parametro ownerId, anche quando non desideri modificarlo. Per ulteriori informazioni su come ottenere un parametro ownerId, consulta Recupero informazioni su una connessione o Elenco delle connessioni.

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

Annullamento della condivisione di una connessione condivisa per l'esecuzione

Per annullare la condivisione di una connessione condivisa per l'esecuzione, utilizza l'endpoint DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/execution.

Proprietà

objectId (stringa): obbligatorio. Immetti l'ID della connessione DCM di cui annullare la condivisione per l'esecuzione.

Esempio di richiesta: cURL

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

Annullamento della condivisione di una connessione condivisa per la collaborazione

Per annullare la condivisione di una connessione condivisa per la collaborazione, utilizza l'endpoint DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/collaboration.

Proprietà

objectId (stringa): obbligatorio. Immetti l'ID della connessione DCM di cui annullare la condivisione per la collaborazione.

Esempio di richiesta: cURL

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

Elimina connessione

Per eliminare il record di una connessione, utilizza l'endpoint DELETE {baseURL}/v3/dcm/admin/connections/{objectId}. Verranno eliminate anche l'origine dati e le credenziali, a meno che non siano utilizzate in altre connessioni.

Proprietà

objectId (stringa): obbligatorio. Immetti l'ID della connessione DCM che desideri eliminare.

Esempio di richiesta: cURL

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

Recupera tutte le regole di gestione connessioni

Per recuperare tutte le regole di gestione della connessione, utilizza l'endpoint GET {baseURL}/v3/dcm/admin/connectionhandlingrules.

Per ulteriori informazioni, consulta Gestione della connessione DCM.

Proprietà

Nessuna proprietà.

Esempio di richiesta: cURL

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

Recupera regola di gestione connessione

Per recuperare una determinata regola di gestione delle connessioni DCM, utilizza l'endpoint GET {baseURL}/v3/dcm/admin/connectionhandlingrules/{id}.

Proprietà

id (stringa): obbligatorio. Specifica l'ID della regola di gestione della connessione DCM da restituire.

Esempio di richiesta: cURL

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

Aggiungi o aggiorna regola di gestione connessione

Per aggiungere una nuova regola di gestione delle connessioni o aggiornarne una esistente, utilizza l'endpoint POST {baseURL}/v3/dcm/admin/connectionhandlingrules.

Proprietà

Immetti le seguenti proprietà per creare o aggiornare una regola di gestione delle connessioni DCM:

  • rule (corpo): obbligatorio. DCM ConnectionHandlingRule da creare o aggiornare.

    • id (stringa): opzionale. ID della regola di gestione della connessione DCM Immetti un ID della regola di gestione della connessione DCM se desideri aggiornare una regola di gestione della connessione esistente. Salta se desideri creare una nuova regola di gestione della connessione.

    • sourceConnectionId (stringa): immetti un valore sourceConnectionId, facendo riferimento a un ConnectionId da sostituire nel momento dell'esecuzione del flusso di lavoro. La connessione non deve necessariamente esistere su Server (i flussi di lavoro che fanno riferimento ad essa possono comunque essere eseguiti). Non può essere utilizzato in un'altra regola esistente, che si tratti di una connessione di origine o di destinazione.

    • sourceConnectionTitle (stringa): immetti un nome personalizzato o una descrizione della connessione di origine.

    • targetConnectionId (stringa): immetti un valore targetConnectionId. Deve fare riferimento a una connessione DCM presente su Server.

    • targetConnectionTitle (stringa): facoltativo. Immetti un nome personalizzato o una descrizione della connessione di destinazione. Viene automaticamente inserito il titolo della connessione selezionata.

Esempio di richiesta: 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"
}'

Elimina regola di gestione connessione

Per eliminare una regola esistente per la gestione delle connessioni, utilizza l'endpoint DELETE {baseURL}/v3/dcm/admin/connectionhandlingrules/{id}.

Proprietà

id (stringa): obbligatorio. Specifica l'ID della connessione DCM che desideri eliminare.

Esempio di richiesta: cURL

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

Relazioni tra oggetti

Se stai creando una connessione, puoi utilizzare gli oggetti creati nel modo seguente:

Oggetto creato:

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

  • "connectionId" (ad esempio, "id": "c0332423423-86cc-4e7e-93a3-d500cca9a3f3")

Puoi utilizzarlo come:

Admin:

In questa sezione: