- Creado por Usuario genérico para HERCULES, modificado por última vez en may 13, 2022
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 14 Siguiente »
Son los servicios que el SGI expone en su propio ESB pero que tienen que implementar las Universidades que implanten el SGI. Además de exponerlos, el propio SGI consume estos servicios para ofrecer toda la funcionalidad. De forma general el SGI consume todos los métodos que expone en su ESB de tal forma que todos ellos son necesarios para su funcionamiento, solo en algunos casos que se detallan a continuación hay algunos métodos que no son necesarios por el SGI y que los comentamos a continuación agrupados por funcionalidad.
El SGI consume todos los métodos expuestos en:
Método | URL | Parámetros | Respuesta | Descripción |
---|---|---|---|---|
POST | /periodos-amortizacion | PeriodoAmortizacion | Crea un periodo de amortización | |
PUT | /periodos-amortizacion/{id} | PeriodoAmortizacion | Modifica un periodo de amortización. Se pasa por url el identificador del periodo de amortización. | |
DELETE | /periodos-amortizacion/{id} | Elimina un periodo de amortización. Se pasa por url el identificador del periodo de amortización. |
Método | URL | Parámetros | Respuesta | Descripción |
---|---|---|---|---|
SGI - SGE | ||||
GET | /facturas-emitidas/columnas | q+s (query + sort) La query estará formada por:
El campo reducida puede tomar los siguientes valores:
Si no esta informado el campo reducida se considera false. | Lista[Columna] | Listado con las columnas que va a devolver la llamada /facturas-emitidas Por cada columna se indica un id, nombre, si es una columna acumulable (se va a hacer una suma de ella en el SGI) Ver el apartado "Columnas Factura Emitida" para ver que columnas se deben de mostrar. |
GET | /facturas-emitidas | q+s (query + sort) La query estará formada por:
El campo reducida puede tomar los siguientes valores:
Si no esta informado el campo reducida se considera false. | Lista[FacturaEmitida] | Listado con las facturas emitidas del SGE. Por cada factura emitida se devolverán los siguientes campos:
|
GET | /facturas-previstas-emitidas | q+s (query + sort) La query estará formada por:
proyectoIdSGI: identificador del proyecto en el SGI | Lista[FacturaPrevistaEmitida] | Listado con las facturas emitidas del SGE. Por cada factura emitida se devolverán los siguientes campos:
|
GET | /facturas-emitidas/{id} | FacturaEmitidaDetalle | Detalle de la factura emitida con todas sus columnas.
| |
GET | /documentos/{id}/archivo | Binario (en la cabecera ira el contentType) | Devuelve el binario del documento | |
SGE - SGI | ||||
GET | /facturas-previstas | q+s (query + sort) La query estará formada por:
proyectoIdSGI: identificador del proyecto en el SGI | Lista[FacturaPrevista] | Listado de todas las facturas previstas, registradas en el SGI validadas por el IP y con fecha de conformidad (tanto si ya tienen la factura emitida creada en el SGE como sino). La relación entre el calendario de facturación del SGI y facturas emitidas se establecerá en el SGE. Este servicio será el utilizado en el SGE en la pantalla de creación de factura emitida para mostrar el listado de items del calendario de facturación creados en el SGI (tendrán que eliminar aquellos items del calendario del SGI que ya tienen factura emitida relacionada o creada). La relación factura emitida (SGE) - número previsión (SGI) se almacenará en el SGE. Por cada factura prevista se devolverán los siguientes campos:
|
Método | URL | Parámetros | Respuesta | Descripción |
---|---|---|---|---|
GET | /ejecucion-economica/columnas | q+s (query + sort) La query estará formada por:
El campo reducida puede tomar los siguientes valores:
Si no esta informado el campo reducida se considera false. El tipoOperacion puede tomar los siguientes valores:
| Lista[Columna] | Listado con las columnas que va a devolver la llamada /ejecucion-economica Por cada columna se indica un id, nombre, si es una columna acumulable (se va a hacer una suma de ella en el SGI) Ver el apartado "Columnas Ejecución económica" para ver que columnas se deben de mostrar dependiendo del tipo de operación (campo tipoOperacion) y si es reducida o no |
GET | /ejecucion-economica | q+s (query + sort) La query estará formada por:
El campo reducida puede tomar los siguientes valores:
Si no esta informado el campo reducida se considera false. El tipoOperacion puede tomar los siguientes valores:
| Lista[DatoEconomico] | Listado con los datos económicos pedidos según el campo tipoOperacion. Por cada dato económico se devolverán los siguientes campos:
|
GET | /ejecucion-economica/{id} | tipoOperacion El tipoOperacion puede tomar los siguientes valores (cuando estamos en la llamada de detalle de dato económico):
| DatoEconomicoDetalle | Detalle del dato económico con todas sus columnas.
El listado de campos a mostrar dependerá de que dato económico sea, si es una factura o gasto, un viaje o dieta o un personal contratado. |
Validación de gastos | ||||
GET | /gastos/columnas | q+s (query + sort) La query estará formada por:
Si no esta informado el campo reducida se considera false. El campo estado puede tomar dos valores:
El campo reducida puede tomar los siguientes valores:
| Lista[Columna] | Listado con las columnas que va a devolver la llamada /gastos Por cada columna se indica un id, nombre, si es una columna acumulable (se va a hacer una suma de ella en el SGI) Ver el apartado "Columnas Validación de gastos" para ver que columnas se deben de mostrar dependiendo de si es reducida o no |
GET | /gastos | q+s (query + sort) La query estará formada por:
El campo estado puede tomar dos valores:
El campo reducida puede tomar los siguientes valores:
Si no esta informado el campo reducida se considera false. | Lista[DatoEconomico] | Listado de gastos pendientes de pasar por la "Validación de gastos" si en el campo del filtrado estado = 'Pendiente' o listado de gastos que ya han sido validados (han pasado por la "Validación de gastos") si en el campo del filtrado estado = 'Validado' Para cada gasto se devolverán los siguientes datos:
|
GET | /gastos/{id} | DatoEconomicoDetalle | Detalle de un gasto. Para cada gasto se devolverán los siguientes datos:
| |
PATCH | /gastos/{id}/validar | Comentario | Se valida el gasto y recibe como parámetro el comentario en caso de que lo tuviese. | |
PATCH | /gastos/{id}/rechazar | Comentario | Se rechaza el gasto y recibe como parámetro el comentario en caso de que lo tuviese. | |
PENDIENTE | Se necesita un servicio que reciba como parámetros la lista de identificadores del gasto y devuelve las columnas a mostrar en la validación de gastos con la suma ya realizada, en este caso "Importe validado" e "Importe pagado" (realiza la sumas de esos importes de todos los gastos pasados como parámetro) Se necesitará primero la función que devuelva el nombre de las columnas? | |||
PENDIENTE | Se necesita un servicio que reciba como parámetro la lista de códigos económicos usados en el proyecto (en elegibilidad) y devuelva para cada código económico la suma del importe de todos los gastos pendientes para ese código económico Se necesitará primero la función que devuelva el nombre de las columnas? | |||
GET | /documentos/{id} | Documento | Devuelve el detalle del documento | |
GET | /documentos/{id}/archivo | Binario (en la cabecera ira el contentType) | Devuelve el binario del documento |
Método | URL | Parámetros | Respuesta | Permisos | Descripción |
---|---|---|---|---|---|
GET | /proyectos | q+s (query + sort) La query estará formada por:
| Lista[Proyecto] | Búsqueda de proyectos económicos, se puede buscar por el identificador del proyecto económico, por el título (o parte del título), entre un rango de fechas en las que se incluye la fecha de inicio o entre un rango de fechas entras lasque se incluye la fecha de fin del proyecto. Devuelve un listado de Proyectos económicos que cumplen los criterios de búsqueda. Los parámetros q y s están explicados en: | |
GET | /proyectos/{id} | id | Proyecto | Detalle de los datos generales de un proyecto económico | |
GET | /proyectos/formly/create | Formly | Devuelve el formulario (formly) a pintar para la pantalla de solicitar alta proyecto | ||
GET | /proyectos/formly/update | Formly | Devuelve el formulario (formly) a pintar para la pantalla de solicitar nueva relación con el proyecto económico (para relacionar un nuevo proyecto SGI con el proyecto SGE) | ||
POST | /proyectos/formly | JSON | id Vendrá relleno si la creación es síncrona y no vendrá si es asíncrona. | Recibe como parámetro la respuesta del usuario del formulario de alta proyecto (formly) con los campos necesarios para crear un proyecto en el SGE | |
PUT | /proyectos/formly/{id} | JSON | Recibe como parámetro la respuesta del usuario del formulario de modificación proyecto (formly) con los campos necesarios para crear una nueva relación de un proyecto SGI con el proyecto SGE | ||
GET | /codigos-economicos-gastos | Lista[CodigoEconomicoGasto] | Listado de CodigoEconomicoGasto de tipo gasto | ||
GET | /codigos-economicos-gastos/{id} | CodigoEconomicoGasto | Detalle de CodigoEconomicoGasto | ||
GET | /codigos-economicos-ingresos | Lista[CodigoEconomicoIngreso] | Listado de CodigoEconomicoIngreso de tipo ingreso | ||
GET | /codigos-economicos-ingresos/{id} | CodigoEconomicoIngreso | Detalle de CodigoEconomicoIngreso | ||
POST | /proyectos/anualidades/ | Lista[ProyectoAnualidadPartida] | Recibe como parámetro el listado partidas presupuestarias para una anualidad y un proyecto. |
Método | URL | Parámetros | Respuesta | Descripción |
---|---|---|---|---|
Gastos | ||||
GET | /gastos-invencion/columnas | q+s (query + sort) La query estará formada por:
| Lista[Columna] | Listado con las columnas que va a devolver la llamada /gastos-invencion. Por cada columna se indica un id, nombre, si es una columna acumulable (se puede manejar como un importe y hacer operaciones numéricas con ella en el SGI). Por defecto, devolverá las siguientes columnas:
El tipo de operación |
GET | /gastos-invencion | q+s (query + sort) La query estará formada por:
El tipo de operación puede tomar los siguientes valores:
| Lista[DatoEconomico] | Listado de todos los gastos asociados a una invención. Para cada gasto se devolverán los siguientes datos:
Si el tipo de operación se informa con el valor GAS, se han de devolver todos los gastos asociados a la invención. Si por el contrario el tipo de operación es REP, se han de devolver del conjunto de gastos asociados a la invención únicamente aquellos que se deban tener en cuenta para el reparto de regalías. |
GET | /gastos-invencion/{id} | DatoEconomicoDetalle | Detalle de un gasto. Para cada gasto se devolverán los siguientes datos:
| |
Ingresos | ||||
GET | /ingresos-invencion/columnas | q+s (query + sort) La query estará formada por:
| Lista[Columna] | Listado con las columnas que va a devolver la llamada /ingresos-invencion. El identificador de proyecto a enviar al SGE ha de ser el del proyecto económico en Justo. Por cada columna se indica un id, nombre, si es una columna acumulable (se puede manejar como un importe y hacer operaciones numéricas con ella en el SGI). Por defecto, devolverá las siguientes columnas:
|
GET | /ingresos-invencion | q+s (query + sort) La query estará formada por:
| Lista[DatoEconomico] | Listado de todos los ingresos asociados a una invención. La asociación en el SGI se realizará a través de contratos de CSP (proyectos) y el identificador de proyecto a enviar al SGE ha de ser el del proyecto económico en Justo. Los ingresos devueltos se corresponderán con las facturas emitidas asociadas a la invención a través del contrato. Para cada ingreso se devolverán los siguientes datos:
|
Método | URL | Parámetros | Respuesta | Permisos | Descripción |
---|---|---|---|---|---|
GET | /areas-conocimiento | q+s (query + sort) La query estará formada por:
| Lista[AreaConocimiento] | Listado de áreas de conocimiento. Nota: en el caso de no recibirse un padreId en la query, se devolverán todas las áreas de conocimiento y en caso de indicarse en la query que se quieren solo las que tengan un padreId con valor "null" se devolverán únicamente las de primer nivel o nivel raíz. Ejemplo de query para obtener solo áreas de conocimiento raíz (su padre es null): padreId=na= | |
GET | /areas-conocimiento/{id} | id | AreaConocimiento | Detalle del área de conocimiento cuyo identificador se indica por parámetro. | |
GET | /departamentos | Lista[Departamento] | Listado de departamentos. | ||
GET | /paises | Lista[Pais] | Listado de países del SGI. | ||
GET | /paises/{id} | Pais | Detalle del país cuyo identificador se indica por parámetro. | ||
GET | /comunidades-autonomas | q+s (query + sort) La query estará formada por:
| Lista[ComunidadAutonoma] | Listado de comunidades autónomas. Nota: en el caso de recibirse un país como parámetro se devolverán todas las comunidades autónomas de ese país. | |
GET | /comunidades-autonomas/{id} | ComunidadAutonoma | Detalle de la comunidad autónoma cuyo identificador se indica por parámetro. | ||
GET | /provincias | q+s (query + sort) La query estará formada por:
| Lista[Provincia] | Listado de provincias. Nota: en el caso de recibirse una comunidad autónoma como parámetro se devolverán todas las provincias de esa comunidad autónoma. | |
GET | /provincias/{id} | Provincia | Detalle de la provincia cuyo identificador se indica por parámetro. | ||
GET | /clasificaciones | q+s (query + sort) La query estará formada por:
| Lista[Clasificacion] | Listado de clasificaciones. Nota: en el caso de no recibirse un padreId en la query, se devolverán todas las clasificaciones y en caso de indicarse en la query que se quieren solo las que tengan un padreId con valor "null" se devolverán únicamente las de primer nivel o nivel raíz. Sobre estas clasificaciones se aplicará además el filtro indicado en tipoClasificacion (en caso de venir informado). Ejemplo de query para obtener sólo las clasificaciones raíz (su padre es null) del tipo de clasificación "Sectores Industriales": tipoClasificacion==(SECTORES_INDUSTRIALES);padreId=na= | |
GET | /clasificaciones/{id} | id | Clasificacion | Detalle de la clasificación cuyo identificador se indica por parámetro. | |
POST | /palabras-clave | Lista[String] | Crea palabras clave si no existen previamente. | ||
GET | /palabras-clave | q+s (query + sort) La query estará formada por:
| Lista[String] | Busca/Lista palabras clave. | |
GET | /centros | Lista[Centro] | Listado de centros. | ||
GET | /centros/{id} | Centro | Detalle del centro cuyo identificador se indica por parámetro. |
Además de los siguientes bloques consume casi todos los métodos salvo los indicados al final de cada una de las tablas (Métodos donde el SGI solo hace de pasarela entre Universidad):
Método | URL | Parámetros | Respuesta | Permisos | Descripción |
---|---|---|---|---|---|
GET | /personasFast |
| Lista[Persona] | Listado de Persona. Ejemplo: [mailto:busqueda=skarmeta@um.es&colectivoId=]busqueda=skarmeta@um.es&colectivoId=(1,2,3,4) busqueda=jorge carrillo&colectivoId=(2) NOTA: La búsqueda no es sensible a mayúsculas ni minúsculas. Los parámetros no deben ir entrecomillados. Si no se indica el parámetro colectivoId, se buscará en todos los colectivos. Se devuelven como máximo 11 registros, al devolver más de 10 registros el buscador indicará que existen más registros y se puede refinar la búsqueda. | |
GET | /personas | q+s (query + sort) La query estará formada por:
| Lista[Persona] | Listado de Persona. Ejemplo: colectivoId=in=(refPAS,refPDI);(nombre=like=jim,apellidos=like=jim,email=like=jim,nombreApellidos=like=jim) colectivoId=in=(refPAS,refPDI);(nombre=like=nombre.apellido@um.es,apellidos=like=nombre.apellido@um.es,email=like=nombre.apellido@um.es,nombreApellidos=like=nombre.apellido@um.es) Nota: tipoColetivo y colectivoId son mutuamente excluyentes. En el caso se recibir un tipoColectivo se traducirá a los colectivos que lo formen. | |
GET | /personas/{id} | id | Persona | Detalle de los datos generales de una persona (este la persona activo o no) | |
POST | /personas | JSON | id Vendrá relleno si la creación es síncrona y no vendrá si es asíncrona. | Recibe como parámetro la respuesta del usuario del formulario de datos de alta (formly) con los campos necesarios para crear una persona. | |
PUT | /personas | JSON | Recibe como parámetro la respuesta del usuario del formulario de datos de modificación (formly) con los campos necesarios para actualizar una persona. | ||
GET | /personas/formly/{id} | JSON | Devuelve los datos a pintar en el formulario de Ver Detalle/Actualizar en el SGI (formly). | ||
GET | /personas/formly/create | Formly | Devuelve el formulario (formly) a pintar para la pantalla de solicitar alta persona. Ver IU-GEN-0061- Solicitar alta de persona. | ||
GET | /personas/formly/update | Formly | Devuelve el formulario (formly) a pintar para la pantalla de solicitar modificar persona. | ||
GET | /personas/formly/view | Formly | Devuelve el formulario (formly) a pintar para la pantalla de ver detalle de persona. | ||
GET | /datos-personales/persona/{id} | id | DatosPersonales | Detalle de los datos personales de una persona independientemente de que este activa o no la persona (datos de dirección, nacimiento, etc). | |
GET | /datos-contacto/persona/{id} | id | DatosContacto | Contiene la lista de emails, incluido si cada uno es principal o no, y/o de teléfonos de una persona (independientemente de que este activa o no la persona) | |
GET | /vinculaciones/persona/{id} | Vinculacion | Detalle de los datos de vinculación vigentes de una persona (independientemente de que esté activa o no la persona). Ver UM - SGI - ESB - SGP - Adaptaciones integración para su implementación en el SGI. | ||
GET | /vinculaciones/persona/{id}/vinculaciones-categorias-profesionales | q+s (query + sort) La query estará formada por:
| VinculacionCategoriaProfesional | Si no se especifica ningún filtrado, deberá recuperar la categoría profesional a la que está asociada la persona y que sea vigente. Para recuperar la vinculación activa a una FECHA determinada se generaría una consulta RSQL del tipo:
Devolver la vinculación asociada a la persona con identificador {id} donde el objeto que viene en la vinculacionCategoriaProfesional de esa vinculación debe cumplir que su atributo fechaObtencion sea menor o igual que una FECHA dada y su atributo fechaFin sea mayor o igual que una FECHA dada o no debe tener valor. Ver UM - SGI - ESB - SGP - Adaptaciones integración para su implementación en el SGI. | |
GET | /datos-academicos/persona/{id} | id | DatosContacto | Contiene el nivel académico de la persona (independientemente de que este activa o no la persona) | |
GET | /colectivos | Lista[Colectivo] | Listado de colectivos ordenados alfabéticamente de forma ascendente. | ||
GET | /tipos-documento | Lista[TipoDocumento] | Listado de tipos de documento de identificación personal ordenados alfabéticamente de forma ascendente. | ||
GET | /sexos | Lista[Sexo] | Listado de sexos ordenados alfabéticamente de forma ascendente. | ||
GET | /categorias-profesionales | Lista[CategoriaProfesional] | Listado de categorías profesionales ordenadas alfabéticamente de forma ascendente. | ||
GET | /categorias-profesionales/{id} | CategoriaProfesional | Detalle de la categoría profesional cuyo identificador se indica por parámetro. | ||
GET | /niveles-academicos | Lista[NivelAcademico] | Listado de niveles académicos ordenados alfabéticamente de forma ascendente. | ||
GET | /niveles-academicos/{id} | NivelAcademico | Detalle del nivel académico cuyo identificador se indica por parámetro. | ||
GET | /personas/{id}/fotografia | id | Fotografia | Detalle de la fotografía digital de la persona (independientemente de que este activa o no la persona) | |
GET | /sexenios | fecha | Lista[Sexenio] | Devuelve una lista de identificadores de persona con el número de sexenios en la fecha pasada por parámetro. En caso de que la fecha se envíe vacía se enviará el número de sexenios en el momento actual Se tendrá que mirar para la fecha pasada por parámetro el número de sexenios de cada PDI de la Universidad. Si no tiene sexenios no se enviarán Ejemplo:
| |
GET | /direccion-tesis | anioDefensa | Lista[DireccionTesis] | Devuelve la lista de Direcciones de tesis (incluida la personaRef indicando la persona que es el director de la tesis) cuya fecha de defensa sea en el año que se le pasa por parámetro Si se le pasa el parámetro del año de la fecha de defensa. Ejemplo:
| |
Métodos donde el SGI solo hace de pasarela entre Universidad y CVN (No son necesarios para el funcionamiento del SGI) | |||||
GET | /personas/modificadas-ids | q+s La query estará formada por:
| Lista[String] | Listado de los identificadores de personas que han sufrido cambios en los datos identificativos (nombre, apellidos, sexo, número de documento y tipo de documento) y/o en los datos personales (fecha de nacimiento, país de nacimiento, comunidad autónoma de nacimiento y ciudad de nacimiento) y/o en datos de contacto (país de contacto, comunidad autónoma de contacto, provincia de contacto, ciudad de contacto, dirección de contacto, código postal, listado de teléfonos y listado de emails) y/o en la fotografía a partir de la fecha de modificación pasada por parámetro y/o en los sexenios. | |
GET | /sexenios/persona/{id} | fecha | Sexenio | Devuelve el número de sexenios de la persona. Si se le pasa el parámetro de la fecha devuelve el número de sexenios en esa fecha, sino se devuelve el número de sexenios a la fecha actual. Ejemplo:
| |
GET | /formacion/modificados-ids | q+s La query estará formada por:
| Lista[Long] | Listado de identificadores de las personas que han tenido modificaciones en formación realizada. Se utilizarán los siguientes parámetros en la llamada al servicio:
Ejemplo:
| |
GET | /formacion/{id} | tipoFormacion | Lista[Formación (del tipo solicitado)] Ver entidades en https://confluence.um.es/confluence/pages/viewpage.action?pageId=397534658 | Detalle sobre los datos de la Formación Recibida, dependiendo del ID de la persona y el tipo de formación. Se utilizará el siguiente parámetro en la llamada al servicio:
Ejemplo:
| |
GET | /actividad-docente/modificados-ids | q+s La query estará formada por:
| Lista[Long] | Listado de identificadores de las personas que han tenido modificaciones en la actividad docente. Se utilizarán los siguientes parámetros en la llamada al servicio:
Ejemplo:
| |
GET | /actividad-docente/{id} | tipoActividad | Lista[Actividad docente (del tipo solicitado)] Ver entidades en https://confluence.um.es/confluence/display/HERCULES/Actividad+docente+-+CVN | Detalle sobre los datos de la Actividad Docente, dependiendo del ID de la persona y el tipo de actividad. Se utilizará el siguiente parámetro en la llamada al servicio:
Ejemplo:
|
Método | URL | Parámetros | Respuesta | Descripción |
---|---|---|---|---|
GET | /empresas | q+s (query + sort) La query estará formada por:
| Lista[Empresa] | Listado de Empresa. Ejemplo: nombre=like=(Tree);(razonSocial=like=SL) |
GET | /empresas/{id} | id | Empresa | Detalle de los datos generales de una empresa. |
GET | /empresas/formly/create | Formly | Devuelve el formulario (formly) a pintar para la pantalla de solicitar alta empresa, pestaña "Datos generales". Ver IU-GEN-0081 - Solicitar alta de empresa. | |
POST | /empresas | JSON | Recibe como parámetro la respuesta del usuario del formulario de datos de alta (formly) con los campos necesarios para crear una empresa. | |
PUT | /empresas | JSON | id Vendrá relleno si la creación es síncrona y no vendrá si es asíncrona. | Recibe como parámetro la respuesta del usuario del formulario de datos de modificación (formly) con los campos necesarios para actualizar una empresa. |
GET | /empresas/formly/{id} | JSON | Devuelve los datos a pintar en el formulario de Ver Detalle/Actualizar en el SGI (formly). | |
GET | /datos-contacto/empresa/{id} | id | DatosContacto | Contiene los datos de contacto de una empresa. |
GET | /tipos-identificador | Lista[TipoIdentificador] | Listado de tipos de identificador fiscal para las empresas ordenados alfabéticamente de forma ascendente. | |
Métodos donde el SGI solo hace de pasarela entre Universidad y CVN (No son necesarios para el funcionamiento del SGI) | ||||
GET | /empresas/modificadas-ids | q+s La query estará formada por:
| Lista[String] | Listado de los identificadores de empresas que han sufrido cambios en los datos de identificativos de la empresa o en sus datos de contacto. |
En la siguiente página se detalla un ejemplo concreto de los servicios implementados por la Universidad de Murcia para permitir el funcionamiento del SGI.
- Sin etiquetas