Fieldeas WEB API

Soporte Navegadores

Desarrollo

Api Docs

Functions

getDataEntity(params) ⇒ Promise

Obtiene los datos de una entidad con opcion de filtrado simple y paginacion

Kind: global function

| Param | Type | Description | | --- | --- | --- | | params | Object | Parametros de entrada | | params.success | requestCallback | Callback success | | params.error | requestCallback | Callback error | | params.entity | string | Nombre de la entidad que se quiere consultar | | params.filter | string | Criterios de filtrado a aplicar en la consulta | | params.order | string | Criterios de ordenacion para la consulta | | params.page_number | number | Numero de pagina a retraer | | params.elements_per_page | number | Numero de elementos a retraer por página | | params.lang | number | Idioma del registro |

getDataEntityExtended(params) ⇒ Promise

Obtiene los datos de una entidad con opcion de filtrado simple, paginacion y el número de registros por página

Kind: global function

| Param | Type | Description | | --- | --- | --- | | params | Object | Parametros de entrada | | params.success | requestCallback | Callback success | | params.error | requestCallback | Callback error | | params.entity | string | Nombre de la entidad que se quiere consultar | | params.filter | string | Criterios de filtrado a aplicar en la consulta | | params.order | string | Criterios de ordenacion para la consulta | | params.page_number | number | Numero de elementos a retraer por página | | params.elements_per_page | number | Numero de elementos a retraer por página | | params.lang | number | Idioma del registro |

getDataEntityWithGroupedFilter(params) ⇒ Promise

Obtiene los datos de una entidad con opcion de filtrado agrupados y paginacion

Kind: global function

| Param | Type | Description | | --- | --- | --- | | params | Object | Parametros de entrada | | params.success | requestCallback | Callback success | | params.error | requestCallback | Callback error | | params.entity | string | Nombre de la entidad que se quiere consultar | | params.filter | string | Criterios de filtrado a aplicar en la consulta | | params.order | string | Criterios de ordenacion para la consulta | | params.page_number | number | Numero de elementos a retraer por página | | params.elements_per_page | number | Numero de elementos a retraer por página | | params.lang | number | Idioma del registro |

getDataEntityWithGroupedFilterExtended(params) ⇒ Promise

Obtiene los datos de una entidad con opcion de filtros agrupados, paginacion y el número de registros por página

Kind: global function

| Param | Type | Description | | --- | --- | --- | | params | Object | Parametros de entrada | | params.success | requestCallback | Callback success | | params.error | requestCallback | Callback error | | params.entity | string | Nombre de la entidad que se quiere consultar | | params.filter | string | Criterios de filtrado a aplicar en la consulta | | params.order | string | Criterios de ordenacion para la consulta | | params.page_number | number | Numero de elementos a retraer por página | | params.elements_per_page | number | Numero de elementos a retraer por página | | params.lang | number | Idioma del registro |

setDataEntity(params) ⇒ Promise

Inserta, actualiza o elimina datos en una entidad

Kind: global function

| Param | Type | Description | | --- | --- | --- | | params | Object | Parametros de entrada | | params.success | requestCallback | Callback success | | params.error | requestCallback | Callback error | | params.operation | string | Operacion ['INSERT', 'UPDATE', 'DELETE'] | | params.entity | string | Nombre de la operación | | params.data | Object | Datos a enviar | | params.fullResponse | boolean | Devuelve una respuesta completa | | params.sendEmptyValues | boolean | Vacia campos string si se envian vacios | | params.ignoreFieldsCheck | boolean | Ignora la validación y filtro de campos de la entidad |

getEntityVersionFields(params) ⇒ Promise

Obtiene los campos de las versiones de una entidad

Kind: global function

| Param | Type | Description | | --- | --- | --- | | params | Object | Parametros de entrada | | params.success | requestCallback | Callback success | | params.error | requestCallback | Callback error | | params.entity | string | Nombre de la operación |

getEntityVersionFieldsV1(params) ⇒ Promise

Obtiene los campos de las versiones de una entidad, Se añade información de campo, tipo, filtrable, PK, Obligatorio, Autonumérico

Kind: global function

| Param | Type | Description | | --- | --- | --- | | params | Object | Parametros de entrada | | params.success | requestCallback | Callback success | | params.error | requestCallback | Callback error | | params.entity | string | Nombre de la operación |

getEntity(params) ⇒ Promise

Obtiene la información asociada a una entidad.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | params | Object | Parametros de entrada | | params.success | requestCallback | Callback success | | params.error | requestCallback | Callback error | | params.entity | string | Nombre de la operación |

downloadCSV(params) ⇒ Promise

Obtiene los datos de una entidad y los descarga como un archivo CSV

Kind: global function

| Param | Type | Description | | --- | --- | --- | | params | Object | Parametros de entrada | | params.success | requestCallback | Callback success | | params.error | requestCallback | Callback error | | params.entity | string | Nombre de la operación | | params.filter | Object | JSON {"Campo":"ID_CONTRACT_REQUEST","Operador":"=","Valor":id} | | params.nPag | number | Número de página | | params.nReg | number | Número de registro | | params.order | string | Campo de ordenación |

getDataEntityWithGroupedFilterExtended(params) ⇒ Promise

Obtiene datos mediante sentencias SQL

Kind: global function

| Param | Type | Description | | --- | --- | --- | | params | Object | Parametros de entrada | | params.success | requestCallback | Callback success | | params.error | requestCallback | Callback error | | params.select | string | Cualquier campo de la entidad | | params.from | string | Nombre de la entidad | | params.join | string | Sentencia JOIN. Tres tipos INNER JOIN, RIGHT JOIN, LEFT JOIN | | params.where | string | Sentencia WHERE | | params.orderby | string | Orden de los datos. Default: '[params.from].FechaHora DESC' | | params.page_number | number | Numero de elementos a traer por página | | params.elements_per_page | number | Numero de elementos a traer por página |

© 2017 Fieldeas.