Endpoint DCME
Endpoint e parametri DCME
Gli endpoint DCME sono suddivisi in due gruppi: endpoint DCME per gli utenti e endpoint DCME per gli amministratori. Tutti gli endpoint DCME 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.
Endpoint DCME per gli utenti
Questi endpoint possono essere utilizzati dagli utenti con accesso all'API:
Tutti gli endpoint API restituiscono dati di singoli utenti (ogni utente può solo visualizzare e gestire le proprie connessioni).
Per recuperare il record di una connessione DCM, utilizza l'endpoint GET {baseURL}/v3/dcm/connections/{id}. L'endpoint restituisce tutte le informazioni relative alla connessione DCM, incluse l'origine dati e le credenziali, nonché le informazioni di condivisione.
Parametri
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'
Per recuperare il record di una connessione DCM a cui fanno riferimento i flussi di lavoro, utilizza l'endpoint GET {baseURL}/v3/dcm/connections/lookup. L'endpoint restituisce tutte le informazioni relative alla connessione DCM, 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.
Parametri
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'
Per condividere una connessione DCM 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.
Parametri
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 un 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 un elenco di 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"]}'
Per annullare la condivisione di una connessione DCM, utilizza l'endpoint DELETE {baseURL}/v3/dcm/connections/{id}/sharing/execution.
Parametri
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'
Per creare o aggiornare una connessione DCM, 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.
Parametri
upsertConnectionContract (stringa): obbligatorio. La connessione DCM è la combinazione di un'origine dati (che descrive l'host dell'istanza di destinazione) e di credenziali (ad esempio, nome utente e password) tramite definizione della possibile combinazione di schema.
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.
schemaName (stringa): obbligatorio. Immetti il nome di uno schema di connessione che desideri utilizzare. Lo schema definisce i parametri richiesti per la connessione e gli schemi di origini dati e credenziali utilizzabili per la connessione.
allowInSdks (booleano): opzionale.
parameters (oggetto): obbligatorio. I parametri obbligatori variano in base al parametro schemaName selezionato.
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.
parametri aggiuntivi specifici dello schema: a seconda dello schema utilizzato, ti verrà chiesto di fornire altri parametri dell'origine dati.
credentials (stringa): opzionale, variabile a seconda del parametro schemaName selezionato in upsertConnectionContract. Alcune connessioni potrebbero non richiedere credenziali, mentre altre potrebbero avere più oggetti annidati (slot).
main (oggetto): opzionale (vedi sopra). Si tratta del nome dello slot di credenziali più comune. Tuttavia, il parametro può essere denominato in modo diverso o potrebbero essere presenti più slot di credenziali per la connessione, a seconda di quanto riportato nello schema di 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.
parametri aggiuntivi specifici dello schema: a seconda dello schema utilizzato, ti verrà chiesto di fornire altri parametri dell'origine dati.
Esempio di richiesta: 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":{}}}}}}}'
Per eliminare una connessione DCM, 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.
Parametri
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 DCME per gli amministratori
Endpoint che possono essere utilizzati dagli amministratori con accesso all'API:
Creazione o aggiornamento di una connessione DCM per conto di un utente
Annullamento della condivisione di una connessione DCM condivisa per l'esecuzione
Annullamento della condivisione di una connessione DCM condivisa per la collaborazione
Recupera una regola specifica di gestione della connessione DCM
Aggiunge o aggiorna una regola di gestione della connessione DCM
Eliminazione di una regola di gestione delle connessioni DCM
Gli endpoint delle API di amministrazione restituiscono tutti i dati disponibili su Server a tutti gli utenti, indipendentemente dalla proprietà.
Per recuperare un record di una connessione DCM, utilizza l'endpoint GET {baseURL}/v3/dcm/admin/connections/{objectId}.
Parametri
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'
Per recuperare un elenco di tutti i record delle connessione DCM presenti su Server, utilizza l'endpoint GET {baseURL}/v3/dcm/admin/connections.
Parametri
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'
Per creare o aggiornare il record di una connessione DCM per conto di un utente, utilizza l'endpoint POST {baseURL}/v3/dcm/admin/connections.
Parametri
upsertConnectionContract (stringa): obbligatorio.
id (stringa): opzionale. Immetti l'ID di una connessione che desideri aggiornare. Salta se desideri creare una nuova connessione.
ownerId (stringa): obbligatorio.
Durante la creazione di una connessione DCM, immetti l'ID dell'utente per conto del quale verrà creata la connessione.
Durante l'aggiornamento di una connessione DCM, è necessario specificare il parametro ownerId , anche se non desideri modificarlo. Per ulteriori informazioni su come ottenere un parametro ownerID, consulta Recupero del record di una connessione DCM o Recupero di un elenco di record di connessioni DCM.
name (stringa): obbligatorio. Immetti il nome della connessione.
schemaName (stringa): obbligatorio. Immetti il nome di uno schema di connessione che desideri utilizzare. Lo schema definisce i parametri richiesti per la connessione e gli schemi di origini dati e credenziali utilizzabili per la connessione.
allowInSdks (booleano): opzionale.
parameters (oggetto): obbligatorio. I parametri obbligatori variano in base al parametro schemaName selezionato.
dataSource (oggetto): obbligatorio. L'origine dati utilizzata per la connessione.
object (oggetto): obbligatorio.
id (stringa): immetti l'ID di un'origine dati se stai aggiornando 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.
parametri aggiuntivi specifici dello schema: a seconda dello schema utilizzato, ti verrà chiesto di fornire altri parametri dell'origine dati.
credentials (stringa): opzionale, variabile a seconda del parametro schemaName selezionato in upsertConnectionContract. Alcune connessioni potrebbero non richiedere credenziali, mentre altre potrebbero averne diverse.
main (oggetto): opzionale (vedi sopra).
id (stringa): immetti l'ID di una credenziale se stai aggiornando 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.
altri parametri specifici dello schema: a seconda dello schema utilizzato, ti verrà chiesto di fornire ulteriori parametri delle credenziali.
Esempio di richiesta: 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":{}}}}}}}'
Per annullare la condivisione di una connessione DCM condivisa per l'esecuzione, utilizza l'endpoint DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/execution endpoint.
Parametri
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'
Per annullare la condivisione di una connessione DCM condivisa per la collaborazione, utilizza l'endpoint DELETE {baseURL}/v3/dcm/admin/connections/{objectId}/sharing/collaboration.
Parametri
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'
Per eliminare il record di una connessione DCM, 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.
Parametri
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'
Per recuperare tutte le regole di gestione della connessione DCM, utilizza l'endpoint GET {baseURL}/v3/dcm/admin/connectionhandlingrules.
Per ulteriori informazioni, consulta Gestione della connessione DCM.
Parametri
Nessun parametro.
Esempio di richiesta: cURL
curl --location --request GET 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules \ --header 'Authorization: Bearer BearerTokenGoesHere'
Per recuperare una sola regola di gestione della connessione DCM, utilizza l'endpoint GET {baseURL}/v3/dcm/admin/connectionhandlingrules/{id}.
Parametri
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'
Per aggiungere una nuova regola di gestione della connessione DCM o aggiornarne una esistente, utilizza l'endpoint POST {baseURL}/v3/dcm/admin/connectionhandlingrules.
Parametri
Immetti i seguenti parametri per creare o aggiornare una regola di gestione della connessione 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): immetti un nome personalizzato o una descrizione della connessione di destinazione.
Esempio di richiesta: cURL
curl --location --request POST 'https://localhost/webapi/v3/dcm/admin/connectionhandlingrules/{id} \ --header 'Authorization: Bearer BearerTokenGoesHere'
Per eliminare una regola di gestione della connessione DCM esistente, utilizza l'endpoint DELETE {baseURL}/v3/dcm/admin/connectionhandlingrules/{id}.
Parametri
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 DCM, 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:
id se desideri recuperare il record di una connessione DCM
connectionId se desideri recuperare una connessione DCM a cui fanno riferimento i flussi di lavoro
id de desideri condividere una connessione DCM con utenti e gruppi specificati
id se desideri aggiornare una connessione DCM
id se desideri eliminare una connessione DCM
id se desideri annullare la condivisione di una connessione DCM
Admin:
id se desideri recuperare il record di una connessione DCM
ownerId (userId) se desideri creare una connessione DCM per conto di un utente
id se desideri aggiornare una connessione DCM per conto di un utente
id se desideri annullare la condivisione di una connessione DCM condivisa per l'esecuzione
id se desideri annullare la condivisione di una connessione DCM condivisa per la collaborazione
id se desideri eliminare una connessione DCM