...
Para consultar el listado de solicitudes tendremos que consumir el siguiente método de la API:
Para conseguir la respuesta filtrada que necesitamos, habría que realizar la llamada con la siguiente URL:
...
| 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/solicitudes</span>
<div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Obtener listado de solicitudes</div>
</div>
</div> |
Para conseguir la respuesta filtrada que necesitamos, habría que realizar la llamada con la siguiente URL:
| URL parcial |
|---|
| /cges/tablas/solicitudes?registros=20&pagina=3 |
Filtrado de la respuesta
Si sólo necesita que la respuesta incluya un conjunto limitado de la información devuelta por consumo de datos o claridad en la información, puede hacer uso del parámetro _incluir. Este parámetro permite enviar varias cadenas de texto haciendo referencia a la estructura de la respuesta para obtener los datos filtrados.
Ejemplo: Queremos consultar el REST de obtención de un listado de solicitudes y obtener el número de la solicitud, el recurso afectado y la fecha de apertura.
Para consultar el listado de solicitudes tendremos que consumir el siguiente método de 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/solicitudes</span>
<div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Obtener listado de solicitudes</div>
</div>
</div> |
Para conseguir la respuesta filtrada que necesitamos, habría que realizar la llamada con la siguiente URL:
| URL parcial |
|---|
| /cges/tablas/solicitudes?_incluir=total&_incluir=solicitudes.recurso.recurso&_incluir=solicitudes.idSolicitud&_incluir=solicitudes.fechas.fechaApertura |
| Respuesta filtrada obtenida |
|---|
{ |
Ordenación de listados
Esta sección contiene información acerca del formato necesario para solicitar la ordenación de listados.
Formatos de atributos
Actualmente, la ordenación de listados sólo está disponible para los siguientes métodos de 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/solicitudes</span>
<div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Obtener listado de solicitudes</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;">/faro/solicitudes</span>
<div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Obtener listado de solicitudes de FARO</div>
</div>
</div> |
La ordenación se realiza sobre los atributos de la respuesta que comprenden cada uno de los elementos del array JSON.
Para ordenar, es necesario enviar un parámetro de consulta _ordenar con el nombre del campo por el que se pretender ordenar seguido del modificador :asc o :desc para la ordenación ascendente o descendente respectivamente. Si no se envía un modificador, la ordenación es ascendente. Sólo se puede enviar un máximo de tres parámetros de ordenación.
Ejemplo: Ordenar la consulta por el nombre del recurso de forma ascendente, la fecha de apertura de forma descendente y el usuario asignado de forma ascendente.
Para conseguir la respuesta ordenada que necesitamos, habría que realizar la llamada con la siguiente URL:
| URL parcial |
|---|
| /cges/tablas/solicitudes?_ordenar=recurso.recurso&_ordenar=fechas.fechaApertura:desc&_ordenar=usuarioAsignado.usuarioAsignado:asc |
Operaciones por lotes
Para consumir los recursos REST de Servicios CGES, en ocasiones será necesario la utilización de operaciones por lotes u operaciones de batch para mantener la integridad de una operación en la que intervienen diferentes recursos para alcanzar un mismo fin. Esta forma de operar asegura la coherencia del proceso y obliga a la persona que consume el servicio a realizar las operaciones en un conjunto y orden determinados.
Para ello, habrá que consumir el servicio a través del siguiente método REST:
| 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/_batch</span>
<div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Operación por lotes</div>
</div>
</div> |
Filtrado de la respuesta
Si sólo necesita que la respuesta incluya un conjunto limitado de la información devuelta por consumo de datos o claridad en la información, puede hacer uso del parámetro _incluir. Este parámetro permite enviar varias cadenas de texto haciendo referencia a la estructura de la respuesta para obtener los datos filtrados.
Ejemplo: Queremos consultar el REST de obtención de un listado de solicitudes y obtener el número de la solicitud, el recurso afectado y la fecha de apertura.
Para consultar el listado de solicitudes tendremos que consumir el siguiente método de la API:
...
Para conseguir la respuesta filtrada que necesitamos, habría que realizar la llamada con la siguiente URL:
...
...
{
"total": 36,
"solicitudes": [{
"recurso": { "recurso": "NUEVA WEB TECNICA" },
"idSolicitud": "4429937",
"fechas": { "fechaApertura": "2017-09-13T10:44:46.000Z" }
},{
"recurso": { "recurso": "UNIFICA" },
"idSolicitud": "4665952",
"fechas": { "fechaApertura": "2018-07-25T10:48:06.000Z" }
}]
}
Ordenación de listados
Esta sección contiene información acerca del formato necesario para solicitar la ordenación de listados.
Formatos de atributos
Actualmente, la ordenación de listados sólo está disponible para los siguientes métodos de la API:
...
La ordenación se realiza sobre los atributos de la respuesta que comprenden cada uno de los elementos del array JSON.
Para ordenar, es necesario enviar un parámetro de consulta _ordenar con el nombre del campo por el que se pretender ordenar seguido del modificador :asc o :desc para la ordenación ascendente o descendente respectivamente. Si no se envía un modificador, la ordenación es ascendente. Sólo se puede enviar un máximo de tres parámetros de ordenación.
Ejemplo: Ordenar la consulta por el nombre del recurso de forma ascendente, la fecha de apertura de forma descendente y el usuario asignado de forma ascendente.
Para conseguir la respuesta ordenada que necesitamos, habría que realizar la llamada con la siguiente URL:
...
Para consumir los recursos REST de Servicios CGES, en ocasiones será necesario la utilización de operaciones por lotes u operaciones de batch para mantener la integridad de una operación en la que intervienen diferentes recursos para alcanzar un mismo fin. Esta forma de operar asegura la coherencia del proceso y obliga a la persona que consume el servicio a realizar las operaciones en un conjunto y orden determinados.
Para ello, habrá que consumir el servicio a través del siguiente método REST:
...
Estructura de la petición de batch
...