Skip to main content

Endpoint delle raccolte

Endpoint e parametri della raccolta

Creazione di una nuova raccolta

Aggiunta di un utente a una raccolta

Aggiunta di un insight a una raccolta

Aggiunta di una pianificazione a una raccolta

Aggiunta di un flusso di lavoro a una raccolta

Aggiunta di un gruppo di utenti a una raccolta

Recupero del record di una raccolta

Recupero dei record di tutte le raccolte

Aggiornamento di una raccolta esistente

Aggiornamento delle autorizzazioni dell'utente di una raccolta

Aggiornamento delle autorizzazioni del gruppo di utenti di una raccolta

Rimozione di un utente da una raccolta

Rimozione di un flusso di lavoro da una raccolta

Rimozione di un insight da una raccolta

Rimozione di una pianificazione da una raccolta

Rimozione di un gruppo di utenti da una raccolta

Eliminazione di una raccolta

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

Per ulteriori informazioni sulle raccolte, consulta la pagina di assistenza Raccolte.

Creazione di una nuova raccolta

Per creare una raccolta, utilizza l'endpoint POST {baseURL}/v3/collections.

Nota

Solo gli amministratori possono usare questo endpoint API. L'utente API autenticato deve disporre dell'autorizzazione "Crea raccolte" per utilizzare questo endpoint. In caso contrario, viene restituito l'errore 401 Autorizzazione negata.

Parametri

  • contract (corpo): questo parametro è obbligatorio per creare una raccolta. Specifica quanto segue per creare una raccolta:

    • name (stringa): obbligatorio. Specifica il nome di una raccolta.

Esempio di richiesta: cURL

curl --location --request POST 'http://localhost/webapi//v3/collections' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting'

Aggiunta di un utente a una raccolta

Per aggiungere un utente a una raccolta esistente, utilizza l'endpoint POST {baseURL}/v3/collections/{collectionId}/users.

Nota

Solo gli amministratori possono usare questo endpoint API.

082A8515AB7ADDAAD5B04255CF2AE567.png

Parametri

  • collectionId (stringa): obbligatorio. Immetti l'ID della raccolta a cui aggiungere un utente.

  • addUsersContract (corpo): obbligatorio. Immetti informazioni sugli utenti e sulle relative autorizzazioni. Specifica quanto segue per aggiungere utenti a una raccolta:

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

    • expirationDate (stringa): opzionale. Specifica la data di scadenza per l'ammissione dell'utente a questa raccolta. Immetti la data e l'ora in formato ISO8601.

    • collectionsPermissions (corpo):

      • isAdmin (booleano): obbligatorio. Specifica se l'utente deve essere l'amministratore della raccolta.

      • canAddAssets (booleano): obbligatorio. Specifica se l'utente può aggiungere risorse alla raccolta.

      • canUpdateAssets (booleano): obbligatorio. Specifica se l'utente può aggiornare le risorse nella raccolta.

      • canRemoveAssets (booleano): obbligatorio. Specifica se l'utente può rimuovere le risorse dalla raccolta.

      • canAddUsers (booleano): opzionale. Specifica se l'utente può aggiungere altri utenti alla raccolta.

      • canRemoveUsers(booleano): opzionale. Specifica se l'utente può rimuovere gli utenti dalla raccolta.

Per ulteriori informazioni sui ruoli e sulle autorizzazioni, consulta la pagina Ruoli utente e autorizzazioni. Se non è selezionato alcun ruolo, default (predefinito) è il ruolo predefinito specificato da un amministratore di Server nell'interfaccia di amministrazione.

Esempio di richiesta: cURL

curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/users' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'userId=61d80f862835728c94328082' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=true' \ --data-urlencode 'canRemoveAssets=true' \ --data-urlencode 'canUpdateAssets=true' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true' \ --data-urlencode 'expirationDate=2007-08-17T19:18:11.924Z'

Aggiunta di un insight a una raccolta

Per aggiungere un insight a una raccolta esistente, utilizza l'endpoint POST {baseURL}/v3/collections/{collectionId}/insights.

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • collectionId (stringa): obbligatorio. Immetti l'ID della raccolta a cui aggiungere un insight.

  • contract (corpo): obbligatorio. Immetti informazioni sull'insight. Specifica quanto segue:

    • insightId (stringa): obbligatorio. Specifica l'ID dell'insight che desideri aggiungere alla raccolta.

Esempio di richiesta: cUrl

curl --location --request POST 'http://localhost/webapi//v3/collections/472dfff22086458d935d4edf348a1e2b/insights' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'insightId=61d80f33452835728c94328082'

Aggiunta di una pianificazione a una raccolta

Per aggiungere una pianificazione a una raccolta esistente, utilizza l'endpoint POST {baseURL}/v3/collections/{collectionId}/schedules.

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • collectionId (stringa): obbligatorio. Immetti l'ID della raccolta a cui aggiungere la pianificazione.

  • contract (corpo): obbligatorio. Immetti informazioni sulla pianificazione. Specifica quanto segue:

    • scheduleId (stringa): obbligatorio. Specifica l'ID della pianificazione che desideri aggiungere alla raccolta.

Esempio di richiesta: cURL

curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/schedules' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'scheduleId=61d80f334528377728c94328082'

Aggiunta di un flusso di lavoro a una raccolta

Per aggiungere un flusso di lavoro a una raccolta esistente, utilizza l'endpoint POST {baseURL}/v3/collections/{collectionId}/workflows.

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • collectionId (stringa): obbligatorio. Immetti l'ID della raccolta a cui aggiungere un insight.

  • contract (corpo): obbligatorio. Immetti informazioni sugli utenti e sulle relative autorizzazioni. Specifica quanto segue:

    • workflowId (stringa): obbligatorio. Specifica l'ID del flusso di lavoro che desideri aggiungere alla raccolta.

Esempio di richiesta: cURL

curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/workflows' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'workflowId=61d80f334223377728c9432'

Aggiunta di un gruppo di utenti a una raccolta

Per aggiungere un gruppo di utenti a una raccolta esistente, utilizza l'endpoint POST {baseURL}/v3/collections/{collectionId}/userGroups.

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • collectionId (stringa): obbligatorio. Immetti l'ID della raccolta a cui aggiungere un gruppo di utenti.

  • addUserGroupsContract (corpo): obbligatorio. Immetti informazioni sul gruppo di utenti e sulle relative autorizzazioni. Specifica quanto segue:

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

    • expirationDate (stringa): opzionale. Specifica la data di scadenza per l'ammissione del gruppo di utenti a questa raccolta. Immetti la data e l'ora dopo le quali è stato creato l'utente in formato ISO8601.

    • collectionsPermissions (corpo): obbligatorio.

      • isAdmin (booleano): opzionale. Specifica se i membri del gruppo di utenti devono essere amministratori della raccolta. L'impostazione predefinita è false.

      • canAddAssets (booleano): opzionale. Specifica se i membri del gruppo di utenti possono aggiungere risorse alla raccolta. L'impostazione predefinita è false.

      • canRemoveAssets (booleano): opzionale. Specifica se i membri del gruppo di utenti possono rimuovere le risorse dalla raccolta. L'impostazione predefinita è false.

      • canUpdateAssets (booleano): opzionale. Specifica se i membri del gruppo di utenti possono aggiornare le risorse nella raccolta. L'impostazione predefinita è false.

      • canAddUsers (booleano): opzionale. Specifica se i membri del gruppo di utenti possono aggiungere altri utenti alla raccolta. L'impostazione predefinita è false.

      • canRemoveUsers (booleano): obbligatorio. Specifica se i membri del gruppo di utenti possono rimuovere altri utenti dalla raccolta. L'impostazione predefinita è false.

Per ulteriori informazioni sui ruoli e sulle autorizzazioni, consulta la pagina Ruoli utente e autorizzazioni. Se non è selezionato alcun ruolo, default (predefinito) è il ruolo predefinito specificato da un amministratore di Server nell'interfaccia di amministrazione.

Esempio di richiesta: cURL

curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/userGroups?addUserGroupsContract' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'userGroupId=61d83e2ef778247f14e8e6b6' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=false' \ --data-urlencode 'canRemoveAssets=true' \ --data-urlencode 'canUpdateAssets=false' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true'

Recupero del record di una raccolta

Per recuperare i dettagli di una raccolta esistente, utilizza l'endpoint GET {baseURL}/v3/collections/{collectionId}.

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • collectionId (stringa): obbligatorio. Immetti l'ID di una raccolta per ricevere informazioni sulla stessa.

Esempio di richiesta: cURL

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

Recupero dei record di tutte le raccolte

Per recuperare i record di tutte le raccolte accessibili, utilizza l'endpoint GET {baseURL}/v3/collections.

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/collections?view=Full' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Aggiornamento di una raccolta esistente

Per aggiornare il nome e/o il proprietario di una raccolta esistente, utilizza l'endpoint PUT {baseURL}/v3/collections/{collectionId}.

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • collectionId (stringa): obbligatorio. Immetti l'ID della raccolta che desideri aggiornare.

  • updateCollectionContract (corpo): obbligatorio. Immetti le informazioni sul proprietario della raccolta che desideri modificare. Specifica quanto segue:

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

    • ownerId (stringa): obbligatorio. Immetti l'ID del nuovo proprietario.

Esempio di richiesta: cURL

curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting' \ --data-urlencode 'ownerId=61db388fc565144387d45086'

Aggiornamento delle autorizzazioni dell'utente di una raccolta

Per aggiornare le autorizzazioni utente all'interno di una raccolta esistente, utilizza l'endpoint PUT {baseURL}/v3/collections/{collectionId}/users/{userId}/permissions.

Nota

Solo gli amministratori possono usare questo endpoint API. Per le istanze di Server configurate con l'autenticazione di Windows, specifica il Sid Active Directory per il parametro userId.

Parametri

  • collectionId (stringa): obbligatorio. Immetti l'ID della raccolta che desideri aggiornare.

  • userId (stringa): obbligatorio. Immetti l'ID di un utente per cui desideri modificare le autorizzazioni.

  • updatePermissionsContract (corpo): obbligatorio. Immetti l'ID dell'utente per cui desideri modificare le autorizzazioni. Specifica quanto segue:

    • expirationDate (data): obbligatorio. Specifica la data di scadenza relativa a un utente.

    • collectionsPermissions (corpo): obbligatorio. Immetti l'ID utente del nuovo proprietario. Specifica quanto segue:

      • isAdmin (booleano): obbligatorio. Specifica se l'utente deve essere l'amministratore della raccolta.

      • canAddAssets (booleano): obbligatorio. Specifica se l'utente può aggiungere risorse alla raccolta.

      • canRemoveAssets (booleano): obbligatorio. Specifica se l'utente può rimuovere le risorse dalla raccolta.

      • canUpdateAssets (booleano): obbligatorio. Specifica se l'utente può aggiornare le risorse nella raccolta.

      • canAddUsers (booleano): obbligatorio. Specifica se l'utente può aggiungere altri utenti alla raccolta.

      • canRemoveUsers (booleano): obbligatorio. Specifica se l'utente può rimuovere altri utenti dalla raccolta.

Per ulteriori informazioni sui ruoli e sulle autorizzazioni, consulta la pagina Ruoli utente e autorizzazioni. Se non è selezionato alcun ruolo, default (predefinito) è il ruolo predefinito specificato da un amministratore di Server nell'interfaccia di amministrazione.

Esempio di richiesta: cURL

curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/users/61db388fc565144387d45086/permissions' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=true' \ --data-urlencode 'canRemoveAssets=true' \ --data-urlencode 'canUpdateAssets=true' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true'

Aggiornamento delle autorizzazioni del gruppo di utenti di una raccolta

Per aggiornare le autorizzazioni del gruppo di utenti all'interno di una raccolta esistente, utilizza l'endpoint PUT {baseURL}/v3/collections/{collectionId}/userGroups/{userGroupId}/permissions.

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • collectionId (stringa): obbligatorio. Immetti l'ID della raccolta che desideri aggiornare.

  • userGroupId (stringa): obbligatorio. Immetti l'ID di un gruppo di utenti per cui desideri modificare le autorizzazioni.

  • updatePermissionsContract (corpo): obbligatorio. Immetti l'ID del gruppo di utenti per cui desideri modificare le autorizzazioni. Specifica quanto segue:

    • expirationDate (data): opzionale. Specifica la data di scadenza relativa a un gruppo di utenti.

    • collectionsPermissions (corpo): obbligatorio. Specifica quanto segue:

      • isAdmin (booleano): obbligatorio. Specifica se i membri del gruppo di utenti devono essere amministratori della raccolta.

      • canAddAssets (booleano): obbligatorio. Specifica se i membri del gruppo di utenti possono aggiungere risorse alla raccolta.

      • canRemoveAssets (booleano): obbligatorio. Specifica se i membri del gruppo di utenti possono rimuovere le risorse dalla raccolta.

      • canUpdateAssets (booleano): obbligatorio. Specifica se i membri del gruppo di utenti possono aggiornare le risorse nella raccolta.

      • canAddUsers (booleano): obbligatorio. Specifica se i membri del gruppo di utenti possono aggiungere altri utenti alla raccolta.

      • canRemoveUsers (booleano): obbligatorio. Specifica se i membri del gruppo di utenti possono rimuovere gli utenti dalla raccolta.

Per ulteriori informazioni sui ruoli e sulle autorizzazioni, consulta la pagina Ruoli utente e autorizzazioni. Se non è selezionato alcun ruolo, default (predefinito) è il ruolo predefinito specificato da un amministratore di Server nell'interfaccia di amministrazione.

Esempio di richiesta: cURL

curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/userGroups/61db38834tssrdrs4cc65144387d4508/permissions' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=true' \ --data-urlencode 'canRemoveAssets=false' \ --data-urlencode 'canUpdateAssets=true' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true'

Rimozione di un utente da una raccolta

Per rimuovere un utente da una raccolta esistente, utilizza l'endpoint DELETE {baseURL}/v3/collections/{collectionId}/users/{userId}.

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • collectionId (stringa): obbligatorio. Immetti l'ID della raccolta che desideri aggiornare.

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

Esempio di richiesta: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/users/61db388fc565144387d45086' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Rimozione di un flusso di lavoro da una raccolta

Per rimuovere un flusso di lavoro da una raccolta esistente, utilizza l'endpoint DELETE {baseURL}/v3/collections/{collectionId}/workflows/{appId}.

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • collectionId (stringa): obbligatorio. Immetti l'ID della raccolta che desideri aggiornare.

  • appId (stringa): obbligatorio. Immetti l'ID di un flusso di lavoro che desideri rimuovere dalla raccolta.

Esempio di richiesta: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/workflows/61db388fc565144387d45086' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Rimozione di un insight da una raccolta

Per rimuovere un insight da una raccolta esistente, utilizza l'endpoint DELETE {baseURL}/v3/collections/{collectionId}/insights/{insightId}.

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • collectionId (stringa): obbligatorio. Immetti l'ID della raccolta che desideri aggiornare.

  • insightId (stringa): obbligatorio. Immetti l'ID di un insight che desideri rimuovere dalla raccolta.

Esempio di richiesta: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/insights/61db388fc565144387d450867' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Rimozione di una pianificazione da una raccolta

Per rimuovere una pianificazione da una raccolta esistente, utilizza l'endpoint DELETE {baseURL}/v3/collections/{collectionId}/schedules/{scheduleId}.

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • collectionId (stringa): obbligatorio. Immetti l'ID della raccolta che desideri aggiornare.

  • scheduleId (stringa): obbligatorio. Immetti l'ID di una pianificazione che desideri rimuovere dalla raccolta.

Esempio di richiesta: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/schedules/61db3777c565144387d450867' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Rimozione di un gruppo di utenti da una raccolta

Per rimuovere un gruppo di utenti da una raccolta esistente, utilizza l'endpoint DELETE {baseURL}/v3/collections/{collectionId}/userGroups/{userGroupId}.

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • collectionId (stringa): obbligatorio. Immetti l'ID della raccolta che desideri aggiornare.

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

Esempio di richiesta: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/userGroups/61dc063d9938fe43b5e8fc80' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Eliminazione di una raccolta

Per eliminare una raccolta, utilizza l'endpoint DELETE {baseURL}/v3/collections/{collectionId}.

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • collectionId (stringa): obbligatorio. Immetti l'ID della raccolta che desideri aggiornare.

  • forceDelete (booleano): opzionale. Scegli se forzare l'eliminazione di una raccolta nel caso in cui contenga collegamenti ad altri oggetti, come utenti, gruppi, flussi di lavoro, insight e pianificazioni. Se desideri eliminare la raccolta e rimuovere tutti i collegamenti, imposta il parametro forceDelete su true. In assenza di una specifica, il valore predefinito è false. Questo parametro viene utilizzato per evitare una chiamata errata.

Esempio di richiesta: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/253fcf0b10204dc085f07bdf1b40e759?forceDelete=true' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Relazioni tra oggetti

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

Oggetto creato: "id" (ad esempio, "id": "7917969784f84bd09442f66996ecb8f3")

Puoi utilizzarlo come:

Esempi di richiesta Postman

POST /v3/collections

Use POST /v3/collections endpoint.

GET /v3/collections/

Use GET /v3/collections endpoint.

PUT /v3/collections/{collectionId}

Use PUT /v3/collections/{collectionId} endpoint.

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

In questa sezione: