Estás viendo una versión antigua de esta página. Ve a la versión actual.

Comparar con el actual Ver el historial de la página

« Anterior Versión 45 Siguiente »

Consulta

La API REST de Servicios CGES permite la consulta por lenguaje natural de los documentos de solución (KI) de CGES.

El parámetro id que devuelve el listado será el utilizado para realizar el resto de las operaciones con cada uno de los recursos contenidos en el mismo.


GET /cges/knowledgeitems
Obtener soluciones

Es posible facilitar un criterio de búsqueda en la consulta del listado de soluciones, y además se pueden aplicar los siguientes filtros:

  • idKI para combinar búsquedas con códigos de KI 
  • uuidRecurso para obtener soluciones para una determinada aplicación de CMS.
  • rutaBusquedaCategoria para obtener soluciones dentro de un árbol de categorización.
  • estado.
  • idTipoActuacion para obtener soluciones presenciales o remotas.
  • idPublicoObjetivo para obtener soluciones destinadas a usuarios finales o profesionales TIC.
  • uuidCreador y uuidOrganizacionCreador para filtrar soluciones por usuarios creadores.
    • El usuario creador se obtiene de la tabla maestra de contactos filtrando por el codigo=USUARIO_CREADOR_KI.
    • La organización del creador se obtiene de la tabla maestra correspondiente.
  • Otros filtros de fechas de creación, última modificación, publicación y retirada.
  • La consulta con criterio sólo realiza consultas sobre KIs publicadas y devuelve un máximo de 50 resultados.

También es posible ordenar el listado de manera ascendente o descendente según los siguientes campos:

  • id
  • visualizaciones
  • clasificacionFAQ
  • fechas.fechaCreacion
  • fechas.fechaUltModificacion
  • soluciones
  • recurso.nombre
  • estado


Para obtener más información acerca de una solución se puede consultar el método destinado a tal fin en la API.


GET /cges/knowledgeitems/{idKI}
Obtener solución

Consulta SimilEco

La API REST de Servicios CGES permite la consulta mediante SimilEco para realizar la búsqueda de soluciones por colección mediante el parámetro idColeccion. 

POST /cges/knowledgeitems/simileco/colecciones/{idColeccion}/buscar
Obtener soluciones mediante SimilEco

El método recibe dos parámetros con el texto de búsqueda y el máximo de coincidencias a consultar.

Creación y edición

Es posible realizar la creación de una solución mediante el siguiente método:


POST /cges/knowledgeitems
Crear solución

Requisitos funcionales

    • El titulo es obligatorio y debe tener un máximo de 255 caracteres.

    • La solucion es obligatoria y permite un máximo de 4000 caracteres.
    • El tipo es obligatorio y debe ser válido.
    • El tipoActuacion.id es obligatorio y debe ser válido.
    • El publico.id es obligatorio y debe ser válido para marcar la visibilidad de la KI.
    • El resumen es obligatorio. Máximo 255 caracteres.

    • El estado podrá indicarse para registrar la KI en estado "Borrador" o enviarla a validación con el estado "Pdte Validar".

    • Las evidencias son opcionales y tienen un máximo de 4000 caracteres una vez concatenadas y separadas por comas.

    • El campo recurso.uuid es opcional y permite asociar una aplicación de CMS a la KI.


La edición de solución se realiza con la siguiente llamada:


PUT /cges/knowledgeitems/{idKI}
Modificar solución

Requisitos funcionales

    • Sólo se podrán editar soluciones en los siguientes estados: 

      • Borrador (sólo para usuarios de la misma organización que el creador)

      • Rechazada (sólo para usuarios de la misma organización que el creador)

      • Publicada (sólo para usuarios de la misma organización que el creador) 

      • Pendiente Retirada

      • Retirada

    • Mismos requisitos que en la creación.

    • El estado "Borrador" sólo se podrá enviar para soluciones en estado "Borrador" para así mantenerlas en borrador hasta que se decida enviar a validación.


¡Importante!

Para realizar correctamente la modificación se debe enviar el objeto completo cada vez que se consuma este recurso.
En caso de no enviar alguno de los valores, el recurso borrará la información para los atributos no informados.

Subida y descarga de imágenes

La subida de imágenes está limitada a un tamaño máximo (consultar) y tiene los siguientes métodos para utilizar:


POST /cges/knowledgeitems/imagenes
Subida de imágenes a soluciones
GET /cges/tablas/adjuntos/imagenes/{idImagen}
Descarga de imagen

A la hora de incluir la imagen en el contenido de la KI se deberá mantener sin modificaciones la url devuelta por el servicio de subida de imágenes.

Deberá quedar un código HTML con la siguiente estructura de ejemplo:

<img src="http://mics.sas.junta-andalucia.es/proxy-rest/external/attachment/1418650?ServerName=SE41VAP001CGSCO&RepId=doc_rep:1000&SecId=EA8FCA435EDD01FB9E5C001DD8DB1DCF"></img>

Enlaces a otras soluciones

A la hora de incluir un enlace a otra solución en el contenido, se debe seguir el siguiente formato sustituyendo <idKiEnlazada> por el número del identificador de la solución al que se quiere enlazar la información:

<a href="javascript:void(0)" onclick="OpenDocument(<idKIEnlazada>)" ;="" ki="<idKIEnlazada>"></a>

El contenido entre las etiquetas del enlace <a></a> puede ser el que el usuario decida.

  • Sin etiquetas