Box

Esempi di configurazione della connessione

Questa sezione elenca i valori di esempio per i vari campi che configuri durante la creazione della connessione.

Tipo di connessione del metodo del token JWT OAuth

Puoi accedere a ID client, client secret, livello di accesso all'applicazione Box e ID azienda/ID utente dall'account Box.

Puoi accedere alla chiave privata e alla password della chiave privata dal file Private keypair.json che hai scaricato. Per maggiori informazioni, consulta Informazioni sulla coppia di chiavi pubblica e privata. Inoltre, prima di passare la password della chiave privata, sostituisci \n nel file json con una nuova riga.

Tipo di connessione del codice di autorizzazione OAuth

Per informazioni sulla configurazione di Box OAuth, consulta Creare l'applicazione OAuth.

JSON di Box per il tipo di connessione del metodo di autenticazione JWT

Puoi utilizzare l'account Box per configurare Box Json per l'autenticazione JWT. Per informazioni su come configurare Box Json per JWT, vedi Passaggi per la creazione del token JWT

Accedi al valore Box Json per l'autenticazione JWT dal file Private keypair.json scaricato. Per saperne di più, consulta Informazioni sulla coppia di chiavi pubblica e privata. Devi trasmettere l'intero contenuto del file .json nel campo Box Json for JWT Auth.

Tipo di connessione Credenziali client OAuth

Puoi accedere a ID client, client secret, livello di accesso all'applicazione Box e ID azienda/ID utente dall'account Box.

Entità, operazioni e azioni

Tutti i connettori di integrazione forniscono un livello di astrazione per gli oggetti dell'applicazione connessa. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione ti viene mostrata come entità, operazioni e azioni.

• Entità : un'entità può essere considerata un oggetto o una raccolta di proprietà nell'applicazione o nel servizio connesso. La definizione di un'entità varia da un connettore all'altro. Ad esempio, in un connettore di database, le tabelle sono le entità, in un connettore del file server, le cartelle sono le entità e in un connettore del sistema di messaggistica, le code sono le entità.

  Tuttavia, è possibile che un connettore non supporti o non abbia entità, nel qual caso l'elenco Entities sarà vuoto.

• Operazione : un'operazione è l'attività che puoi eseguire su un'entità. Puoi eseguire una delle seguenti operazioni su un'entità:
  • Elenca
  • Scarica
  • Crea
  • Aggiorna
  • Elimina

  Selezionando un'entità dall'elenco disponibile, viene generato un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta le operazioni sulle entità dell'attività Connettori. Tuttavia, se un connettore non supporta alcuna delle operazioni sulle entità, queste operazioni non supportate non sono elencate nell'elenco Operations.

• Azione: un'azione è una funzione di prima classe resa disponibile per l'integrazione tramite l'interfaccia del connettore. Un'azione ti consente di apportare modifiche a una o più entità e varia da connettore a connettore. In genere, un'azione ha alcuni parametri di input e un parametro di output. Tuttavia, è possibile che un connettore non supporti alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Azioni

Questa sezione elenca tutte le azioni supportate dalla connessione Box.

Azione DownloadFile

Questa azione ti consente di scaricare un file dall'istanza Box.

Parametri di input dell'azione DownloadFile

Parametri di output dell'azione DownloadFile

Questa azione restituisce lo stato 200 (OK) con un corpo della risposta che indica i risultati.

Per un esempio di come configurare l'azione DownloadFile, consulta Esempi di azioni.

Azione UploadFile

Questa azione consente di caricare un file nell'istanza di Box.

Parametri di input dell'azione UploadFile

Parametri di output dell'azione UploadFile

Questa azione restituisce lo stato 200 (OK) con un corpo della risposta che indica i risultati.

Per un esempio di come configurare l'azione UploadFile, consulta Esempi di azioni.

Azione CopyFile

Questa azione ti consente di copiare un file dall'istanza di Box.

Parametri di input dell'azione CopyFile

Parametri di output dell'azione CopyFile

Questa azione restituisce lo stato 200 (OK) con un corpo della risposta che indica i risultati.

Per un esempio di come configurare l'azione CopyFile, consulta Esempi di azioni.

Azione CopyFolder

Questa azione ti consente di copiare un'intera cartella dall'istanza di Box.

Parametri di input dell'azione CopyFolder

Parametri di output dell'azione CopyFolder

Questa azione restituisce lo stato 200 (OK) con un corpo della risposta che indica i risultati.

Per un esempio di come configurare l'azione CopyFolder, consulta Esempi di azioni.

Esempi di azioni

Questa sezione descrive come eseguire alcune delle azioni in questo connettore.

Esempio: scaricare un file

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione DownloadFile, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "FileID": "1283194869422", 
   "HasBytes": true
   }

Questo esempio scarica un file come stringa codificata Base64. Se l'azione ha esito positivo, il parametro connectorOutputPayload della risposta dell'attività del connettore avrà un valore simile al seguente:

[
{ "Success": "True"},
{"ContentBytes": "JVBERi0xLjQKJcfl9OXwCjIgMCBvYmoKJSBbMjRdIAo8PAovRmlsdGVy"}
]

Esempio: carica un file

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione UploadFile, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "ParentId": "0",
   "Content": "12345"
   }

Questo esempio carica i contenuti della stringa come file. Se l'azione ha esito positivo, il parametro connectorOutputPayload della risposta dell'attività del connettore avrà un valore simile al seguente:

[{
"Success": "true",
"ID": "1283902965389",
"VersionID": "1403546001389",
"Hash": "8cb2237d0679ca88db6464eac60da96345513964",
"Etag": "0"
}]

Esempio: copiare un file

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione CopyFile, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "FileID": "1288751886061",
   "DestinationFolderId": "219105724517", 
   "NewName": "NewCopiedFile"
   }

Questo esempio copia il file con ID 1288751886061 nella cartella con ID 219105724517. Se l'azione ha esito positivo, il parametro connectorOutputPayload di risposta dell'attività del connettore avrà un valore simile al seguente:

[{
"Success": "true",
"ID": "1308006018536"
}]

Esempio: copia di una cartella

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione CopyFolder, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "FolderID": "218475301279",
   "DestinationFolderId": "0", 
   "NewName": "NewCopiedFolder"
   }

Questo esempio copia la cartella con ID 218475301279 nella cartella con ID 219105724517. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

[{
"Success": "true",
"ID": "226312444517"
}]

Esempi di operazioni sulle entità

Esempio: elenca tutti i file

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona File dall'elenco Entity.
3. Seleziona l'operazione LIST, quindi fai clic su Fine.

Puoi eseguire l'operazione LIST sulle seguenti entità: Folders, TrashedItems, SharedItems, Collaborations, TaskAssignments e Tasks

Esempio: scaricare i file

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona File dall'elenco Entity.
3. Seleziona l'operazione GET, quindi fai clic su Fine.
4. Imposta l'ID entità su 1262397830475, ovvero la chiave da trasferire. Per impostare l'ID entità, nella sezione Input attività dell'attività Connettori, fai clic su EntityId e poi inserisci 1262397830475 nel campo Valore predefinito.

Il valore di Entity Id deve essere passato direttamente, ad esempio 1262397830475. Dove 1262397830475 è il valore univoco della chiave primaria.

Puoi eseguire l'operazione GET sulle seguenti entità: cartelle, elementi condivisi, collaborazioni, assegnazioni di attività e attività

Esempio: eliminare i file

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona File dall'elenco Entity.
3. Seleziona l'operazione DELETE, quindi fai clic su Fine.
4. Imposta l'ID entità su 1258725940971, ovvero la chiave da trasferire. Per impostare l'ID entità, nella sezione Input attività dell'attività Connettori, fai clic su EntityId e poi inserisci 1258725940971 nel campo Valore predefinito.

   In alternativa, se l'entità ha due chiavi aziendali o primarie composite anziché specificare entityId, puoi anche impostare filterClause su Id='1258725940971'.

Puoi eseguire l'operazione DELETE sulle seguenti entità: Folders, Tasks, Collaborations, SharedItems e TaskAssignments

Esempio: creare cartelle

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Cartelle dall'elenco Entity.
3. Seleziona l'operazione Create, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "Name": "Google Cloud Platforms_created_folders",
   "ParentId": "0"
   }

   Se l'integrazione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività Folder avrà un valore simile al seguente:

    
   {
   "Id": "222269371053"
   } 

Esempio: creare collaborazioni

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Collaborazioni dall'elenco Entity.
3. Seleziona l'operazione Create, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "ItemId": "216592737829",
   "ItemType": "folder",
   "AccessibleById": "27370766275",
   "AccessibleByType": "user",
   "AccessibleByLogin": "baklavainthebalkans@gmail.com",
   "Role": "editor"
   }

   Se l'integrazione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività Folder avrà un valore simile a :

   {
   "Success": false
   } 

Esempio: creare attività

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Attività dall'elenco Entity.
3. Seleziona l'operazione Create, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "ItemId": "1253997361112",
   "ItemType": "file",
   "Action": "review",
   "Message": "Creating a task from Google Cloud Platform",
   "DueAt": "2023-12-12 09:01:15.0",
   "CompletionRule": "all_assignees"
   }

   Se l'integrazione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività Folder avrà un valore simile al seguente:

    
   {
   "Id": "1253997361112"
   }

Esempio: crea taskassignments

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona TaskAssignments dall'elenco Entity.
3. Seleziona l'operazione Create, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "TaskId": "21507516872",
   "AssignedToId": "27370766275"
   }

   Se l'integrazione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività Folder avrà un valore simile al seguente:

    
   {
   "Id": "50804351753"
   }

Esempio: aggiornare i file

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona File dall'elenco Entity.
3. Seleziona l'operazione Update, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "Name": "Get Started with Box Files.pdf"
   }

5. Imposta l'ID entità su 1253997361112. Per impostare l'ID entità, fai clic su entityId e poi inserisci 1253997361112 nel campo Valore predefinito.

   In alternativa, anziché specificare entityId, puoi anche impostare filterClause su 1253997361112.

   L'esecuzione di questo esempio restituisce una risposta simile alla seguente nella variabile di output connectorOutputPayload dell'attività Connettore:

   {
   "Id": "1253997361112"
   }

Puoi eseguire l'operazione UPDATE sulle seguenti entità: Folders, Tasks, Collaborations, SharedItems e TaskAssignments

Esempio: aggiornare le cartelle

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Cartelle dall'elenco Entity.
3. Seleziona l'operazione Update, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "Name": "Demo Update"
   }

5. Imposta l'ID entità su 216457668125. Per impostare l'ID entità, fai clic su entityId e poi inserisci 216457668125 nel campo Valore predefinito.

   In alternativa, anziché specificare entityId, puoi anche impostare filterClause su 216457668125.

   L'esecuzione di questo esempio restituisce una risposta simile alla seguente nella variabile di output connectorOutputPayload dell'attività Connettore:

   {
   "Id": "216457668125"
   } 

Esempio: aggiornamento delle collaborazioni

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Collaborazioni dall'elenco Entity.
3. Seleziona l'operazione Update, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "Role": "Viewer"
   }

5. Imposta l'ID entità su 46685648757. Per impostare l'ID entità, fai clic su entityId e poi inserisci 46685648757 nel campo Valore predefinito.

   In alternativa, anziché specificare entityId, puoi anche impostare filterClause su 46685648757.

   L'esecuzione di questo esempio restituisce una risposta simile alla seguente nella variabile di output connectorOutputPayload dell'attività Connettore:

   {
   
   }

Esempio: aggiornare le attività

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Attività dall'elenco Entity.
3. Seleziona l'operazione Update, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "Message": "This is a new task is updated and assigned to you by me"
   }

5. Imposta l'ID entità su 21507516872. Per impostare l'ID entità, fai clic su entityId e poi inserisci 21507516872 nel campo Valore predefinito.

   In alternativa, anziché specificare entityId, puoi anche impostare filterClause su 21507516872.

   L'esecuzione di questo esempio restituisce una risposta simile alla seguente nella variabile di output connectorOutputPayload dell'attività Connettore:

   {
   "Id": "21507516872"
   }

Esempio: aggiornamento di taskassignments

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona TaskAssignments dall'elenco Entity.
3. Seleziona l'operazione Update, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "Message": "Looks good to me",
   "ResolutionState": "completed"
   }

5. Imposta l'ID entità su 49542929469. Per impostare l'ID entità, fai clic su entityId e poi inserisci 49542929469 nel campo Valore predefinito.

   In alternativa, anziché specificare entityId, puoi anche impostare filterClause su 49542929469.

   L'esecuzione di questo esempio restituisce una risposta simile alla seguente nella variabile di output connectorOutputPayload dell'attività Connettore:

   {
   "Id": "49542929469"
   } 

Esempio: aggiornamento di Transferfolders

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Cartelle dall'elenco Entity.
3. Seleziona l'operazione Update, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "Name": "Demo Update"
   "ParentId": "216596059374"
   }

5. Imposta l'ID entità su 216457668125. Per impostare l'ID entità, fai clic su entityId e poi inserisci 216457668125 nel campo Valore predefinito.

   L'esecuzione di questo esempio restituisce una risposta simile alla seguente nella variabile di output connectorOutputPayload dell'attività Connettore:

   {
   "Id": "216457668125"
   }