Skip to main content

Endpoint delle connessioni Server

Endpoint e parametri delle connessioni 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 la pagina di assistenza Connessioni dati .

Recupero dei record di tutte le connessioni dati

Per recuperare i record di tutte le connessioni dati di Server accessibili, utilizza l'endpoint GET {baseURL}/v3/serverDataConnections .

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • view (stringa): opzionale. È possibile non specificare alcun valore o selezionare "Default" e "Full". Se il parametro è impostato su "Default", viene restituito un oggetto vista ridotto. Se non è specificato alcun valore, viene utilizzato "Default".

Esempio di richiesta: cURL

curl --location --request GET 'http://localhost/webapi/v3/serverDataConnections' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Recupero del record di una connessione dati specifica

Per recuperare informazioni su una connessione dati di Server esistente, utilizza l'endpoint GET {baseURL}/v3/serverDataConnections /{dataConnectionId} .

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • dataConnectionId (stringa): obbligatorio. Immetti l'ID di una connessione dati di Server per ottenere le informazioni sulla stessa.

Esempio di richiesta: cURL

curl --location --request GET 'http://localhost/webapi/v3/serverDataConnections/61dec3bc536c221013530fa' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Aggiornamento di una connessione dati esistente

Per aggiornare il parametro name di una connessione dati di Server esistente, utilizza l'endpoint PUT {baseURL}/v3/serverDataConnections/{dataConnectionId} .

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • dataConnectionId (stringa): obbligatorio. Immetti l'ID della connessione dati di Server che desideri aggiornare.

  • updateServerConnectionContract (corpo): obbligatorio. Immetti un nuovo nome per una connessione dati:

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

Esempio di richiesta: cURL

curl --location --request PUT 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c21013530fa' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Oracle DB Connection'

Condivisione di una connessione dati di Server con un utente

Per condividere una connessione dati di Server esistente con un utente esistente, utilizza l'endpoint POST {baseURL}/v3/serverDataConnections/{dataConnectionId}/users .

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • dataConnectionId (stringa): obbligatorio. Immetti l'ID della connessione dati di Server a cui aggiungere un utente.

  • contract (corpo): obbligatorio. Immetti le informazioni sull'utente che desideri aggiungere a una connessione dati:

    • userId (stringa): obbligatorio. Specifica l'ID di un utente che desideri aggiungere a una connessione dati.

Esempio di richiesta: cURL

curl --location --request POST 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/users' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'userId=61dec95f5436c22101353193'

Condivisione di una connessione dati di Server con un gruppo di utenti

Per condividere una connessione dati di Server esistente con un gruppo di utenti esistente, utilizza l'endpoint POST {baseURL}/v3/serverDataConnections/{dataConnectionId}/userGroups .

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • dataConnectionId (stringa): obbligatorio. Immetti l'ID della connessione dati di Server a cui aggiungere un gruppo di utenti.

  • contract (corpo): obbligatorio. Immetti le informazioni sul gruppo di utenti che desideri aggiungere a una connessione dati:

    • userGroupId (stringa): obbligatorio. Specifica l'ID di un gruppo di utenti che desideri aggiungere a una connessione dati.

Esempio di richiesta: cURL

curl --location --request POST 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/userGroups' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'userGroupId=61decb225436c2210135336f'

Rimozione delle autorizzazioni di un utente per l'uso di una connessione dati di Server

Per rimuovere le autorizzazioni di un utente per l'uso di una connessione dati di Server esistente, utilizza l'endpoint DELETE {baseURL}/v3/serverDataConnections/{dataConnectionId}/users/{userId} .

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • dataConnectionId (stringa): obbligatorio. Immetti l'ID della connessione dati di Server che desideri aggiornare.

  • userId (stringa): obbligatorio. Immetti l'ID di un utente che desideri rimuovere dalla connessione dati.

Esempio di richiesta: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/users/61dec95f5436c22101353193' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Rimozione delle autorizzazioni di un gruppo di utenti per l'uso di una connessione dati di Server

Per rimuovere le autorizzazioni di un gruppo di utenti per l'uso di una connessione dati di Serve esistente, utilizza l'endpoint DELETE {baseURL}/v3/serverDataConnections/{dataConnectionId}/userGroups/{userGroupId} .

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • dataConnectionId (stringa): obbligatorio. Immetti l'ID della connessione dati di Server che desideri aggiornare.

  • userGroupId (stringa): obbligatorio. Immetti l'ID di un gruppo di utenti che desideri rimuovere dalla connessione dati.

Esempio di richiesta: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa/userGroups/61decb225436c2210135336f' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Eliminazione di una connessione dati di Server

Per eliminare una connessione dati di Server esistente, utilizza l'endpoint DELETE {baseURL}/v3/serverDataConnections/{dataConnectionId} .

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • dataConnectionId (stringa): obbligatorio. Immetti l'ID della connessione dati di Server che desideri eliminare.

Esempio di richiesta: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/serverDataConnections/61dec3bc5436c221013530fa' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Relazioni tra oggetti

Per il momento non sono presenti riferimenti per le connessioni dati di Server. Il vantaggio di poter modificare le connessioni dati consiste nella possibilità di concedere o impedire l'accesso alle stesse. Ciò agevola l'onboarding di determinate autorizzazioni per le origini dati.

Esempi di richiesta Postman

GET /v3/serverDataConnections

Use the GET /v3/serverDataConnections endpoint.

PUT /v3/serverDataConnections/{dataConnectionId}

Use the PUT /v3/serverDataConnections/{dataConnectionId} endpoint.

Per ulteriori informazioni sulle richieste Postman, consulta la pagina di assistenza Come usare Postman.

In questa sezione: