Box

Exemples de configuration de connexion

Cette section présente des exemples de valeurs pour les différents champs que vous configurez lorsque vous créez la connexion.

Type de connexion avec la méthode de jeton OAuth JWT

Vous pouvez accéder à l'ID client, au code secret du client, au niveau d'accès à l'application Box et à l'ID d'entreprise/d'utilisateur depuis le compte Box.

Vous pouvez accéder à la clé privée et au mot de passe de la clé privée à partir du fichier Private keypair.json que vous avez téléchargé. Pour en savoir plus, consultez Informations sur la paire de clés publique et privée. De plus, avant de transmettre le mot de passe de la clé privée, remplacez \n dans le fichier json par une nouvelle ligne.

Type de connexion avec un code d'autorisation OAuth

Pour en savoir plus sur la configuration d'OAuth pour Box, consultez Créer votre application OAuth.

Type de connexion Box Json pour la méthode d'authentification JWT

Vous pouvez utiliser le compte Box pour configurer Box Json pour l'authentification JWT. Pour savoir comment configurer Box Json pour JWT, consultez Étapes de création d'un jeton JWT .

Accédez à la valeur d'authentification JWT du fichier Box JSON à partir du fichier Private keypair.json que vous avez téléchargé. Pour en savoir plus, consultez Informations sur la paire de clés publique et privée. Vous devez transmettre l'intégralité du contenu du fichier .json dans le champ Box Json for JWT Auth (Box Json pour l'authentification JWT).

Type de connexion avec des identifiants client OAuth

Vous pouvez accéder à l'ID client, au code secret du client, au niveau d'accès à l'application Box, ainsi qu'à l'ID d'entreprise ou d'utilisateur depuis le compte Box.

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que par le biais de cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

• Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connectés. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, alors que dans un connecteur de serveur de fichiers, ce sont les dossiers, et dans un connecteur de système de messagerie, ce sont les files d'attente.

  Toutefois, il est possible qu'un connecteur n'accepte ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.

• Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Voici les opérations possibles :
  • List
  • Get
  • Create
  • Update
  • Delete

  Lorsque vous sélectionnez une entité dans la liste proposée, cela génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche "Connecteurs". Cependant, si un connecteur n'accepte pas l'une des opérations d'entité, cette opération non compatible ne figure pas dans la liste Operations.

• Action : une action est une fonction de première classe mise à la disposition de l'intégration par le biais de l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et un paramètre de sortie. Toutefois, il est possible qu'un connecteur n'accepte aucune action, auquel cas la liste Actions est vide.

Actions

Cette section liste toutes les actions compatibles avec la connexion Box.

Action DownloadFile

Cette action vous permet de télécharger un fichier depuis votre instance Box.

Paramètres d'entrée de l'action DownloadFile

Paramètres de sortie de l'action DownloadFile

Cette action renvoie l'état 200 (OK) avec un corps de réponse indiquant les résultats.

Pour savoir comment configurer l'action DownloadFile, consultez Exemples d'actions.

Action UploadFile

Cette action vous permet d'importer un fichier dans votre instance Box.

Paramètres d'entrée de l'action UploadFile

Paramètres de sortie de l'action UploadFile

Cette action renvoie l'état 200 (OK) avec un corps de réponse indiquant les résultats.

Pour savoir comment configurer l'action UploadFile, consultez Exemples d'actions.

Action CopyFile

Cette action vous permet de copier un fichier depuis votre instance Box.

Paramètres d'entrée de l'action CopyFile

Paramètres de sortie de l'action CopyFile

Cette action renvoie l'état 200 (OK) avec un corps de réponse indiquant les résultats.

Pour savoir comment configurer l'action CopyFile, consultez Exemples d'actions.

Action CopyFolder

Cette action vous permet de copier un dossier entier depuis votre instance Box.

Paramètres d'entrée de l'action CopyFolder

Paramètres de sortie de l'action CopyFolder

Cette action renvoie l'état 200 (OK) avec un corps de réponse indiquant les résultats.

Pour savoir comment configurer l'action CopyFolder, consultez Exemples d'actions.

Exemples d'actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Exemple : Télécharger un fichier

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action DownloadFile, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

Cet exemple télécharge un fichier sous forme de chaîne encodée en Base64. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

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

Exemple : Importer un fichier

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action UploadFile, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

Cet exemple importe du contenu de type chaîne en tant que fichier. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

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

Exemple : Copier un fichier

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action CopyFile, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

Cet exemple copie le fichier avec l'ID 1288751886061 dans le dossier avec l'ID 219105724517. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

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

Exemple : Copier un dossier

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action CopyFolder, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

Cet exemple copie le dossier dont l'ID est 218475301279 vers le dossier dont l'ID est 219105724517. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

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

Exemples d'opérations d'entité

Exemple : Lister tous les fichiers

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Files" (Fichiers) dans la liste Entity.
3. Sélectionnez l'opération LIST, puis cliquez sur OK.

Vous pouvez effectuer l'opération LIST sur les entités suivantes : Folders, TrashedItems, SharedItems, Collaborations, TaskAssignments et Tasks.

Exemple : Obtenir les fichiers

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Files" (Fichiers) dans la liste Entity.
3. Sélectionnez l'opération GET, puis cliquez sur OK.
4. Définissez l'ID d'entité sur 1262397830475, qui est la clé à transmettre. Pour définir l'ID d'entité, dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur EntityId, puis saisissez 1262397830475 dans le champ Valeur par défaut.

La valeur de l'ID d'entité doit être transmise directement, par exemple 1262397830475. Où 1262397830475 est la valeur de clé primaire unique.

Vous pouvez effectuer l'opération GET sur les entités suivantes : dossiers, éléments partagés, collaborations, attributions de tâches et tâches.

Exemple : Supprimer des fichiers

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Files" (Fichiers) dans la liste Entity.
3. Sélectionnez l'opération DELETE, puis cliquez sur OK.
4. Définissez l'ID d'entité sur 1258725940971, qui est la clé à transmettre. Pour définir l'ID d'entité, dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur EntityId, puis saisissez 1258725940971 dans le champ Valeur par défaut.

   Si l'entité comporte deux clés métier ou clés primaires composites, vous pouvez définir la filterClause sur Id='1258725940971' au lieu de spécifier l'entityId.

Vous pouvez effectuer l'opération DELETE sur les entités suivantes : dossiers, tâches, collaborations, éléments partagés et attributions de tâches.

Exemple : Créer des dossiers

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Folders" dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

   Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche Folder aura une valeur semblable à la suivante :

    
   {
   "Id": "222269371053"
   } 

Exemple : Créer des collaborations

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Collaborations" dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

   Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche Folder aura une valeur semblable à la suivante :

   {
   "Success": false
   } 

Exemple : Créer des tâches

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Tasks" dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ 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"
   }

   Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche Folder aura une valeur semblable à la suivante :

    
   {
   "Id": "1253997361112"
   }

Exemple : Créer des tâches

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "TaskAssignments" dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

   Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche Folder aura une valeur semblable à la suivante :

    
   {
   "Id": "50804351753"
   }

Exemple : Mettre à jour des fichiers

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Files" (Fichiers) dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

5. Définissez l'ID d'entité sur 1253997361112. Pour définir l'ID d'entité, cliquez sur entityId, puis saisissez 1253997361112 dans le champ Valeur par défaut.

   Sinon, au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur 1253997361112.

   L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

   {
   "Id": "1253997361112"
   }

Vous pouvez effectuer l'opération UPDATE sur les entités suivantes : Folders, Tasks, Collaborations, SharedItems et TaskAssignments.

Exemple : Mettre à jour des dossiers

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Folders" dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "Name": "Demo Update"
   }

5. Définissez l'ID d'entité sur 216457668125. Pour définir l'ID d'entité, cliquez sur entityId, puis saisissez 216457668125 dans le champ Valeur par défaut.

   Sinon, au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur 216457668125.

   L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

   {
   "Id": "216457668125"
   } 

Exemple : Mettre à jour les collaborations

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Collaborations" dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "Role": "Viewer"
   }

5. Définissez l'ID d'entité sur 46685648757. Pour définir l'ID d'entité, cliquez sur entityId, puis saisissez 46685648757 dans le champ Valeur par défaut.

   Sinon, au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur 46685648757.

   L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

   {
   
   }

Exemple : Mettre à jour des tâches

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Tasks" dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

5. Définissez l'ID d'entité sur 21507516872. Pour définir l'ID d'entité, cliquez sur entityId, puis saisissez 21507516872 dans le champ Valeur par défaut.

   Sinon, au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur 21507516872.

   L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

   {
   "Id": "21507516872"
   }

Exemple : Mettre à jour les tâches attribuées

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "TaskAssignments" dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

5. Définissez l'ID d'entité sur 49542929469. Pour définir l'ID d'entité, cliquez sur entityId, puis saisissez 49542929469 dans le champ Valeur par défaut.

   Sinon, au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur 49542929469.

   L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

   {
   "Id": "49542929469"
   } 

Exemple : Mettre à jour des Transferfolders

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Folders" dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

5. Définissez l'ID d'entité sur 216457668125. Pour définir l'ID d'entité, cliquez sur entityId, puis saisissez 216457668125 dans le champ Valeur par défaut.

   L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

   {
   "Id": "216457668125"
   }