Recuperar Documentos de Oracle Content and Experience

La API de REST de Oracle Content and Experience para Documentos proporciona una serie de puntos finales que permiten gestionar documentos y carpetas en Oracle Content and Experience desde la aplicación Oracle Visual Builder.

Por ejemplo, puede mostrar listas de los documentos y fotos cargados en Oracle Content and Experience, además de las carpetas creadas en el almacenamiento de documentos de Oracle Content and Experience en una página de la aplicación Oracle Visual Builder. En el contenido que aparece a continuación, se describe cómo agregar un punto final que llama al punto final Obtener Contenido de la Carpeta Raíz expuesto por la API de REST para Documentos y cómo mostrar la respuesta en un componente de vista de lista en una aplicación de Oracle Visual Builder. El punto final Obtener Contenido de Carpeta Raíz obtiene una recopilación de todos los elementos (carpetas y archivos) a los que el usuario tiene acceso, incluidas las carpetas que otros han compartido con ese usuario.

Para implementar la funcionalidad descrita, necesita:

Una conexión de servicio que expone el punto final Obtener Contenido de Carpeta Raíz para obtener la lista de archivos y carpetas a los que un usuario tiene acceso desde el almacenamiento de documentos de Oracle Content and Experience.
Página de la aplicación Oracle Visual Builder que muestra un componente de la interfaz de usuario, como el componente Vista de Lista, que presenta la lista de documentos y carpetas que recupera mediante el punto final que ha expuesto a través de una conexión de servicio.

Crear un punto final para recuperar documentos

Puede crear un punto final para recuperar archivos y carpetas de Oracle Content and Experience mediante el URI base de la instancia de Oracle Content and Experience a la que se conecta y los parámetros de consulta para acceder al punto final Obtener Contenido de la Carpeta Raíz expuesto por la API de REST para los documentos.

Por ejemplo, si https://cec-instance-url.com es el URI base de la instancia de Oracle Content and Experience a la que se conecta, introduzca el siguiente URI con el método HTTP (GET) adecuado y la indicación de acción (Obtener muchas) al crear el punto final.

https://cec-instance-url.com/documents/api/1.2/folders/{folderId}/items

También deberá proporcionar los detalles de autenticación que utilizará para conectarse a Oracle Content and Experience para utilizar el punto final. La autenticación básica es suficiente para fines de desarrollo, pero no se recomienda su uso en producción.

Nota:

Si ha creado previamente una conexión de servicio en la API de REST de Oracle Content and Experience para Documentos para utilizar otros puntos finales, como el punto final Cargar Archivo, no necesita crear una nueva conexión de servicio. En su lugar, agregue el punto final Obtener Contenido de Carpeta Raíz a la conexión de servicio que ha creado previamente utilizando el botón + Punto Final en el separador Puntos Finales de la conexión de servicio. El siguiente contenido asume que aún no ha creado la conexión de servicio y describe cómo crear la conexión de servicio y agregar el punto final Obtener Contenido de Carpeta Raíz. Si ha creado la conexión de servicio, utilice el botón + Punto Final y los detalles relevantes del siguiente contenido, como el método, la indicación de acción y el cuerpo de respuesta de ejemplo.

Para crear un punto final para recuperar archivos y carpetas de Oracle Content and Experience:

Abra Conexiones de servicio en el navegador y haga clic en Crear conexión de servicio ( ).
Haga clic en Definir por Punto Final en el panel Seleccionar Origen del asistente Crear Conexión de Servicio.

Descripción de la ilustración service-connections-create-byendpoint.png
En la lista desplegable Método, seleccione GET, introduzca https://cec-instance-url.com/documents/api/1.2/folders/{folderId}/items en el campo de entrada URL, seleccione Obtener muchos en la lista desplegable Indicación de Acción y haga clic en Siguiente.

Descripción de la ilustración vb-cec-retrieve-home-folder-endpoint.png
En el separador Servicio, revise los valores de URL de Base de Servicio, Nombre de Servicio e ID de Servicio.
Oracle Visual Builder rellena automáticamente estos campos según los valores introducidos anteriormente en el asistente.
Abra el separador Autenticación y seleccione Activar Autenticación / Proxy para introducir los detalles de autenticación.
Seleccione Básico en la lista desplegable Mecanismo de Autenticación e introduzca el nombre de usuario y la contraseña que utiliza para acceder a la instancia de Oracle Content and Experience.
Abra el separador Parámetros de Solicitud y URL y, para el parámetro de ruta de acceso folderId, introduzca un valor por defecto self.

Descripción de la ilustración vb- cec_set- url-param-retrieve.png

Abra el separador Respuesta e introduzca un ejemplo de cuerpo de respuesta para el punto final.

El separador Respuesta contiene un área de texto en la que puede pegar un ejemplo del cuerpo de la respuesta. El ejemplo de la respuesta es la definición de la estructura del objeto devuelto. Introduzca el siguiente ejemplo de un objeto devuelto en respuesta a una llamada a la API Obtener Contenido de Carpeta Raíz.

{
    "count":"3",
    "totalResults":"3",
    "ownerFolderID":"self",
    "hasMore":"0",
    "errorCode":"0",
    "items":[
        {
            "id":"FF4729683CD68C1AFB1AE87DT0000000000100000001",
            "parentID":"self",
            "name":"foldera",
            "type":"folder",
            "size":"39",
            "childItemsCount":"2",
            "createdTime":"2014-02-21T20:52:37Z",
            "modifiedTime":"2014-02-21T20:52:37Z",
            "createdBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            },
            "ownedBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            },
            "modifiedBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            }
        },
        {
            "id":"F4A669A2B7B69F2376C640A9T0000000000100000001",
            "parentID":"self",
            "name":"folderb",
            "type":"folder",
            "size":"0",
            "childItemsCount":"0",
            "createdTime":"2014-02-21T21:38:44Z",
            "modifiedTime":"2014-02-21T21:38:44Z",
            "createdBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            },
            "ownedBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            },
            "modifiedBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            }
        },
        {
            "id":"DBFDB0B6543FB5B68107423AT0000000000100000001",
            "parentID":"self",
            "name":"test cases.txt",
            "type":"file",
            "size":"37786",
            "version":"1",
            "createdTime":"2014-02-21T21:38:52Z",
            "modifiedTime":"2014-02-21T21:38:52Z",
            "createdBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            },
            "ownedBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            },
            "modifiedBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            }
        }
    ]
}

Descripción de vb-cec-example-body-retrieve.png

Descripción de la ilustración vb-cec-example-body-retrieve.png

Haga clic en Crear.

Agregar un componente de interfaz de usuario para mostrar documentos

Agregará un componente de vista de lista a una página en la aplicación Oracle Visual Builder y utilizará el inicio rápido de Agregar datos para asignar la lista al punto final Obtener contenido de carpeta inicial que se expone al crear la conexión de servicio a la API de REST de Oracle Content and Experience para los documentos.

Para mostrar la lista de carpetas y documentos Contenido y Experiencia:

En la página de aplicación Oracle Visual Builder, agregue un componente de vista de lista.
Seleccione el componente de vista de lista que acaba de agregar y, en la sección Inicio rápido del inspector de propiedades de vista de lista, haga clic en Agregar datos.
En el cuadro de diálogo Agregar Datos que aparece, navegue a la API de punto final REST de Obtener Contenido de Carpeta Raíz (/documents/api/1.2/folders/items) que ha agregado anteriormente.

Descripción de la ilustración vb-cec-listview-quick-start.png
En la página Seleccionar Plantilla, deje la plantilla seleccionada por defecto sin cambios y haga clic en Siguiente.
En la página Enlazar datos, seleccione el nombre y haga clic en Siguiente.

Descripción de la ilustración vb-cec-add-data-bind.png
En el campo Definir Consulta, haga clic en Terminar.
El componente de vista de lista ahora presenta una lista de los documentos y carpetas a los que tiene acceso.
Descripción de la ilustración vb-cec-listview-render.png