Box

Ejemplos de configuración de conexiones

En esta sección se indican los valores de ejemplo de los distintos campos que se configuran al crear la conexión.

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

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

Puedes acceder a la clave privada y a la contraseña de la clave privada desde el archivo Private keypair.json que has descargado. Para obtener más información, consulta Información sobre el par de claves públicas y privadas. Además, antes de introducir la contraseña de la clave privada, sustituye el \n del 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 Crear una aplicación OAuth.

JSON de Box 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 JWT. Para obtener información sobre cómo configurar Box Json para JWT, consulta los pasos para crear tokens JWT .

Accede al valor de Json de Box para la autenticación JWT desde el archivo Private keypair.json que has descargado. Para obtener más información, consulta Información sobre el par de claves pública y privada. Debes introducir todo el contenido del archivo .json en el campo JSON de Box para la autenticación JWT.

Tipo de conexión de credenciales de cliente de OAuth

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

Entidades, operaciones y acciones

Todos los conectores de integración 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 te muestra como entidades, operaciones y acciones.

• Entidad: una entidad se puede considerar como un objeto o un conjunto de propiedades en la aplicación o el servicio conectados. La definición de una entidad varía de un conector a otro. Por ejemplo, en un conector de base de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; y en un conector de sistema de mensajería, las colas son las entidades.

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

• Operación: una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
  • Mostrar
  • Obtener
  • Crear
  • Actualizar
  • Eliminar

  Al seleccionar una entidad de la lista disponible, se genera una lista de operaciones disponibles para la entidad. Para ver una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea Connectors. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, esas operaciones no admitidas no se mostrarán en la lista Operations.

• Acción: una acción es una función de primera clase que se pone a disposición de la integración a través de la interfaz del conector. Una acción te permite hacer cambios en una o varias entidades y varía de un conector a otro. Normalmente, 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 admitidas por 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 un ejemplo de 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 un ejemplo de 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 un ejemplo de cómo configurar la acción CopyFile, consulta Ejemplos de acciones.

Acción CopyFolder

Esta acción te permite copiar una carpeta entera 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 un ejemplo de 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 de este conector.

Ejemplo: descargar un archivo

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción DownloadFile y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 connectorOutputPayload de la respuesta de la tarea del conector tendrá un valor similar al siguiente:

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

Ejemplo: subir un archivo

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción UploadFile y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 connectorOutputPayload de la respuesta de la tarea del conector tendrá un valor similar al siguiente:

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

Ejemplo: copiar un archivo

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción CopyFile y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 en la carpeta con el ID 219105724517. Si la acción se realiza correctamente, el parámetro connectorOutputPayload de la respuesta de la tarea del conector tendrá un valor similar al siguiente:

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

Ejemplo: copiar una carpeta

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción CopyFolder y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 en la carpeta con el ID 219105724517. Si la acción se realiza correctamente, el parámetro connectorOutputPayload de la respuesta de la tarea del conector tendrá un valor similar al siguiente:

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

Ejemplos de operaciones de entidades

Ejemplo: listar todos 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 LIST y, a continuación, haz clic en Hecho.

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

Ejemplo: obtener 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, a continuación, haz clic en Hecho.
4. Asigna el ID de entidad a 1262397830475, que es la clave que se va a transferir. Para definir el ID de entidad, en la sección Entrada de tarea de la tarea Conectores, haz clic en EntityId y, a continuación, introduce 1262397830475 en el campo Valor predeterminado.

El valor de Entity Id debe transferirse directamente, como 1262397830475. Donde 1262397830475 es el valor de clave principal único.

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

Ejemplo: eliminar 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, a continuación, haz clic en Hecho.
4. Asigna el ID de entidad a 1258725940971, que es la clave que se va a transferir. Para definir el ID de entidad, en la sección Entrada de tarea de la tarea Conectores, haz clic en EntityId y, a continuación, introduce 1258725940971 en el campo Valor predeterminado.

   Si la entidad tiene dos claves empresariales compuestas o primarias en lugar de especificar el entityId, también puede definir filterClause como Id='1258725940971'.

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

Ejemplo: crear carpetas

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Carpetas en la lista Entity.
3. Selecciona la operación Create y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 connectorOutputPayload de la respuesta Folder tendrá un valor similar al siguiente:

    
   {
   "Id": "222269371053"
   } 

Ejemplo: crear 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, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 connectorOutputPayload de la respuesta Folder tendrá un valor similar al siguiente :

   {
   "Success": false
   } 

Ejemplo: Crear 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, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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 connectorOutputPayload de la respuesta Folder tendrá un valor similar al siguiente:

    
   {
   "Id": "1253997361112"
   }

Ejemplo: crear 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, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

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

   Si la integración se realiza correctamente, el parámetro connectorOutputPayload de la respuesta 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, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

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

5. Asigna el valor 1253997361112 al ID de entidad. Para definir el ID de entidad, haz clic en entityId y, a continuación, introduce 1253997361112 en el campo Valor predeterminado.

   También puede definir filterClause como 1253997361112 en lugar de especificar entityId.

   Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea Connector:

   {
   "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 Carpetas en la lista Entity.
3. Selecciona la operación Update y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "Name": "Demo Update"
   }

5. Asigna el ID de entidad 216457668125. Para definir el ID de entidad, haz clic en entityId y, a continuación, introduce 216457668125 en el campo Valor predeterminado.

   También puede definir filterClause como 216457668125 en lugar de especificar entityId.

   Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea Connector:

   {
   "Id": "216457668125"
   } 

Ejemplo: Actualizar 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, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "Role": "Viewer"
   }

5. Asigna el ID de entidad 46685648757. Para definir el ID de entidad, haz clic en entityId y, a continuación, introduce 46685648757 en el campo Valor predeterminado.

   También puede definir filterClause como 46685648757 en lugar de especificar entityId.

   Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea Connector:

   {
   
   }

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, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce 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. Asigna el valor 21507516872 al ID de entidad. Para definir el ID de entidad, haz clic en entityId y, a continuación, introduce 21507516872 en el campo Valor predeterminado.

   También puede definir filterClause como 21507516872 en lugar de especificar entityId.

   Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea Connector:

   {
   "Id": "21507516872"
   }

Ejemplo: actualizar taskassignments

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, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

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

5. Asigna el ID de entidad 49542929469. Para definir el ID de entidad, haz clic en entityId y, a continuación, introduce 49542929469 en el campo Valor predeterminado.

   También puede definir filterClause como 49542929469 en lugar de especificar entityId.

   Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea Connector:

   {
   "Id": "49542929469"
   } 

Ejemplo: actualizar Transferfolders

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Carpetas en la lista Entity.
3. Selecciona la operación Update y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

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

5. Asigna el ID de entidad 216457668125. Para definir el ID de entidad, haz clic en entityId y, a continuación, introduce 216457668125 en el campo Valor predeterminado.

   Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea Connector:

   {
   "Id": "216457668125"
   }