SharePoint

Muestras de configuración de conexión

Esta sección enumera los valores de muestra para los diversos que configuras cuando creas la conexión.

Tipo de conexión web

Tipo de conexión de PSC

Tipo de conexión de credenciales de cliente

Tipo de conexión del certificado del portador de JWT

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
  • Obtén
  • 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, tales operaciones operaciones no aparecen 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 algunas de las acciones que admite el conector. Para entender cómo configurar el consulta Ejemplos de acciones.

Acción DeleteAttachment

Esta acción borra un archivo adjunto.

Parámetros de entrada de la acción DeleteAttachment

Para comprender cómo configurar la acción DeleteAttachment, consulta Ejemplos de acciones.

Acción CheckInDocument

Esta acción te permite registrar un documento.

Parámetros de entrada de la acción CheckInDocument

Para comprender cómo configurar la acción CheckInDocument, consulta Ejemplos de acciones.

Acción CheckOutDocument

Esta acción te permite consultar un archivo.

Parámetros de entrada de la acción CheckOutDocument

Para comprender cómo configurar la acción CheckOutDocument, consulta Ejemplos de acciones.

Acción DismissCheckOutDocument

Esta acción te permite deshacer la extracción de un archivo.

Parámetros de entrada de la acción DismissCheckOutDocument

Para comprender cómo configurar la acción DiscardCheckOutDocument, consulta Ejemplos de acciones.

Acción CopyDocument

Esta acción te permite copiar un archivo de una ubicación a otra.

Parámetros de entrada de la acción CopyDocument

Para comprender cómo configurar la acción CopyDocument, consulta Ejemplos de acciones.

Acción UploadDocument

Esta acción te permite subir un archivo.

Parámetros de entrada de la acción UploadDocument

Para comprender cómo configurar la acción UploadDocument, consulta Ejemplos de acciones.

Acción DownloadDocument

Esta acción te permite descargar un archivo.

Parámetros de entrada de la acción DownloadDocument

Para comprender cómo configurar la acción DownloadDocument, consulta Ejemplos de acciones.

Acción MoveAttachmentOrDocument

Esta acción te permite mover un archivo de una carpeta a otra.

Parámetros de entrada de la acción MoveAttachmentOrDocument

Para comprender cómo configurar la acción MoveAttachmentOrDocument, consulta Ejemplos de acciones.

Acción CreateFolder

Esta acción te permite crear una carpeta.

Parámetros de entrada de la acción CreateFolder

Para comprender cómo configurar la acción CreateFolder, consulta Ejemplos de acciones.

Acción AddAttachments

Esta acción te permite agregar un archivo adjunto.

Parámetros de entrada de la acción AddAttachments

Para comprender cómo configurar la acción AddAttachments, consulta Ejemplos de acciones.

Acción DownloadAttachments

Esta acción te permite descargar archivos adjuntos.

Parámetros de entrada de la acción DownloadAttachments

Para comprender cómo configurar la acción DownloadAttachments, consulta Ejemplos de acciones.

Ejemplos de acciones

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

Ejemplo: Borra un archivo adjunto

En este ejemplo, se borra el archivo especificado.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción DeleteAttachment 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:

   {
   "ListTitle": "My lists",
   "ItemId": "1",
   "FileName": "sitepages.txt"
   }

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

[{
"Status": "Success"
}]

Ejemplo: Revisar un documento

Este ejemplo verifica un documento.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción CheckInDocument 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:

   {
   "RelativeURL": "/Shared Documents/TestFolder",
   "DocumentName": "Document.txt",
   "Comment": "Comment test"
   }

Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea CheckInDocument tendrá un valor similar al siguiente:

[{
"Status": "Success"
}]

Ejemplo: Revisa un archivo

En este ejemplo, se revisa un archivo.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción CheckOutDocument 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:

   {
   "RelativeURL": "/Shared Documents/TestFolder",
   "DocumentName": "Document.txt"
   }

Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea CheckOutDocument tendrá un valor similar al siguiente:

[{
"Status": "Success"
}]

Ejemplo: Descartar un pago

En este ejemplo, se revierte el check out de un archivo.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción DiscardCheckOutDocument 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:

   {
   "RelativeURL": "/Shared Documents/TestFolder",
   "DocumentName": "Document.docx"
   }

Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea DiscardCheckOutDocument tendrá un valor similar al siguiente:

[{
"Status": "Success"
}]

Ejemplo: copia un archivo

En este ejemplo, se copia un archivo de una ubicación a otra.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción CopyDocument 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:

   {
   "SourceFileRelativeUrl": "/Shared Documents/Document.docx",
   "DestFileRelativeUrl": "/Shared Documents/TestFolder/Document123.docx"
   }

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

[{
"Status": "Success"
}]

Ejemplo: sube un archivo de texto

En este ejemplo, se sube un archivo de texto a la ubicación especificada.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción UploadDocument 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:

   {
   "FileName": "test.txt",
   "RelativeUrl": "/Shared Documents/TestFolder",
   "Content": "abcd"
   }

Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea UploadDocument tendrá un valor similar al siguiente:

[{
"Status": "Success"
}]

Ejemplo: sube un archivo binario

En este ejemplo, se sube un archivo binario a la ubicación especificada. Cuando subes un objeto binario , especifica el contenido que se subirá como una cadena codificada en Base64.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción UploadDocument 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:

   {
   "FileName": "test.txt",
   "RelativeUrl": "/Shared Documents/TestFolder",
   "ContentBytes": "SGVsbG8gd29ybGQK",
   "HasBytes": "true"
   }

Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea UploadDocument tendrá un valor similar al siguiente:

[{
"Status": "Success"
}]

Ejemplo: descarga un archivo

En este ejemplo, se descarga un archivo.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción DownloadDocument 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:

   {
   "RemoteFile": "/TestFolder/test.txt",
   "Library": "Shared Documents"
   }

Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea DownloadDocument tendrá un valor similar al siguiente:

[{
"Success": "True",
"Content": "Test File",
}]

Ejemplo: Descarga un archivo binario

En este ejemplo, se descarga un archivo binario.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción DownloadDocument 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:

   {
   "RemoteFile": "/TestFolder/test1.png",
   "Library": "Shared Documents"
   "HasBytes": "true"  
   }

Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea DownloadDocument tendrá un valor similar al siguiente:

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

Ejemplo: Mover un archivo adjunto

En este ejemplo, se mueve un adjunto de una ubicación a otra.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción MoveAttachmentOrDocument 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:

   {
   "SourceFileURL": "/Shared Documents/test.txt",
   "DestinationFolderURL": "/Shared Documents/TestFolder"
   }

Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea MoveAttachmentOrDocument tendrá un valor similar al siguiente:

[{
"Result": "Success"
}]

Ejemplo: crea una carpeta

En este ejemplo, se crea una carpeta en la ubicación especificada.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción CreateFolder 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:

   {
   "RelativeURL": "/Shared Documents/TestFolder",
   "FolderName": "TestFolder123"
   }

Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea CreateFolder tendrá un valor similar al siguiente:

[{
"Id": "110842b7-2393-4f11-9391-3d75214e9fb8",
"Status": "Success"
}]

Ejemplo: Agrega un archivo adjunto

En este ejemplo, se agrega un archivo adjunto a la lista especificada.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción AddAttachments 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:

   {
   "ListTitle": "My Lists",
   "FileName": "TestAttachment2",
   "Content": "abcd text",
   "ItemId": "1"
   }

Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea AddAttachments tendrá un valor similar al siguiente:

[{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment2",
"Status": "Success"
}]

Ejemplo: agrega un archivo adjunto de objeto binario

En este ejemplo, se agrega un adjunto binario a la lista especificada.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción AddAttachments 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:

   {
   "ListTitle": "My Lists",
   "FileName": "TestAttachment3",
   "ContentBytes": "VGVzdCBGaWxl",
   "HasBytes": "true",  
   "ItemId": "1"
   }

Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea AddAttachments tendrá un valor similar al siguiente:

[{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment3",
"Status": "Success"
}]

Ejemplo: Cómo descargar un archivo adjunto

En este ejemplo, se descarga un archivo adjunto.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción DownloadAttachments 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:

   {
   "RemoteFile": "/Shared Documents/Document.txt"
   }

Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea DownloadAttachments tendrá un valor similar al siguiente:

[{
"Success": "True",
"Content": "Test File",
}]

Ejemplo: descarga un archivo adjunto de objeto binario

En este ejemplo, se descarga un archivo adjunto binario.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Selecciona la acción DownloadAttachments 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:

   {
   "RemoteFile": "/Shared Documents/Document.docx",
   "HasBytes": "true"
   }

Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea DownloadAttachments tendrá un valor similar al siguiente:

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

Ejemplos de operaciones de entidades

En esta sección, se muestra cómo realizar algunas de las operaciones de entidad en este conector.

Ejemplo: enumera todos los archivos

En este ejemplo, se enumeran todos los archivos de la entidad Files.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Files de la lista Entity.
3. Selecciona la operación List y, luego, haz clic en Listo.
4. De manera opcional, en la sección Entrada de tarea de la tarea Conectores, puedes realizar lo siguiente: filtrar tu conjunto de resultados especificando una cláusula de filtro. Tú también puede especificar varias condiciones de filtro con los operadores lógicos.

Ejemplo: obtén una lista

En este ejemplo, se obtiene una lista con el ID especificado de la entidad My Lists.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona My Lists en la lista Entity.
3. Selecciona la operación Get y, luego, haz clic en Listo.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en EntityId. Luego, ingresa 3 en el campo Valor predeterminado.

   Aquí, 3 es un valor de clave primaria en la entidad My Lists.

Ejemplo: crea un registro

En este ejemplo, se crea un registro en la entidad My Lists.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona My Lists de 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:

   {
   "AuthorId": 11.0, 
   "BaseName": "3_",
   "Attachments": false,
   "Title": "Created List New"
   }

   Si la integración se realiza correctamente, el campo connectorOutputPayload de tu tarea de conector tendrá una valor similar al siguiente:

   [{
   "ID": 3.0
   }]

Ejemplo: Borra un registro

En este ejemplo, se borra el registro con el ID especificado en la entidad My Lists.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona My Lists en la lista Entity.
3. Selecciona la operación Delete y haz clic en Listo.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en entityId y Luego, ingresa 2 en el campo Valor predeterminado.