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.
| HTML |
|---|
<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 soluciones</div>
</div>
</div> |
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.
...
- Filtros de compatibilidad software y/o hardware que permiten cargar las soluciones compatibles para asociar a solicitudes con recursos software o hardware.
- Para cargar los KIs compatibles a una solicitud, se debe filtrar por uuidRecurso y por la cualidad de software/hardware del mismo.
- 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.
| HTML |
|---|
<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 solución</div>
</div>
</div> |
Consulta SimilEco
| Estado | ||||
|---|---|---|---|---|
|
...
También es posible realizar una consulta a colecciones indexadas de soluciones utilizando las búsquedas semánticas.
Creación y edición
Es posible realizar la creación de una solución mediante el siguiente método:
| HTML |
|---|
<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 solución</div> </div> </div> |
Requisitos funcionales
El
...
Creación y edición
Es posible realizar la creación de una solución mediante el siguiente método:
| HTML |
|---|
<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 solución</div>
</div>
</div> |
Requisitos funcionales
...
El titulo es obligatorio y debe tener un máximo de 255 caracteres.
titulo es obligatorio y debe tener un máximo de 255 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.
- Si la visibilidad de la KI es para un público objetivo con caracter de Usuario Final:
- El campo solucionUsuario es obligatorio y permite un máximo de 4000 caracteres. En este campo se registrará la solución ofrecida al usuario final para resolver el problema.
- El campo solucion es opcional
...
- y permite un máximo de 4000 caracteres.
...
- En este campo se registrará la parte técnica de la solución dirigida al profesional TIC en caso de ser necesario.
- Si la visibilidad de la KI es para un público objetivo con caracter de Profesional TIC:
- El campo solucion es obligatorio y permite un máximo de 4000 caracteres. En este campo se registrará la parte técnica de la solución dirigida al profesional TIC.
- El campo solucionUsuario será ignorado, ya que no es necesario registrar información dirigida al usuario final en este tipo de soluciones
...
- .
- 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 un recurso a una solución. Los recursos compatibles se pueden consultar como recursos de infraestructura filtrando por el codigo=KI. Esta consulta devuelve los recursos compatibles con la creación y modificación, que son recursos de tipo aplicación o los recursos SW_COMERCIAL, NO_RECEPCIONADO y NO_RECEPCIONADO_HW.
| Info |
|---|
/cgescms/recursos/infraestructura?codigo=KI |
...
La edición de solución se realiza con la siguiente llamada:
| HTML |
|---|
<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 solución</div>
</div>
</div> |
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.
| Advertencia | ||
|---|---|---|
| ||
Para realizar correctamente la modificación se debe enviar el objeto completo cada vez que se consuma este recurso. |
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:
| HTML |
|---|
<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 soluciones</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/tablas/adjuntos/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</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:
| Info |
|---|
<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:
| Info |
|---|
<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.