WS REST - ConsultaGenericaBD

Descargar como pdf o txt
Descargar como pdf o txt
Está en la página 1de 8

Consulta genérica

BD por WS REST
WS REST – ConsultaGenericaBD
06/05/2021

Contenido

1. Licencias ....................................................................................................... 2
1.1 Licencias necesarias ..................................................................................... 2
2. Servicio Web .................................................................................................. 2
2.1 Información general...................................................................................... 2
2.2 consulta-generica-db .................................................................................... 3

|1
WS REST – ConsultaGenericaBD
06/05/2021

1. Licencias
1.1 Licencias necesarias

El servicio web REST “consulta-generica-bd” está disponible mediante la licencia de


los siguientes paquetes de servicios web:

• WS Autoservicio del empleado


• WS Centros remotos
• WS Nómina

2. Servicio Web
2.1 Información general

Existen dos servicios web REST:

• GET → http://localhost/epsilonnetws/generics/health

Este método simplemente devuelve un “OK”. Sirve para comprobar que se


puede acceder a los servicios web REST de forma correcta

• POST → http://localhost/epsilonnetws/generics/consulta-generica-bd

Los dos métodos necesitan de estas cabeceras en sus peticiones:

LLAVE VALOR
X-Auth-APP_NAME APP_XXXXXX
X-Auth-APP_TOKEN xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Los valores de estas dos cabeceras que autorizan las peticiones serán proporcionadas
por Grupo Castilla.

Se pueden filtrar las tablas y vistas a consultar según 2 maneras:

• Delimitar las tablas y vistas a consultar con la llave:

<add key="ws_tablas_consulta" value="siglas,empleado" />

Las tablas/vistas irán separadas por “,”. Si no se especifica esta llave se podrán
consultar TODAS las tablas y vistas de la BD.

Esta llave debe configurar-se en el fichero del servidor web:

…\Grupo Castilla\Epsilonnet\ws\Connection.config

|2
WS REST – ConsultaGenericaBD
06/05/2021

• Mediante la tabla TOKEN_CONSULTA_TABLA. En el portal existe un mantenimiento


para introducir las tablas que serán consultables:

2.2 consulta-generica-db

A parte de las dos cabeceras anteriores se requiere de esta otra para llamar al
servicio web:

LLAVE VALOR
Content-Type application/json

“Body” o cuerpo de la petición


{
"fields": "",
"from": "",
"where": "",
"order": ""
}

Este método termina haciendo una consulta en la BD parecida a esto:

select campo1,campo2 from tabla where condicion order by orden

|3
WS REST – ConsultaGenericaBD
06/05/2021

Definición de los atributos:

ATRIBUTO REQUERIDO DESCRIPCIÓN


fields NO Nombre de los campos a devolver separados por
comas. Si no hay este atributo o su valor es “” se
devolverá todos los campos de la tabla o vista.

from SI Especificar el nombre de la tabla o vista a consultar


where NO Se puede especificar la condición a aplicar. Si no hay
valor se devuelven todos los registros.
order NO Se puede especificar el orden de los registros a
devolver.

Ejemplos de peticiones:

PETICIÓN RESPUESTA
{ [
"from": "SIGLAS" {
} "SIGLAS": "AD",
"D_SIGLAS": "ALDEA ",
O también así: "ID": 1,
"GCROWVER": "2010-09-10T11:22:19.16"
{ },
"fields": "", {
"from": "SIGLAS", "SIGLAS": "AG",
"where": "", "D_SIGLAS": "AGREGADO ",
"order": "" "ID": 2,
} "GCROWVER": "2010-09-10T11:22:19.167"
}
]

PETICIÓN RESPUESTA

|4
WS REST – ConsultaGenericaBD
06/05/2021

{ [
"fields": "SIGLAS, RTRIM(D_SIGLAS) AS DESCIP", {
"from": "SIGLAS", "SIGLAS": "AG",
"where": "ID IN (1,2)", "DESCIP": "AGREGADO"
"order": "ID DESC" },
} {
"SIGLAS": "AD",
"DESCIP": "ALDEA"
}
]

La respuesta de la petición devolverá estos “StatusCode”:

STATUS CODE DESCRIPCIÓN


200 - OK Respuesta correcta. En el cuerpo de la respuesta vendrá la
lista de registros consultados
400 – Bad Request Se devuelve cuando no se pasa el atributo “from” o cuando la
sentencia es incorrecta (tabla, vistas o campos no existen,
etc…)
401 - Unautorized Si no se pasa correctamente las cabeceras X-Auth-APP_NAME y
X-Auth-APP_TOKEN
403 - Forbidden Si no se encuentra la licencia que permite utilizar este servicio
web o cuando la tabla o vista a consultar no está permitida

Grupo Castilla facilitará a los clientes que utilicen estos servicios web ejemplos en
forma de colección (.json) sobre Postman o sobre la extensión de Google Chrome:
ARC

Capturas de ejemplo de Postman:

|5
WS REST – ConsultaGenericaBD
06/05/2021

|6
WS REST – ConsultaGenericaBD
06/05/2021

|7

También podría gustarte