­Home‎ > ‎

API Reference


API Call Format


Format....

Param

Value

Host

https://app.aeegle.com

Content-type

application/json;charset=UTF-8


URIs

Operation

URI

HTTP

Protocolo

Description

Create a Record

/app/api/v1/create

POST

Obtiene un único registro de un formulario, se debe especificar el identificador del registro.

Update a Record

/app/api/v1/update

POST

Para modificar uno o todos los campos de un registro, se debe conocer el identificador del registro



Request parameters

Param

Type Value

Required

Description

authToken

String

True

Valid token

formId

String

True

Id of the form

model

JSON

True

Object JSON whit list of fields to save




Developer API Field List

Field

Data Type

Description

Notes

Textbox

String

Almacena una cadena de longitud variable. La cadena podrá contener desde 0 u el número definido en las propiedades de este campo hasta un máximo del número definido en las propiedades de este campo.

 

Number

Number

Almacena un número en coma flotante de precisión doble. The decimal uses the IEEE 754 decimal128 floating-point numbering format which supports 34 decimal digits (i.e. significant digits) and an exponent range of −6143 to +6144.

 

Textarea

String

Almacena una cadena con la capacidad de almacenar saltos de línea su longitud es variable. La cadena podrá contener desde 0 u el número definido en las propiedades de este campo hasta un máximo del número definido en las propiedades de este campo.

 

Rich Text

String

Almacena una cadena con la capacidad de almacenar saltos de línea su longitud es variable. La cadena podrá contener desde 0 u el número definido en las propiedades de este campo hasta un máximo del número definido en las propiedades de este campo.

 

Date

Timestamp

The unix time stamp is a way to track time as a running total of seconds. This count starts at the Unix Epoch on January 1st, 1970 at UTC. Therefore, the unix time stamp is merely the number of seconds between a particular date and the Unix Epoch. It should also be pointed out that this point in time technically does not change no matter where you are located on the globe.

 

Time

String

Almacena una cadena de un máximo de 5 caracteres de longitud

 

Dropdown

String

Almacena en una cadena con el identificador de la opción seleccionada

 

Dropdown

Array[Number]

Almacena un arreglo con los números de los identificadores de las opciones seleccionadas.

Multiple

Email

String

Almacena una cadena de longitud variable. La cadena podrá contener desde 0 hasta un máximo del número definido en las propiedades de este campo.

 

Checkbox

Object{Bool}

Almacena un objeto en formato JSON con las claves de las opciones comprendidas en el campo y su valor booleano de la siguiente forma:

checked      = true

unchecked  = false

 

Radio

String

Almacena una cadena con el identificador de la opción seleccionada.

 

Currency

Number

Almacena un número en coma flotante de precisión doble.Con un tamaño máximo de 8 bytes (64-bit IEEE 754 floating point)

 

Sequence

String

Almacena una cadena de longitud variable.

 

Concat Fields

String

Almacena una cadena de longitud variable. La cadena podrá contener hasta un máximo de la suma de los números definido en las propiedades de los campos seleccionados.

 

Formula

Number

Almacena un número en coma flotante de precisión doble.Con un tamaño máximo de 8 bytes (64-bit IEEE 754 floating point)

 
    

Lookup

Array[Object]

Almacena un arreglo con objetos en formato JSON con el identificador el registro al que hace referencia.

 

Child Table

 

Almacena un arreglo con objetos en formato JSON con los identificadores de los registros a que hace referencia.

 

Enterprise Lookup

Array[Object]

Almacena un arreglo con objetos en formato JSON con el snapshot del objeto al que hacer referencia en las propiedades del campo

 

Directory Lookup

Array[Object]

Almacena un arreglo con objetos en formato JSON con el snapshot del objeto en person.

 

Relation Object

   
    

Image

Object{String}

Almacena un objeto en formato JSON con las claves de las opciones comprendidas para el campo.

 

Drive Picker

Array[Object]

Almacena un arreglo de objetos en formato JSON con las claves de las opciones comprendidas para el campo.

 

Horizontal Line

   

Current User

Object{String}

Almacena un objeto en formato JSON con las claves de las opciones comprendidas para el campo.

 

System Date

Timestamp

The unix time stamp is a way to track time as a running total of seconds. This count starts at the Unix Epoch on January 1st, 1970 at UTC. Therefore, the unix time stamp is merely the number of seconds between a particular date and the Unix Epoch. It should also be pointed out that this point in time technically does not change no matter where you are located on the globe.

 


How to Fetch Reference Object (Foreign Key Value)

Los campos que pueden hacer referencia a otro objetos son los siguientes: 

La forma de obtener registros que son referenciados desde uno de los campos antes mencionados es de la siguiente forma:

Hacer un request a Forms metadata

En la lista de campos del formulario identificar el campo lookup con el que estamos trabajando y poner énfasis en las partes de response remarcadas en la imagen.

{
    "message": "The form has been found successfully",
    "nodeResponse": {
        "form": {
            "fields": [
                { ... },
                { ... },
                { ... },
                {
                    "id": "lookup_position",
                    "type": "lookup",
                    "displayName": "Position",
                    "datasource": {
"body": {
        "formId": "59d55a39fad72600103c2648", (FormId)
                            "query": {         (Query)
                                "projections": [
                                    "text_name"
                                ]
                            },
                 "authToken": "<<VALID-TOKEN>> (AuthToken)
               },
                 "uri": "/app/api/v1/search"  (Service)
                    }
                }
            ]
        }
    },
    "action": "GET",
    "code": 200
}



  1. service: URI para realizar un Search Record
  2. authToke: Token válido del formulario al que se hace referencia el campo lookup. 
  3. formId: Identificador del formulario al que hace referencia el campo lookup
  4. query: Parámetro para obtener la proyección de los registros según se ha configuro el campo lookup.

Con los parámetros descritos en el numeral anterior realizar el respectivo request para obtener los registros a los que hace referencia su campo lookup.