Skip to main content

Punti finali di raccolta

Endpoint e parametri della raccolta

Creazione di una raccolta

Aggiungi un utente a una raccolta

Aggiungi un insight a una raccolta

Aggiungi una pianificazione a una raccolta

Aggiungi un flusso di lavoro a una raccolta

Aggiunta di un utente o di un gruppo a una raccolta

Recupera un record di raccolta

Recuperare i record di tutte le raccolte

Aggiornamento di un flusso di lavoro esistente

Aggiornare le autorizzazioni utente di una raccolta

Aggiornare le autorizzazioni del gruppo di utenti di una raccolta

Rimuovi un utente da una raccolta

Rimuovi un flusso di lavoro da una raccolta

Rimuovi un insight da una raccolta

Rimuovi una pianificazione da una raccolta

Rimozione di un utente o di un gruppo da una raccolta

Elimina 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 raccolta

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

Parametri

  • Contratto (corpo): Per creare una raccolta, il parametro del contratto è obbligatorio. Per creare una raccolta, specificate quanto segue:

    • name  (stringa): obbligatorio. Specificare un nome di 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'

Aggiungi un utente a una raccolta

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

082A8515AB7ADDAAD5B04255CF2AE567.png

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID raccolta a cui specificare la raccolta a cui aggiungere un utente.

  • updateWorkflowContract  (corpo): obbligatorio. Immettere informazioni sugli utenti e le relative autorizzazioni. Specificare quanto segue per aggiungere utenti a una raccolta:

    • workflowCredentialType (stringa): obbligatorio. Specificare l'ID di un utente che si desidera aggiungere a una raccolta.

    • versionId (stringa): opzionale. Specificare la data di scadenza per l'utente che deve far parte di questa raccolta. Specifica la data e l'ora in formato ISO8601 .

    • Collectionsautorizzazioni (corpo):

      • isPublic  (booleano): obbligatorio. Specificare se l'utente deve essere amministratore per questa raccolta.

      • CanAddAssets (booleano): Obbligatorio. Specificare se l'utente può aggiungere risorse alla raccolta.

      • CanUpdateAssets (booleano): Obbligatorio. Specificare se l'utente può aggiornare le risorse nella raccolta.

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

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

      • force  (booleano): opzionale. Specificare se l'utente può rimuovere 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 'autorizzazione: Bearer BearerTokenGoesHere' \ --data-urlencode 'UserID=61d80f862835728c94328082' \ --data-urlensers-urlenets-true-2007 924

Aggiungi un insight a una raccolta

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

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID raccolta a cui specificare la raccolta a cui aggiungere un insight.

  • Contratto (corpo): Obbligatorio. Immettere informazioni sul insight. Specificare quanto segue:

    • workflowCredentialType (stringa): obbligatorio. Specificare l'ID insight che si desidera 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'

Aggiungi una pianificazione a una raccolta

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

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID raccolta a cui specificare la raccolta a cui aggiungere una pianificazione.

  • Contratto (corpo): Obbligatorio. Immettere informazioni sulla pianificazione. Specificare quanto segue:

    • workflowCredentialType (stringa): obbligatorio. Specificare l'ID pianificazione che si desidera 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'

Aggiungi un flusso di lavoro a una raccolta

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

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID raccolta a cui specificare la raccolta a cui aggiungere un insight.

  • Contratto (corpo): Obbligatorio. Immettere informazioni sugli utenti e le relative autorizzazioni. Specificare quanto segue:

    • workflowId  (stringa): obbligatorio. Specificare l'ID del flusso di lavoro che si desidera 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 utente o di un gruppo a una raccolta

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

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID raccolta a cui specificare la raccolta a cui aggiungere un gruppo di utenti.

  • updateWorkflowContract  (corpo): obbligatorio. Immettere informazioni sul gruppo di utenti e le relative autorizzazioni. Specificare quanto segue:

    • versionId  (stringa): obbligatorio. Specificare l'ID di un gruppo di utenti che si desidera aggiungere a una raccolta.

    • versionId  (stringa): opzionale. Specificare la data di scadenza per il gruppo di utenti da far parte di questa raccolta. Immetti la data e l'ora dopo le quali è stato creato il flusso di lavoro.

    • CollectionsPermissions (corpo): Obbligatorio.

      • hasPrivateDataExemption  (booleano): opzionale. Specificare se i membri del gruppo di utenti devono essere amministratori per questa raccolta. L'impostazione predefinita è false.

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

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

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

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

      • makePublished  (booleano): obbligatorio. Specificare 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-urlensers

Recupera un record di raccolta

Per recuperare le informazioni su una raccolta, usate l' {baseURL}{collectionId} endpoint GET /v3/collections/.

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID raccolta per ottenere le informazioni sulla raccolta.

Esempio di richiesta: cURL

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

Recuperare i record di tutte le raccolte

Per recuperare tutti i record di raccolta accessibili, utilizzare l' {baseURL} endpoint GET /v3/collections.

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/workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Aggiornamento di un flusso di lavoro esistente

Per modificare il nome o il proprietario di una raccolta, usate l' {baseURL}{collectionId} endpoint PUT /v3/collections/.

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immetti l'ID del flusso di lavoro da aggiornare.

  • updateWorkflowContract  (corpo): obbligatorio. Immettere le informazioni sul proprietario della raccolta che si desidera modificare. Specificare quanto segue:

    • name  (stringa): obbligatorio. Fare clic sul nome della raccolta.

    • ownerId  (stringa): obbligatorio. Immetti l'ID del 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'

Aggiornare le autorizzazioni utente di una raccolta

Per aggiornare le autorizzazioni utente per una determinata raccolta, utilizzare l' {baseURL}{collectionId}{userId} endpoint PUT /v3/collections/ /users/ /permissions.

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immetti l'ID del flusso di lavoro da aggiornare.

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID utente per cui si desidera modificare le autorizzazioni.

  • updateWorkflowContract  (corpo): obbligatorio. Immettere l'ID utente per il quale si desidera modificare le autorizzazioni. Specificare quanto segue:

    • Data di scadenza (data): Obbligatorio. Specificare la data di scadenza di un utente.

    • CollectionsPermissions (corpo): Obbligatorio. Immetti l'ID del proprietario. Specificare quanto segue:

      • isPublic  (booleano): obbligatorio. Specificare se l'utente deve essere amministratore per questa raccolta.

      • CanAddAssets (booleano): Obbligatorio. Specificare se l'utente può aggiungere risorse alla raccolta.

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

      • CanUpdateAssets (booleano): Obbligatorio. Specificare se l'utente può aggiornare le risorse nella raccolta.

      • CanAddUsers (booleano): Obbligatorio. Specificare se l'utente può aggiungere altri utenti alla raccolta.

      • makePublished  (booleano): obbligatorio. Specificare 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'

Aggiornare le autorizzazioni del gruppo di utenti di una raccolta

Per aggiornare le autorizzazioni del gruppo utenti per una determinata raccolta, utilizzare l' {baseURL}{collectionId}{userGroupId} endpoint PUT /v3/collections/ /usergroups/ /permissions.

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immetti l'ID del flusso di lavoro da aggiornare.

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID gruppo utente per cui si desidera modificare le autorizzazioni.

  • updateWorkflowContract  (corpo): obbligatorio. Immettere l'ID del gruppo utente per il quale si desidera modificare le autorizzazioni. Specificare quanto segue:

    • Data di scadenza (data): Facoltativo. Specificare la data di scadenza per un gruppo di utenti.

    • CollectionsPermissions (corpo): Obbligatorio. Specificare quanto segue:

      • isPublic  (booleano): obbligatorio. Specificare se i membri del gruppo di utenti devono essere amministratori per questa raccolta.

      • CanAddAssets (booleano): Obbligatorio. Specificare se i membri del gruppo di utenti possono aggiungere risorse alla raccolta.

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

      • CanUpdateAssets (booleano): Obbligatorio. Specificare se i membri del gruppo di utenti possono aggiornare le risorse nella raccolta.

      • CanAddUsers (booleano): Obbligatorio. Specificare se i membri del gruppo di utenti possono aggiungere altri utenti alla raccolta.

      • makePublished  (booleano): obbligatorio. Specificare 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' \

Rimuovi un utente da una raccolta

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

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immetti l'ID del flusso di lavoro da aggiornare.

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID utente che si desidera rimuovere dalla raccolta.

Esempio di richiesta: cURL

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

Rimuovi un flusso di lavoro da una raccolta

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

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immetti l'ID del flusso di lavoro da aggiornare.

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID flusso di lavoro che si desidera rimuovere dalla raccolta.

Esempio di richiesta: cURL

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

Rimuovi un insight da una raccolta

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

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immetti l'ID del flusso di lavoro da aggiornare.

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID insight che si desidera rimuovere dalla raccolta.

Esempio di richiesta: cURL

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

Rimuovi una pianificazione da una raccolta

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

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immetti l'ID del flusso di lavoro da aggiornare.

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID pianificazione che si desidera rimuovere dalla raccolta.

Esempio di richiesta: cURL

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

Rimozione di un utente o di un gruppo da una raccolta

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

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immetti l'ID del flusso di lavoro da aggiornare.

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID gruppo utente che si desidera rimuovere dalla raccolta.

Esempio di richiesta: cURL

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

Elimina una raccolta

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

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immetti l'ID del flusso di lavoro da aggiornare.

  • hasPrivateDataExemption  (booleano): opzionale. Selezionare se si desidera forzare l'eliminazione di una raccolta nel caso in cui questa contenga collegamenti ad altri oggetti, come utenti, gruppi, flussi di lavoro, approfondimenti e pianificazioni. Se si desidera eliminare la raccolta e ripulire tutti i collegamenti, impostare il parametro forceDelete su true. In assenza di una specifica, il valore predefinito è "false". Questo parametro viene utilizzato per proteggere da una chiamata non corretta.

Esempio di richiesta: cURL

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

Relazioni tra oggetti

Se stai caricando un flusso di lavoro, puoi utilizzare gli oggetti creati nel modo seguente:

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

Puoi utilizzarlo come:

Esempi di richiesta Postman

PUBBLICA /v3/raccolte

Use POST /v3/collections endpoint.

OTTIENI /v3/Collection/

Use GET /v3/collections endpoint.

INSERIRE /v3/Collection/{collectionId}

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

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

In questa sezione: