Ver fuente

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.

<div style="margin: 0 0 15px;margin-top: 0px;margin-right: 0px;margin-bottom: 15px;margin-left: 0px;border: 1px solid #000;border-radius: 4px;-webkit-box-shadow: 0 0 3px rgba(0,0,0,.19);box-shadow: 0 0 3px rgba(0,0,0,.19);border-color: #61affe;background: rgba(97,175,254,.1);">
<div style="border-color: #61affe;display: flex;-webkit-box-align: center;align-items: center;padding: 5px;">
<span style="background: #61affe;font-size: 14px;font-weight: 700;min-width: 80px;padding: 6px 15px;text-align: center;border-radius: 3px;text-shadow: 0 1px 0 rgba(0,0,0,.1);font-family: sans-serif;color: #fff;">GET</span>
<span style="font-size: 16px;display: -webkit-box;display: -ms-flexbox;display: flex;-webkit-box-flex: 0;-ms-flex: 0 3 auto;flex: 0 3 auto;-webkit-box-align: center;-ms-flex-align: center;align-items: center;word-break: break-all;padding: 0 10px;font-family: monospace;font-weight: 600;color: #3b4151;">/cges/knowledgeitems</span>
<div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Obtener KIs</div>
</div>
</div>

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

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.

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

<div style="margin: 0 0 15px;margin-top: 0px;margin-right: 0px;margin-bottom: 15px;margin-left: 0px;border: 1px solid #000;border-radius: 4px;-webkit-box-shadow: 0 0 3px rgba(0,0,0,.19);box-shadow: 0 0 3px rgba(0,0,0,.19);border-color: #61affe;background: rgba(97,175,254,.1);">
<div style="border-color: #61affe;display: flex;-webkit-box-align: center;align-items: center;padding: 5px;">
<span style="background: #61affe;font-size: 14px;font-weight: 700;min-width: 80px;padding: 6px 15px;text-align: center;border-radius: 3px;text-shadow: 0 1px 0 rgba(0,0,0,.1);font-family: sans-serif;color: #fff;">GET</span>
<span style="font-size: 16px;display: -webkit-box;display: -ms-flexbox;display: flex;-webkit-box-flex: 0;-ms-flex: 0 3 auto;flex: 0 3 auto;-webkit-box-align: center;-ms-flex-align: center;align-items: center;word-break: break-all;padding: 0 10px;font-family: monospace;font-weight: 600;color: #3b4151;">/cges/knowledgeitems/{idKI}</span>
<div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Obtener KI</div>
</div>
</div>

Creación y edición

Es posible realizar la creación de un KI mediante el siguiente método:

<div style="margin: 0 0 15px;margin-top: 0px;margin-right: 0px;margin-bottom: 15px;margin-left: 0px;border: 1px solid #000;border-radius: 4px;-webkit-box-shadow: 0 0 3px rgba(0,0,0,.19);box-shadow: 0 0 3px rgba(0,0,0,.19);border-color: #49cc90;background: rgba(73,204,144,.1);">
<div style="border-color: #49cc90;display: flex;-webkit-box-align: center;align-items: center;padding: 5px;">
<span style="background: #49cc90;font-size: 14px;font-weight: 700;min-width: 80px;padding: 6px 15px;text-align: center;border-radius: 3px;text-shadow: 0 1px 0 rgba(0,0,0,.1);font-family: sans-serif;color: #fff;">POST</span>
<span style="font-size: 16px;display: -webkit-box;display: -ms-flexbox;display: flex;-webkit-box-flex: 0;-ms-flex: 0 3 auto;flex: 0 3 auto;-webkit-box-align: center;-ms-flex-align: center;align-items: center;word-break: break-all;padding: 0 10px;font-family: monospace;font-weight: 600;color: #3b4151;">/cges/knowledgeitems</span>
<div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Crear KIs</div>
</div>
</div>

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 KI se realiza con la siguiente llamada:

<div style="margin: 0 0 15px;margin-top: 0px;margin-right: 0px;margin-bottom: 15px;margin-left: 0px;border: 1px solid #000;border-radius: 4px;-webkit-box-shadow: 0 0 3px rgba(0,0,0,.19);box-shadow: 0 0 3px rgba(0,0,0,.19);border-color: #fca130;background: rgba(252,161,48,.1);">
<div style="border-color: #fca130;display: flex;-webkit-box-align: center;align-items: center;padding: 5px;">
<span style="background: #fca130;font-size: 14px;font-weight: 700;min-width: 80px;padding: 6px 15px;text-align: center;border-radius: 3px;text-shadow: 0 1px 0 rgba(0,0,0,.1);font-family: sans-serif;color: #fff;">PUT</span>
<span style="font-size: 16px;display: -webkit-box;display: -ms-flexbox;display: flex;-webkit-box-flex: 0;-ms-flex: 0 3 auto;flex: 0 3 auto;-webkit-box-align: center;-ms-flex-align: center;align-items: center;word-break: break-all;padding: 0 10px;font-family: monospace;font-weight: 600;color: #3b4151;">/cges/knowledgeitems/{idKI}</span>
<div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Modificar KI</div>
</div>
</div>

Requisitos funcionales

- Sólo se podrán editar KIs en los siguientes estados:
- Mismos requisitos que en la creación.
- El estado "Borrador" sólo se podrá enviar para KIs en estado "Borrador" para así mantenerlas en borrador hasta que se decida enviar a validación.

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 20 MB y tiene los siguientes métodos para utilizar

<div style="margin: 0 0 15px;margin-top: 0px;margin-right: 0px;margin-bottom: 15px;margin-left: 0px;border: 1px solid #000;border-radius: 4px;-webkit-box-shadow: 0 0 3px rgba(0,0,0,.19);box-shadow: 0 0 3px rgba(0,0,0,.19);border-color: #49cc90;background: rgba(73,204,144,.1);">
<div style="border-color: #49cc90;display: flex;-webkit-box-align: center;align-items: center;padding: 5px;">
<span style="background: #49cc90;font-size: 14px;font-weight: 700;min-width: 80px;padding: 6px 15px;text-align: center;border-radius: 3px;text-shadow: 0 1px 0 rgba(0,0,0,.1);font-family: sans-serif;color: #fff;">POST</span>
<span style="font-size: 16px;display: -webkit-box;display: -ms-flexbox;display: flex;-webkit-box-flex: 0;-ms-flex: 0 3 auto;flex: 0 3 auto;-webkit-box-align: center;-ms-flex-align: center;align-items: center;word-break: break-all;padding: 0 10px;font-family: monospace;font-weight: 600;color: #3b4151;">/cges/knowledgeitems/imagenes</span>
<div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Subida de imágenes a una KI</div>
</div>
</div>
<div style="margin: 0 0 15px;margin-top: 0px;margin-right: 0px;margin-bottom: 15px;margin-left: 0px;border: 1px solid #000;border-radius: 4px;-webkit-box-shadow: 0 0 3px rgba(0,0,0,.19);box-shadow: 0 0 3px rgba(0,0,0,.19);border-color: #61affe;background: rgba(97,175,254,.1);">
<div style="border-color: #61affe;display: flex;-webkit-box-align: center;align-items: center;padding: 5px;">
<span style="background: #61affe;font-size: 14px;font-weight: 700;min-width: 80px;padding: 6px 15px;text-align: center;border-radius: 3px;text-shadow: 0 1px 0 rgba(0,0,0,.1);font-family: sans-serif;color: #fff;">GET</span>
<span style="font-size: 16px;display: -webkit-box;display: -ms-flexbox;display: flex;-webkit-box-flex: 0;-ms-flex: 0 3 auto;flex: 0 3 auto;-webkit-box-align: center;-ms-flex-align: center;align-items: center;word-break: break-all;padding: 0 10px;font-family: monospace;font-weight: 600;color: #3b4151;">/cges/knowledgeitems/imagenes/{idImagen}</span>
<div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Descarga de imagen de KI</div>
</div>
</div>

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:

Enlaces a otras KIs

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

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