Árbol de páginas

Versiones comparadas

Clave

  • Se ha añadido esta línea.
  • Se ha eliminado esta línea.
  • El formato se ha cambiado.

...

Info

Para componer la URL llamada completa, se debe anteponer a lo indicado en la columna URL lo siguiente: {HOST}/api/sgicsp, donde {HOST} de deberá sustituir el dominio correspondiente al entorno al que se está accediendo y dicho acceso será por http o https según el caso.

La excepción son los servicios donde hay una parte en negrita, indicando que en lugar de "sgicsp" se ha de usar el valor en negrita.

Se definen en primer lugar una lista de servicios organizados paso a paso para llevar a cabo el proceso de dar de alta e una convocatoria en el SGI con los datos generales mínimos por parte de terceros y de modificarla a continuación para asociarle el resto de información.

...

Método

URL

Parámetros

Respuesta

Descripción

GET

Servicio /

sgiusr

unidades del API de Usuarios.

Ver URL en ESB - SGI - Usuarios

/unidades

q+s (query + sort)

Lista[UnidadGestion]

Listado de unidades de gestión

GET/modelounidades

q+s (query + sort)

La query estará formada por:

  • unidadGestionRef
ModeloUnidad

Listado de ModeloUnidad de la unidad de gestión indicada

Ejemplo:

unidadGestionRef=="1"

POST/convocatoriasConvocatoriaConvocatoria

Crea la convocatoria.

Los siguientes campos se rellenan con los datos obtenidos de los endpoints anteriores:

  • unidadGestionRef: Se corresponde con el campo id de UnidadGestion obtenida de /sgiusr/unidades 
  • modeloEjecucion: Se corresponde con el campo modeloEjecucion obtenida de /modelounidades filtrando por la unidad gestión que se indique en el campo unidadGestionRef de la convocatoria


...

Método

URL

Parámetros

Respuesta

Descripción

GET/sgemp

Servicio /empresas del API del Sistema de Gestión de Empresas.

Ver URL en SGI - ESB - SGEMP

q+s (query + sort)

La query estará formada por:

  • nombre
  • razonSocial
  • numeroIdentificacion
Lista[Empresas]

Listado de Empresa.

Ejemplo:

numeroIdentificacion=ik="123",nombre=ik="123",razonSocial=ik="123"

GET/programas/plan


ProgramaListado de planes (programas sin padre)
GET/programas/{id}/hijosidProgramaListado de programas que tienen como padre el programa indicado
POST/convocatoriaentidadconvocantesConvocatoriaEntidadConvocanteConvocatoriaEntidadConvocante

Crea la entidad convocante de la convocatoria.

Los siguientes campos se rellenan con los datos obtenidos de los endpoints anteriores:

  • convocatoriaId: Identificador de una convocatoria creada previamente mediante /convocatorias
  • entidadRef: Se corresponde con el campo id de una Empresa obtenida de /sgemp/empresas 
  • programa: Programa obtenido con /programas/plan o con /programas/{id}/hijos


...

Método

URL

Parámetros

Respuesta

Descripción

GET/sgemp

Servicio /empresas del API del Sistema de Gestión de Empresas.

Ver URL en SGI - ESB - SGEMP

q+s (query + sort)

La query estará formada por:

  • nombre
  • razonSocial
  • numeroIdentificacion
Lista[Empresas]

Listado de Empresa.

Ejemplo:

numeroIdentificacion=ik="123",nombre=ik="123",razonSocial=ik="123"

GET/tipofinanciaciones


TipoFinanciacionListado de planes (programas sin padre)
GET/fuentesfinanciacion
FuenteFinanciacionListado de programas que tienen como padre el programa indicado
POST/convocatoriaentidadconvocantesConvocatoriaEntidadFinanciadoraConvocatoriaEntidadFinanciadora

Crea la entidad financiadora de la convocatoria.

Los siguientes campos se rellenan con los datos obtenidos de los endpoints anteriores:

  • convocatoriaId: Identificador de una convocatoria creada previamente mediante /convocatorias
  • entidadRef: Se corresponde con el campo id de una Empresa obtenida de /sgemp/empresas 
  • fuenteFinanciacion: Fuente de financiación obtenida con /fuentesfinanciacion
  • tipoFinanciacion: Tipo obtenido con /tipofinanciaciones


...

Método

URL

Parámetros

Respuesta

Descripción

GET/modeloejecuciones/{id}/modelotipofases

q+s (query + sort)

La query estará formada por:

  • tipoFase.activo
  • convocatoria
Lista[ModeloTipoFase]

Listado de tipos de fase del modelo de ejecución de la convocatoria.

Ejemplo:

tipoFase.activo=="true";convocatoria=="true"

GET/modeloejecuciones/{id}/modelotipodocumentos

q+s (query + sort)

La query estará formada por:

  • tipoDocumento.activo
  • modeloTipoFase.tipoFase.id
Lista[ModeloTipoDocumento]

Listado de tipos de documento del modelo de ejecución de la convocatoria y del tipo de fase si se selecciona una.

Ejemplo:

tipoDocumento.activo=="true";modeloTipoFase.tipoFase.id=="1"

POST/sgdoc

Servicio/documentos del API del Sistema de Gestión de Documentos.

Ver URL en SGI - ESB - SGDOC.


(multipart/form-data)

  • archivo: ficherobinario
DocumentoGuarda el documento en el sgdoc
POST/convocatoriadocumentosConvocatoriaDocumentoConvocatoriaDocumento

Crea la entidad documento de la convocatoria.

Los siguientes campos se rellenan con los datos obtenidos de los endpoints anteriores:

  • convocatoriaId: Identificador de una convocatoria creada previamente mediante /convocatorias
  • documentoRef: Se corresponde con el campo documentoRef obtenido al crear un nuevo documento con /sgdoc/documentos 
  • tipoFase: Se corresponde con el campo tipoFase del ModeloTipoFase obtenido con /modeloejecuciones/{id}/modelotipofases
  • tipoDocumento: Se corresponde con el campo tipoDocumento del ModeloTipoDocumento obtenido con /modeloejecuciones/{id}/modelotipodocumentos


...