Box

Muestras de configuración de conexión

En esta sección, se enumeran los valores de muestra para los distintos campos que configuras cuando creas la conexión.

Tipo de conexión del método del token de JWT de OAuth

Puedes acceder al ID de cliente, al secreto del cliente, al nivel de acceso de la aplicación de Box y al ID de la empresa o del usuario desde la cuenta de Box.

Puedes acceder a la contraseña de la clave privada y a la clave privada desde el archivo Private keypair.json que descargaste. Para obtener más información, consulta Información sobre el par de claves públicas y privadas. Además, antes de pasar la contraseña de la clave privada, reemplaza el \n en el archivo json por una línea nueva.

Tipo de conexión de código de autorización de OAuth

Para obtener información sobre la configuración de OAuth de Box, consulta Crea tu aplicación de OAuth.

Cuadro de JSON para el tipo de conexión del método de autenticación JWT

Puedes usar la cuenta de Box para configurar Box Json para la autenticación con JWT. Para obtener información sobre cómo configurar Box Json para JWT, consulta los pasos para crear tokens JWT

Accede al valor de Box Json para la autenticación con JWT desde el archivo Private keypair.json que descargaste. Para obtener más información, consulta Información sobre el par de claves públicas y privadas. Debes pasar el contenido completo del archivo .json en el campo Box Json for JWT Auth.

Tipo de conexión Credenciales de cliente de OAuth

Puedes acceder al ID de cliente, al secreto del cliente, al nivel de acceso a la aplicación de Box y al ID de la empresa o al ID de usuario desde la cuenta de Box.

Entidades, operaciones y acciones

Todos los Integration Connectors proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se expone como entidades, operaciones y acciones.

• Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.

  Sin embargo, es posible que un conector no admita o tenga ninguna entidad, en cuyo caso la lista Entities estará vacía.

• Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
  • Lista
  • Obtener
  • Crear
  • Actualizar
  • Borrar

  Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, esas operaciones no admitidas no se incluirán en la lista Operations.

• Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Por lo general, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Acciones

En esta sección, se enumeran todas las acciones que admite la conexión de Box.

Acción DownloadFile

Esta acción te permite descargar un archivo de tu instancia de Box.

Parámetros de entrada de la acción DownloadFile

Parámetros de salida de la acción DownloadFile

Esta acción devuelve el estado 200 (OK) con un cuerpo de respuesta que indica los resultados.

Para ver ejemplos sobre cómo configurar la acción DownloadFile, consulta Ejemplos de acciones.

Acción UploadFile

Esta acción te permite subir un archivo a tu instancia de Box.

Parámetros de entrada de la acción UploadFile

Parámetros de salida de la acción UploadFile

Esta acción devuelve el estado 200 (OK) con un cuerpo de respuesta que indica los resultados.

Para ver ejemplos sobre cómo configurar la acción UploadFile, consulta Ejemplos de acciones.

Acción CopyFile

Esta acción te permite copiar un archivo de tu instancia de Box.

Parámetros de entrada de la acción CopyFile

Parámetros de salida de la acción CopyFile

Esta acción devuelve el estado 200 (OK) con un cuerpo de respuesta que indica los resultados.

Para ver ejemplos sobre cómo configurar la acción CopyFile, consulta Ejemplos de acciones.

Action CopyFolder

Esta acción te permite copiar una carpeta completa de tu instancia de Box.

Parámetros de entrada de la acción CopyFolder

Parámetros de salida de la acción CopyFolder

Esta acción devuelve el estado 200 (OK) con un cuerpo de respuesta que indica los resultados.

Para ver ejemplos sobre cómo configurar la acción CopyFolder, consulta Ejemplos de acciones.

Ejemplos de acciones

En esta sección, se describe cómo realizar algunas de las acciones en este conector.

Ejemplo: Descarga un archivo

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción DownloadFile y haz clic en Listo.
3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

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

En este ejemplo, se descarga un archivo como una cadena codificada en Base64. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

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

Ejemplo: Sube un archivo

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción UploadFile y haz clic en Listo.
3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

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

En este ejemplo, se sube contenido de cadena como un archivo. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

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

Ejemplo: Cómo copiar un archivo

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción CopyFile y haz clic en Listo.
3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

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

En este ejemplo, se copia el archivo con el ID 1288751886061 a la carpeta con el ID 219105724517. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

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

Ejemplo: Cómo copiar una carpeta

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción CopyFolder y haz clic en Listo.
3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

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

En este ejemplo, se copia la carpeta con el ID 218475301279 a la carpeta con el ID 219105724517. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

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

Ejemplos de operaciones de entidades

Ejemplo: Enumera todos los archivos

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Files en la lista Entity.
3. Selecciona la operación LIST y haz clic en Listo.

Puedes realizar la operación LIST en las siguientes entidades: Folders, TrashedItems, SharedItems, Collaborations, TaskAssignments y Tasks.

Ejemplo: Obtén los archivos

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Archivos en la lista Entity.
3. Selecciona la operación GET y haz clic en Listo.
4. Establece el ID de la entidad en 1262397830475, que es la clave que se debe pasar. Para establecer el ID de la entidad, en la sección Task Input de la tarea Connectors, haz clic en EntityId y, luego, ingresa 1262397830475 en el campo Valor predeterminado.

El valor del ID de la entidad debe pasarse directamente, por ejemplo, 1262397830475. Aquí, 1262397830475 es el valor único de la clave primaria.

Puedes realizar la operación GET en las siguientes entidades: Folders, SharedItems, Collaborations, TaskAssignments y Tasks.

Ejemplo: Borrar archivos

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Archivos en la lista Entity.
3. Selecciona la operación DELETE y haz clic en Listo.
4. Establece el ID de la entidad en 1258725940971, que es la clave que se debe pasar. Para establecer el ID de la entidad, en la sección Task Input de la tarea Connectors, haz clic en EntityId y, luego, ingresa 1258725940971 en el campo Valor predeterminado.

   Como alternativa, si la entidad tiene dos claves comerciales compuestas o principales, en lugar de especificar entityId, también puedes establecer filterClause en Id='1258725940971'.

Puedes realizar la operación DELETE en las siguientes entidades: Folders, Tasks, Collaborations, SharedItems y TaskAssignments.

Ejemplo: Crea carpetas

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Folders en la lista Entity.
3. Selecciona la operación Create y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

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

   Si la integración se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea Folder tendrá un valor similar al siguiente:

    
   {
   "Id": "222269371053"
   } 

Ejemplo: Crea colaboraciones

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Colaboraciones en la lista Entity.
3. Selecciona la operación Create y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

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

   Si la integración se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea Folder tendrá un valor similar al siguiente :

   {
   "Success": false
   } 

Ejemplo: Crea tareas

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Tareas en la lista Entity.
3. Selecciona la operación Create y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el 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"
   }

   Si la integración se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea Folder tendrá un valor similar al siguiente:

    
   {
   "Id": "1253997361112"
   }

Ejemplo: Crea asignaciones de tareas

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona TaskAssignments en la lista Entity.
3. Selecciona la operación Create y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

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

   Si la integración se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea Folder tendrá un valor similar al siguiente:

    
   {
   "Id": "50804351753"
   }

Ejemplo: Actualizar archivos

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Archivos en la lista Entity.
3. Selecciona la operación Update y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

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

5. Establece el ID de la entidad en 1253997361112. Para establecer el ID de la entidad, haz clic en entityId y, luego, ingresa 1253997361112 en el campo Valor predeterminado.

   Como alternativa, en lugar de especificar entityId, también puedes establecer filterClause en 1253997361112.

   Cuando se ejecuta este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

   {
   "Id": "1253997361112"
   }

Puedes realizar la operación UPDATE en las siguientes entidades: Folders, Tasks, Collaborations, SharedItems y TaskAssignments.

Ejemplo: Actualizar carpetas

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Folders en la lista Entity.
3. Selecciona la operación Update y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

   {
   "Name": "Demo Update"
   }

5. Establece el ID de la entidad en 216457668125. Para establecer el ID de la entidad, haz clic en entityId y, luego, ingresa 216457668125 en el campo Valor predeterminado.

   Como alternativa, en lugar de especificar entityId, también puedes establecer filterClause en 216457668125.

   Cuando se ejecuta este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

   {
   "Id": "216457668125"
   } 

Ejemplo: Actualiza colaboraciones

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Colaboraciones en la lista Entity.
3. Selecciona la operación Update y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

   {
   "Role": "Viewer"
   }

5. Configura el ID de la entidad en 46685648757. Para establecer el ID de la entidad, haz clic en entityId y, luego, ingresa 46685648757 en el campo Valor predeterminado.

   Como alternativa, en lugar de especificar entityId, también puedes establecer filterClause en 46685648757.

   Cuando se ejecuta este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

   {
   
   }

Ejemplo: Actualizar tareas

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Tareas en la lista Entity.
3. Selecciona la operación Update y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

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

5. Establece el ID de la entidad en 21507516872. Para establecer el ID de la entidad, haz clic en entityId y, luego, ingresa 21507516872 en el campo Valor predeterminado.

   Como alternativa, en lugar de especificar entityId, también puedes establecer filterClause en 21507516872.

   Cuando se ejecuta este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

   {
   "Id": "21507516872"
   }

Ejemplo: Actualiza las asignaciones de tareas

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona TaskAssignments en la lista Entity.
3. Selecciona la operación Update y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

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

5. Establece el ID de la entidad en 49542929469. Para establecer el ID de la entidad, haz clic en entityId y, luego, ingresa 49542929469 en el campo Valor predeterminado.

   Como alternativa, en lugar de especificar entityId, también puedes establecer filterClause en 49542929469.

   Cuando se ejecuta este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

   {
   "Id": "49542929469"
   } 

Ejemplo: Actualiza Transferfolders

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Folders en la lista Entity.
3. Selecciona la operación Update y haz clic en Listo.
4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:

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

5. Establece el ID de la entidad en 216457668125. Para establecer el ID de la entidad, haz clic en entityId y, luego, ingresa 216457668125 en el campo Valor predeterminado.

   Cuando se ejecuta este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

   {
   "Id": "216457668125"
   }