API REST de QuintaDB

QuintaDB REST API Diseñado para permitirle explotar completamente el potencial de los datos almacenados en la base de datos de QuintaDB. Al usar esta API, puede obtener más de lo que la interfaz de QuintaDB ofrece actualmente. De hecho, le ofrecemos la oportunidad de hacer todo lo que necesita con los datos. Por ejemplo, puede crear scripts, aplicaciones informáticas y aplicaciones móviles personalizadas para diversas plataformas como iPhone/Android y otros. QuintaDB se quedará allí, donde almacenará, administrará y usará sus datos con otros

Información general sobre llamadas a API

Todas las llamadas deben contener una clave API REST, que se puede encontrar haciendo clic en el botón "Claves API" al principio de la página.
La respuesta del servidor se puede recibir en formato JSON o XML , según su solicitud.
A continuación, mostramos tablas con las respuestas del servidor para cada solicitud. Las URL se mostrarán como /apps.json , lo que significa que debe llamar al método con el enlace https://QuintaDB.ru /apps.json en su programa. Tenga en cuenta que todas las llamadas deben utilizar el protocolo https y debe comprobar la validez del certificado SSL del servidor.

Base de datos

Estos atributos de la base de datos se pueden obtener utilizando la API REST

el ID único de la base de datos

name

Nombre

created_at

hora en la que se creó la base de datos

updated_at

hora en que se actualizó la base de datos

ver todas las bases de datos

Parámetros

rest_api_key

tu clave API

page

las bases de datos se muestran 20 por página, por lo que la página puede ser 1..5

estamos ejecutando una consulta (JSON)

formato

JSON

Método

GET

URL

/apps.json

contenido de la solicitud

{"page":1,"rest_api_key":"API_KEY"}

respuesta: devuelve todas las bases de datos

    
{"databases":[
{"id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Database Name 1",
 "created_at"      : "2021-08-16T05:42:40-05:00",
 "updated_at"      : "2021-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0
 },
{"id"              : "aOWO3eVXHdHie1WeGFE8k2"
 "name"            : "Database Name 2",
 "created_at"      : "2021-04-29T01:26:22-05:00",
 "updated_at"      : "2021-08-16T00:47:56-05:00",
 "dtypes_count"    : 768,
 "entities_count"  : 6,
 "properties_count": 240
} ]}

estamos ejecutando una consulta (XML)

formato

XML

Método

GET

URL

/apps.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<page>1</page>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

respuesta: devuelve todas las bases de datos

    
<?xml version="1.0" encoding="UTF-8"?>
<databases type="array">
  <database>
    <id>aOWO_dVXHdHie1WeGFE8k2</id>
    <name>Database name 1</name>
    <created-at type="datetime">2021-08-16T05:42:40-05:00</created-at>
    <updated-at type="datetime">2021-08-16T05:42:40-05:00</updated-at>
    <dtypes-count type="integer">0</dtypes-count>
    <entities-count type="integer">1</entities-count>
    <properties-count type="integer">0</properties-count>
  </database>
  <database>
    <id>aOWO3eVXHdHie1WeGFE8k2</id>
    <name>Database Name 2</name>
    <created-at type="datetime">2021-04-29T01:26:22-05:00</created-at>
    <updated-at type="datetime">2021-08-16T00:47:56-05:00</updated-at>
    <dtypes-count type="integer">768</dtypes-count>
    <entities-count type="integer">6</entities-count>
    <properties-count type="integer">240</properties-count>
  </database>
</databases>

obtener la base de datos por ID

Parámetros

rest_api_key

tu clave API

APP_ID

Debe conocer el ID de la base de datos que desea eliminar. Puede encontrar el ID después de recibir todas las bases de datos . Conociendo el ID de la base de datos, se necesita reemplazar la ID en la URL, por ejemplo: /apps/ID.json en /apps/aOWO_dVXHdHie1WeGFE8k2.json

estamos ejecutando una consulta (JSON)

formato

JSON

Método

GET

URL

/apps/APP_ID.json

contenido de la solicitud

{"rest_api_key":"API_KEY"}

respuesta: devuelve información sobre la base de datos

    
{"database":{
 "id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Database Name 1",
 "created_at"      : "2011-08-16T05:42:40-05:00",
 "updated_at"      : "2011-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0,
 "complex_app?"    : true,
 "complex_app_with_fresh_data?" : false
 }
}

estamos ejecutando una consulta (XML)

formato

XML

Método

GET

URL

/apps/APP_ID.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

respuesta: devuelve información sobre la base de datos

    
<?xml version="1.0" encoding="UTF-8"?>
<database>
 <id>aOWO_dVXHdHie1WeGFE8k2</id>
 <name>Database name 1</name>
 <created-at type="datetime">2011-08-16T05:42:40-05:00</created-at>
 <updated-at type="datetime">2011-08-16T05:42:40-05:00</updated-at>
 <dtypes-count type="integer">0</dtypes-count>
 <entities-count type="integer">1</entities-count>
 <properties-count type="integer">0</properties-count>
</database>

obtener la base de datos por nombre

Parámetros

rest_api_key

tu clave API

Nombre

Debe conocer el nombre de la base de datos. Puede obtener el nombre ejecutando la consulta Obtenga todas las bases de datos ..

estamos ejecutando una consulta (JSON)

formato

JSON

Método

GET

URL

/apps/search.json

contenido de la solicitud

{"rest_api_key":"API_KEY", "name":"Database Name 1"}

respuesta: devuelve información sobre la base de datos

    
{"database":{
 "id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Database Name 1",
 "created_at"      : "2021-08-16T05:42:40-05:00",
 "updated_at"      : "2021-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0,
 "complex_app?"    : true,
 "complex_app_with_fresh_data?" : false
 }
}

estamos ejecutando una consulta (XML)

formato

XML

Método

GET

URL

/apps/search.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<rest_api_key>API_KEY</rest_api_key> <name>Database Name 1</name> </api_call_params>

respuesta: devuelve información sobre la base de datos

    
<?xml version="1.0" encoding="UTF-8"?>
<database>
 <id>aOWO_dVXHdHie1WeGFE8k2</id>
 <name>Database name 1</name>
 <created-at type="datetime">2021-08-16T05:42:40-05:00</created-at>
 <updated-at type="datetime">2021-08-16T05:42:40-05:00</updated-at>
 <dtypes-count type="integer">0</dtypes-count>
 <entities-count type="integer">1</entities-count>
 <properties-count type="integer">0</properties-count>
</database>

actualiza la base de datos

Parámetros

rest_api_key

tu clave API

APP_ID

name

nuevo nombre de la base de datos

estamos ejecutando una consulta (JSON)

formato

JSON

Método

PUT

URL

/apps/APP_ID.json

contenido de la solicitud

{"rest_api_key":"API_KEY",
"name":"New database name"}

respuesta: devuelve información sobre la base de datos

    
{"database":{
 "id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "New database name",
 "created_at"      : "2021-08-16T05:42:40-05:00",
 "updated_at"      : "2021-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0,
 "complex_app?"    : true,
 "complex_app_with_fresh_data?" : false
 }
}

estamos ejecutando una consulta (XML)

formato

XML

Método

PUT

URL

/apps/APP_ID.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<name>New database name</rest_api_key>
</api_call_params>

respuesta: devuelve información sobre la base de datos

    
<?xml version="1.0" encoding="UTF-8"?>
<database>
 <id>aOWO_dVXHdHie1WeGFE8k2</id>
 <name>New database name</name>
 <created-at type="datetime">2021-08-16T05:42:40-05:00</created-at>
 <updated-at type="datetime">2021-08-16T05:42:40-05:00</updated-at>
 <dtypes-count type="integer">0</dtypes-count>
 <entities-count type="integer">1</entities-count>
 <properties-count type="integer">0</properties-count>
</database>

elimina la base de datos

Parámetros

rest_api_key

tu clave API

APP_ID

estamos ejecutando una consulta (JSON)

formato

JSON

Método

DELETE

URL

/apps/APP_ID.json

contenido de la solicitud

{"rest_api_key":"API_KEY"}

respuesta

    
{"databases":[{
 "id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Database Name 1",
 "created_at"      : "2011-08-16T05:42:40-05:00",
 "updated_at"      : "2011-08-16T05:42:40-05:00",
 "dtypes_count"    : 0,
 "entities_count"  : 1,
 "properties_count": 0
 },
{"id"              : "aOWO3eVXHdHie1WeGFE8k2"
 "name"            : "Database Name 2",
 "created_at"      : "2011-04-29T01:26:22-05:00",
 "updated_at"      : "2011-08-16T00:47:56-05:00",
 "dtypes_count"    : 768,
 "entities_count"  : 6,
 "properties_count": 240
} ]}

estamos ejecutando una consulta (XML)

formato

XML

Método

DELETE

URL

/apps/APP_ID.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
<databases type="array">
 <database>
   <id>aOWO_dVXHdHie1WeGFE8k2</id>
   <name>Database name 1</name>
   <created-at type="datetime">2011-08-16T05:42:40-05:00</created-at>
   <updated-at type="datetime">2011-08-16T05:42:40-05:00</updated-at>
   <dtypes-count type="integer">0</dtypes-count>
   <entities-count type="integer">1</entities-count>
   <properties-count type="integer">0</properties-count>
 </database>
 <database>
   <id>aOWO3eVXHdHie1WeGFE8k2</id>
   <name>Database Name 2</name>
   <created-at type="datetime">2011-04-29T01:26:22-05:00</created-at>
   <updated-at type="datetime">2011-08-16T00:47:56-05:00</updated-at>
   <dtypes-count type="integer">768</dtypes-count>
   <entities-count type="integer">6</entities-count>
   <properties-count type="integer">240</properties-count>
 </database>
</databases>

después de eliminar la base de datos, este método devuelve todas las bases de datos restantes.

Crea una aplicación

Parámetros

rest_api_key

tu clave API

database_name

el nombre de la base de datos

form_name

el nombre del formulario. No es posible crear una base de datos sin un formulario porque no tiene sentido en una base de datos sin un formulario.

estamos ejecutando una consulta (JSON)

formato

JSON

Método

POST

URL

/apps.json

contenido de la solicitud

{"rest_api_key":"API_KEY", database_name: "Database 1", form_name: "Form 1"}

respuesta: devuelve información sobre la base de datos

    
{"database":
   {"id"              : "aOWO_dVXHdHie1WeGFE8k2"
    "name"            : "Database Name 1",
    "created_at"      : "2011-08-16T05:42:40-05:00",
    "updated_at"      : "2011-08-16T05:42:40-05:00",
    "dtypes_count"    : 0,
    "entities_count"  : 1,
    "properties_count": 0
    }
}

estamos ejecutando una consulta (XML)

formato

XML

Método

POST

URL

/apps.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<rest_api_key>API_KEY</rest_api_key> <database_name>Database 1</database_name> <form_name>Form 1</form_name> </api_call_params>

respuesta: devuelve información sobre la base de datos

    
  <?xml version="1.0" encoding="UTF-8"?>
    <database>
      <id>aOWO_dVXHdHie1WeGFE8k2</id>
      <name>Database name 1</name>
      <created-at type="datetime">2011-08-16T05:42:40-05:00</created-at>
      <updated-at type="datetime">2011-08-16T05:42:40-05:00</updated-at>
      <dtypes-count type="integer">0</dtypes-count>
      <entities-count type="integer">1</entities-count>
      <properties-count type="integer">0</properties-count>
    </database>

En caso de error. Recibirá un mensaje de error, por ejemplo, 'El nombre de la aplicación ya existe.'

Formulario

Estos atributos de formulario se pueden obtener de la API REST

ID único para el formulario

name

Nombre

desc

Descripción

post_action

lista de destinatarios de correo electrónico

obtener cualquier formulario

Parámetros

rest_api_key

tu clave API

APP_ID

estamos ejecutando una consulta (JSON)

formato

JSON

Método

GET

URL

/apps/APP_ID/entities.json

contenido de la solicitud

{rest_api_key":"API_KEY"}

respuesta: obtiene todos los formularios en la base de datos

    
{"forms":[
 {
 "id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
 },
 {
 "id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      } ]}

estamos ejecutando una consulta (XML)

formato

XML

Método

GET

URL

/apps/APP_ID/entities.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

respuesta: obtiene todos los formularios en la base de datos

    
<?xml version="1.0" encoding="UTF-8"?>
<forms type="array">
<form>
<id>c7zH3cKWrnqQvbrG8Nd3C7</id>
<app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
<name>Form1</name>
<desc nil="true"></desc>
<post-action>igor.petrushenko@gmail.com</post-action>
<position type="integer">0</position>
<sort-by nil="true"></sort-by>
<asc type="boolean">false</asc>
<per-page type="integer">10</per-page>
<allow-delete type="boolean">false</allow-delete>
<new-widget nil="true"></new-widget>
<records-widget nil="true"></records-widget>
<target-page nil="true"></target-page>
<allow-database type="boolean">true</allow-database>
<send-emails type="boolean">true</send-emails>
<settings nil="true"></settings>
</form>
<form>
<id>aszH3cKWrnqQvbrG8Nd3C7</id>
<app-id>ddFSkDDdncMyoKjGnWFmoE</app-id>
<name>Form2</name>
<desc nil="true"></desc>
<post-action>igor.petrushenko@gmail.com</post-action>
<position type="integer">0</position>
<sort-by nil="true"></sort-by>
<asc type="boolean">false</asc>
<per-page type="integer">10</per-page>
<allow-delete type="boolean">false</allow-delete>
<new-widget nil="true"></new-widget>
<records-widget nil="true"></records-widget>
<target-page nil="true"></target-page>
<allow-database type="boolean">true</allow-database>
<send-emails type="boolean">true</send-emails>
<settings nil="true"></settings>
</form>
</forms>

descargue el formulario en ID

Parámetros

rest_api_key

tu clave API

APP_ID

Debe conocer la ID del formulario. Puede encontrar ENTITY_ID después de recibir todos los formularios . Cuando conozca la ID del módulo, debe incluir ENTITY_ID en la URL, por ejemplo: /apps/APP_ID/entity.json en /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

estamos ejecutando una consulta (JSON)

formato

JSON

Método

GET

URL

/apps/APP_ID/entities/ID.json

contenido de la solicitud

{"rest_api_key":"API_KEY"}

respuesta: devuelve información sobre formularios

    
{"form":   
{"id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      }
}

estamos ejecutando una consulta (XML)

formato

XML

Método

GET

URL

/apps/APP_ID/entities/ID.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

respuesta: devuelve información sobre formularios

    
<?xml version="1.0" encoding="UTF-8"?>
<form>
 <id>c7zH3cKWrnqQvbrG8Nd3C7</id>
 <app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
 <name>Form1</name>
 <desc nil="true"></desc>
 <post-action>igor.petrushenko@gmail.com</post-action>
 <position type="integer">0</position>
 <sort-by nil="true"></sort-by>
 <asc type="boolean">false</asc>
 <per-page type="integer">10</per-page>
 <allow-delete type="boolean">false</allow-delete>
 <new-widget nil="true"></new-widget>
 <records-widget nil="true"></records-widget>
 <target-page nil="true"></target-page>
 <allow-database type="boolean">true</allow-database>
 <send-emails type="boolean">true</send-emails>
 <settings nil="true"></settings>
</form>

obtener el formulario por nombre

Parámetros

rest_api_key

tu clave API

database_name

Debe conocer el nombre de la base de datos. Puede obtener el nombre ejecutando la consulta Obtenga todas las bases de datos ..

form_name

Necesita saber el nombre del módulo. Puede obtenerlo vinculando Obtenga todos los módulos

estamos ejecutando una consulta (JSON)

formato

JSON

Método

GET

URL

/apps/search/entities/search.json

contenido de la solicitud

{"rest_api_key":"API_KEY", "database_name": "Database 21", "form_name": "Form Name 1"}

respuesta: devuelve información sobre formularios

    
{"form":   
{"id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      }
}

estamos ejecutando una consulta (XML)

formato

XML

Método

GET

URL

/apps/search/entities/search.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<database_name>Database 21</database_name>
<form_name>Form1</form_name>
</api_call_params>

respuesta: devuelve información sobre formularios

    
<?xml version="1.0" encoding="UTF-8"?>
<form>
 <id>c7zH3cKWrnqQvbrG8Nd3C7</id>
 <app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
 <name>Form1</name>
 <desc nil="true"></desc>
 <post-action>igor.petrushenko@gmail.com</post-action>
 <position type="integer">0</position>
 <sort-by nil="true"></sort-by>
 <asc type="boolean">false</asc>
 <per-page type="integer">10</per-page>
 <allow-delete type="boolean">false</allow-delete>
 <new-widget nil="true"></new-widget>
 <records-widget nil="true"></records-widget>
 <target-page nil="true"></target-page>
 <allow-database type="boolean">true</allow-database>
 <send-emails type="boolean">true</send-emails>
 <settings nil="true"></settings>
</form>

actualiza el formulario

Parámetros

rest_api_key

tu clave API

APP_ID

name

Nuevo nombre de formulario. Ver todas las opciones disponibles aquí

estamos ejecutando una consulta (JSON)

formato

JSON

Método

PUT

URL

/apps/APP_ID/entities/ID.json

contenido de la solicitud

{"rest_api_key":"API_KEY",
"name":"New form name"}

respuesta: devuelve información sobre formularios

    
{"form":   
{   
"id"              : "aOWO_dVXHdHie1WeGFE8k2",
"app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
"name"            : "New form name",
"desc"            : "Form description",
"post_action"     : "email@email.com",
"position"        : 0,
"sort_by"         : null,
"asc"             : false,
"per_page"        : 10,
"allow_delete"    : false,
"new_widget"      : null,
"records_widget"  : null,
"target_page"     : null,
"allow_database"  : true,
"send_emails"     : true,
"settings"        : null
     }
}

estamos ejecutando una consulta (XML)

formato

XML

Método

PUT

URL

/apps/APP_ID/entities/ID.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<name>New form name</name>
</api_call_params>

respuesta: devuelve información sobre formularios

    
<?xml version="1.0" encoding="UTF-8"?>
<form>
 <id>c7zH3cKWrnqQvbrG8Nd3C7</id>
 <app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
 <name>New form name</name>
 <desc nil="true"></desc>
 <post-action>igor.petrushenko@gmail.com</post-action>
 <position type="integer">0</position>
 <sort-by nil="true"></sort-by>
 <asc type="boolean">false</asc>
 <per-page type="integer">10</per-page>
 <allow-delete type="boolean">false</allow-delete>
 <new-widget nil="true"></new-widget>
 <records-widget nil="true"></records-widget>
 <target-page nil="true"></target-page>
 <allow-database type="boolean">true</allow-database>
 <send-emails type="boolean">true</send-emails>
 <settings nil="true"></settings>
</form>

elimina el formulario

Parámetros

rest_api_key

tu clave API

APP_ID

Debe conocer la ID del módulo que desea eliminar. Puede encontrar la ID después de recibir todos los módulos . Conociendo la ID del módulo, debe reemplazar el ID en la URL, por ejemplo: /apps/APP_ID/entities/ID.json en /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2.json

estamos ejecutando una consulta (JSON)

formato

JSON

Método

DELETE

URL

/apps/APP_ID/entities/ID.json

contenido de la solicitud

{"rest_api_key":"API_KEY"}

respuesta

    
{"forms":[{"id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
       },
      {  "id"      : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "Form Name 1",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      } ]}

estamos ejecutando una consulta (XML)

formato

XML

Método

DELETE

URL

/apps/APP_ID/entities/ID.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
<forms type="array">
<form>
<id>c7zH3cKWrnqQvbrG8Nd3C7</id>
<app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
<name>Form1</name>
<desc nil="true"></desc>
<post-action>igor.petrushenko@gmail.com</post-action>
<position type="integer">0</position>
<sort-by nil="true"></sort-by>
<asc type="boolean">false</asc>
<per-page type="integer">10</per-page>
<allow-delete type="boolean">false</allow-delete>
<new-widget nil="true"></new-widget>
<records-widget nil="true"></records-widget>
<target-page nil="true"></target-page>
<allow-database type="boolean">true</allow-database>
<send-emails type="boolean">true</send-emails>
<settings nil="true"></settings>
</form>
<form>
<id>aszH3cKWrnqQvbrG8Nd3C7</id>
<app-id>ddFSkDDdncMyoKjGnWFmoE</app-id>
<name>Form2</name>
<desc nil="true"></desc>
<post-action>igor.petrushenko@gmail.com</post-action>
<position type="integer">0</position>
<sort-by nil="true"></sort-by>
<asc type="boolean">false</asc>
<per-page type="integer">10</per-page>
<allow-delete type="boolean">false</allow-delete>
<new-widget nil="true"></new-widget>
<records-widget nil="true"></records-widget>
<target-page nil="true"></target-page>
<allow-database type="boolean">true</allow-database>
<send-emails type="boolean">true</send-emails>
<settings nil="true"></settings>
</form>
</forms>

Crea un formulario

Parámetros

rest_api_key

tu clave API

APP_ID

name

Nombre del formulario

estamos ejecutando una consulta (JSON)

formato

JSON

Método

POST

URL

/apps/APP_ID/entities.json

contenido de la solicitud

{"rest_api_key":"API_KEY", name: "New form"}

respuesta: devuelve información sobre formularios

    
{"form":   
{   
 "id"              : "aOWO_dVXHdHie1WeGFE8k2",
 "app_id"          : "aOWO3eVXHdHie1WeGFE8k2",
 "name"            : "New form",
 "desc"            : "Form description",
 "post_action"     : "email@email.com",
 "position"        : 0,
 "sort_by"         : null,
 "asc"             : false,
 "per_page"        : 10,
 "allow_delete"    : false,
 "new_widget"      : null,
 "records_widget"  : null,
 "target_page"     : null,
 "allow_database"  : true,
 "send_emails"     : true,
 "settings"        : null
      }
}

estamos ejecutando una consulta (XML)

formato

XML

Método

POST

URL

/apps/APP_ID/entities.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<name>New form</rest_api_key>
</api_call_params>

respuesta: devuelve información sobre formularios

    
<?xml version="1.0" encoding="UTF-8"?>
<form>
 <id>c7zH3cKWrnqQvbrG8Nd3C7</id>
 <app-id>akFSkDDdncMyoKjGnWFmoE</app-id>
 <name>New form</name>
 <desc nil="true"></desc>
 <post-action>igor.petrushenko@gmail.com</post-action>
 <position type="integer">0</position>
 <sort-by nil="true"></sort-by>
 <asc type="boolean">false</asc>
 <per-page type="integer">10</per-page>
 <allow-delete type="boolean">false</allow-delete>
 <new-widget nil="true"></new-widget>
 <records-widget nil="true"></records-widget>
 <target-page nil="true"></target-page>
 <allow-database type="boolean">true</allow-database>
 <send-emails type="boolean">true</send-emails>
 <settings nil="true"></settings>
</form>

campo

Tales atributos de campo se pueden obtener de la API REST

ID única del campo

entity_id

identificador de campo de formulario

name

Nombre

type_name

Tipo de campo. Puede ser: string, text, integer, float, select, radio button, check box, date, dob, datetime, file, image, boolean, language, states, table, country, time_zone, note, divider, formula, autoincrement, login, password, signature, linked_column, rel, subform

Obtener campos de formulario

Parámetros

rest_api_key

tu clave API

APP_ID

ENTITY_ID

estamos ejecutando una consulta (JSON)

formato

JSON

Método

GET

URL

/apps/APP_ID/entities/ENTITY_ID/properties.json

contenido de la solicitud

{rest_api_key":"API_KEY"}

respuesta: obtiene todos los campos del formulario

    
{"fields":[
{"id"               : "aOWO_dVXHdHie1WeGFE8k2",
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 },
{"id"               : "1i2i4VXHdHie1WeGFE8k2" ,
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 }
  ]}

estamos ejecutando una consulta (XML)

formato

XML

Método

GET

URL

/apps/APP_ID/entities/ENTITY_ID/properties.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

respuesta: obtiene todos los campos del formulario

    
<?xml version="1.0" encoding="UTF-8"?>
<fields type="array">
<field>
  <id>clrSoltHDdQyozW5NcLrGd</id>
  <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
  <name>test</name>
  <desc nil="true"></desc>
  <type-name>string</type-name>
  <default></default>
  <validate-options></validate-options>
  <position type="integer">0</position>
  <visible type="boolean">true</visible>
  <size type="integer">50</size>
  <cols type="integer">43</cols>
  <rows type="integer">10</rows>
</field>
<field>
  <id>ddUHDhCgzeW6HkW4NdG3vE</id>
  <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
  <name>test2</name>
  <desc nil="true"></desc>
  <type-name>select</type-name>
  <default>1slct2slct3slct4slct5</default>
  <validate-options></validate-options>
  <position type="integer">1</position>
  <visible type="boolean">true</visible>
  <size type="integer">50</size>
  <cols type="integer">43</cols>
  <rows type="integer">10</rows>
</field>
</fields>

obtener un campo

Parámetros

rest_api_key

tu clave API

APP_ID

ENTITY_ID

Debe conocer el ID del campo. Puede encontrar el ID después de recibir todos los campos del formulario . Conociendo el ID del campo, debe reemplazar el ID. en la URL, por ejemplo: /apps/APP_ID/entity/ENTITY_ID/properties/ID.json en /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

estamos ejecutando una consulta (JSON)

formato

JSON

Método

GET

URL

/apps/APP_ID/entities/ENTITY_ID/properties/ID.json

contenido de la solicitud

{"rest_api_key":"API_KEY"}

respuesta

    
{"field":  
{
"id"               : "aOWO_dVXHdHie1WeGFE8k2",
"entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
"name"             : "Field Name 1",
"desc"             : "Field description",
"type_name"        : "string",
"default"          : "default value",
"validate_options" : "",
"position"         : 0,
"visible"          : true,
"size": 50,
"cols": 43,
"rows": 10
}
}

estamos ejecutando una consulta (XML)

formato

XML

Método

GET

URL

/apps/APP_ID/entities/ENTITY_ID/properties/ID.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
<field>
 <id>clrSoltHDdQyozW5NcLrGd</id>
 <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
 <name>test</name>
 <desc nil="true"></desc>
 <type-name>string</type-name>
 <default></default>
 <validate-options></validate-options>
 <position type="integer">0</position>
 <visible type="boolean">true</visible>
 <size type="integer">50</size>
 <cols type="integer">43</cols>
 <rows type="integer">10</rows>
</field>

Obtiene un campo con nombre

Parámetros

rest_api_key

tu clave API

database_name

Debe conocer el nombre de la base de datos. Puede obtener el nombre ejecutando la consulta Obtenga todas las bases de datos ..

form_name

Necesita saber el nombre del módulo. Puede obtenerlo vinculando Obtenga todos los módulos

field_name

Necesita saber el nombre del campo. Puede obtenerlo vinculando Obtener todos los campos del formulario

estamos ejecutando una consulta (JSON)

formato

JSON

Método

GET

URL

/apps/search/entities/search/properties/search.json

contenido de la solicitud

{"rest_api_key":"API_KEY", "database_name": "Database 21", "form_name": "Form Name 1", "field_name": "Field Name 1"}

respuesta

    
{"field":  
{"id"               : "aOWO_dVXHdHie1WeGFE8k2",
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 }
}

estamos ejecutando una consulta (XML)

formato

XML

Método

GET

URL

/apps/search/entities/search/properties/search.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<database_name>Database 21</database_name>
<form_name>Form1</form_name>
<field_name>test</field_name>
</api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
<field>
  <id>clrSoltHDdQyozW5NcLrGd</id>
  <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
  <name>test</name>
  <desc nil="true"></desc>
  <type-name>string</type-name>
  <default></default>
  <validate-options></validate-options>
  <position type="integer">0</position>
  <visible type="boolean">true</visible>
  <size type="integer">50</size>
  <cols type="integer">43</cols>
  <rows type="integer">10</rows>
</field>

Ejecutar acción

Parámetros

rest_api_key

tu clave API

DTYPE_ID

Tienes que conocer tu identificador de registro. Puedes encontrar el ID usando la llamada Obtener todos los registros.

ACTION_PROPERTY_ID

Debe conocer el identificador de su campo. Puede encontrar el ID usando la llamada Obtener todos los campos de formulario.

estamos ejecutando una consulta (JSON)

formato

JSON

Método

GET

URL

/actions/ACTION_PROPERTY_ID.json

contenido de la solicitud

{"rest_api_key":"API_KEY", "dtype_id": "DTYPE_ID"}

respuesta

    
{\"success\":\"Done\"}

estamos ejecutando una consulta (XML)

formato

XML

Método

GET

URL

/actions/ACTION_PROPERTY_ID.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<dtype_id>DTYPE_ID</dtype_id>
</api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
  <success>Done</success>

Ejecutar acciones

Parámetros

rest_api_key

tu clave API

ACTION_PROPERTY_ID

Debe conocer el identificador de su campo. Puede encontrar el ID usando la llamada Obtener todos los campos de formulario.

dtype_ids

Tiene que conocer los identificadores de sus registros. Puede encontrar la identificación mediante la llamada Obtener todos los registros

json_dtype_ids

Debe conocer los identificadores de sus registros. Puede encontrar la identificación usando la llamada Obtener todos los registros.

run_by_all_table_or_report

El siguiente parámetro está disponible para ejecutar todas las acciones en la tabla o informe: run_by_all_table_or_report=true

view

para obtener los registros, debe conocer la ID del informe. (No necesariamente)

estamos ejecutando una consulta (JSON)

formato

JSON

Método

GET

URL

/actions/ACTION_PROPERTY_ID.json

contenido de la solicitud

{"rest_api_key":"API_KEY", "dtype_ids": ["ID1","ID2"...]}

{"rest_api_key":"API_KEY", "json_dtype_ids": "[\"ID1\",\"ID2\"...]"}

{"rest_api_key":"API_KEY", "run_by_all_table_or_report": true}

respuesta

    
{\"success\":\"Done\"}

estamos ejecutando una consulta (XML)

formato

XML

Método

GET

URL

/actions/ACTION_PROPERTY_ID.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<dtype_ids>"ID1","ID2"...</dtype_ids>
</api_call_params>

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<json_dtype_ids>"[\"ID1\",\"ID2\"...]"</json_dtype_ids>
</api_call_params>

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<run_by_all_table_or_report>true</run_by_all_table_or_report>
</api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
  <success>Done</success>

actualiza el campo

Parámetros

rest_api_key

tu clave API

APP_ID

ENTITY_ID

name

Nuevo nombre de campo. Todos los atributos disponibles están disponibles aquí

estamos ejecutando una consulta (JSON)

formato

JSON

Método

PUT

URL

/apps/APP_ID/entities/ENTITY_ID/properties/ID.json

contenido de la solicitud

{"rest_api_key":"API_KEY",
"name":"New field name"}

respuesta

    
{"field":  
{"id"              : "aOWO_dVXHdHie1WeGFE8k2",
"entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
"name"             : "Field Name 1",
"desc"             : "Field description",
"type_name"        : "string",
"default"          : "default value",
"validate_options" : "",
"position"         : 0,
"visible"          : true,
"size": 50,
"cols": 43,
"rows": 10
}
}

estamos ejecutando una consulta (XML)

formato

XML

Método

PUT

URL

/apps/APP_ID/entities/ENTITY_ID/properties/ID.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<name>New field name</rest_api_key>
</api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
<field>
  <id>clrSoltHDdQyozW5NcLrGd</id>
  <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
  <name>test</name>
  <desc nil="true"></desc>
  <type-name>string</type-name>
  <default></default>
  <validate-options></validate-options>
  <position type="integer">0</position>
  <visible type="boolean">true</visible>
  <size type="integer">50</size>
  <cols type="integer">43</cols>
  <rows type="integer">10</rows>
</field>

elimina el campo

Parámetros

rest_api_key

tu clave API

APP_ID

ENTITY_ID

estamos ejecutando una consulta (JSON)

formato

JSON

Método

DELETE

URL

/apps/APP_ID/entities/ENTITY_ID/properties/ID.json

contenido de la solicitud

{"rest_api_key":"API_KEY"}

respuesta

    
{"fields":[
{"id"               : "aOWO_dVXHdHie1WeGFE8k2",
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 },
{"id"               : "1i2i4VXHdHie1WeGFE8k2" ,
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 }
  ]}

estamos ejecutando una consulta (XML)

formato

XML

Método

DELETE

URL

/apps/APP_ID/entities/ENTITY_ID/properties/ID.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
<fields type="array">
<field>
  <id>clrSoltHDdQyozW5NcLrGd</id>
  <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
  <name>test</name>
  <desc nil="true"></desc>
  <type-name>string</type-name>
  <default></default>
  <validate-options></validate-options>
  <position type="integer">0</position>
  <visible type="boolean">true</visible>
  <size type="integer">50</size>
  <cols type="integer">43</cols>
  <rows type="integer">10</rows>
</field>
<field>
  <id>ddUHDhCgzeW6HkW4NdG3vE</id>
  <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
  <name>test2</name>
  <desc nil="true"></desc>
  <type-name>select</type-name>
  <default>1slct2slct3slct4slct5</default>
  <validate-options></validate-options>
  <position type="integer">1</position>
  <visible type="boolean">true</visible>
  <size type="integer">50</size>
  <cols type="integer">43</cols>
  <rows type="integer">10</rows>
</field>
</fields>

Crea un campo

Parámetros

rest_api_key

tu clave API

APP_ID

ENTITY_ID

name

Nombre del nuevo campo

type_name

estamos ejecutando una consulta (JSON)

formato

JSON

Método

POST

URL

/apps/APP_ID/entities/ENTITY_ID/properties.json

contenido de la solicitud

{"rest_api_key":"API_KEY", name: "Field name 1", type_name: "string"}

respuesta: devuelve información sobre formularios

    
{"field": 
{"id"               : "aOWO_dVXHdHie1WeGFE8k2",
 "entity_id"        : "aOWO3eVXHdHie1WeGFE8k2",
 "name"             : "Field Name 1",
 "desc"             : "Field description",
 "type_name"        : "string",
 "default"          : "default value",
 "validate_options" : "",
 "position"         : 0,
 "visible"          : true,
 "size": 50,
 "cols": 43,
 "rows": 10
 }
}

estamos ejecutando una consulta (XML)

formato

XML

Método

POST

URL

/apps/APP_ID/entities/ENTITY_ID/properties.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<name>Form field 1</name>
<type-name>string</type-name>
</api_call_params>

respuesta: devuelve información sobre formularios

    
<?xml version="1.0" encoding="UTF-8"?>
  <field>
    <id>clrSoltHDdQyozW5NcLrGd</id>
    <entity-id>dcOSk2W6bdJOoPsCo8jmoE</entity-id>
    <name>test</name>
    <desc nil="true"></desc>
    <type-name>string</type-name>
    <default></default>
    <validate-options></validate-options>
    <position type="integer">0</position>
    <visible type="boolean">true</visible>
    <size type="integer">50</size>
    <cols type="integer">43</cols>
    <rows type="integer">10</rows>
  </field>
</field>

Obtenga los totales en la columna

Parámetros

rest_api_key

tu clave API

ENTITY_ID

view

para obtener los registros, debe conocer la ID del informe. (No necesariamente)

estamos ejecutando una consulta (JSON)

formato

JSON

Método

GET

URL

/search/sum/ENTITY_ID/ID.json

contenido de la solicitud

{"rest_api_key":"API_KEY",
view: "ImWO3eVXHdHie1WeGFE8k2"}

respuesta

    
{total: 3}

estamos ejecutando una consulta (XML)

formato

XML

Método

GET

URL

/search/sum/ENTITY_ID/ID.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<view>ImWO3eVXHdHie1WeGFE8k2</view>
</api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
<total>
 3
</total>

Registro

Tales atributos de registro se pueden obtener de la API REST

el identificador único para el registro.

app_id

ID de la aplicación

entity_id

ID del formulario de registro

values

Hash escribe valores. Donde la clave es la ID de campo y el valor es el valor del campo

json_values

Valores de registro hash. Donde la clave es ID de campo y el valor es el valor de este campo. Análogo de values_hash pero en formato JSON

rel_values

Hash del valor de relación de registro. Donde la clave es ID de campo y el valor es la ID del registro asociado

obtener los registros

Parámetros

rest_api_key

tu clave API

APP_ID

ENTITY_ID

view

para obtener los registros, debe conocer la ID del informe. (No necesariamente)

page

Número de página con registros. 1 al número de registros/ per_page

name_value

Use el parámetro para obtener registros de la forma: "nombre de campo": "valor", "id de campo": "nombre de campo"

fetch_all

Para propietarios de cuentas pagas, el siguiente parámetro está disponible: fetch_all=true.
Para obtener un número específico de publicaciones, use el parámetro per_page.
Restricciones en el número máximo de entradas per_page para diferentes planes:
FREE - 200
STANDARD - 500
PROFESSIONAL - 1000
ENTERPRISE - 2000
STANDARD EXPRESS - 4000
PROFESSIONAL EXPRESS - 8000
ENTERPRISE EXPRESS - 15000

cuerpo de la solicitud
{"rest_api_key":"API_KEY", "page": 1, "name_value": 1, "view": 'EaWQZdIXfahOqWvcvwrGTP', "fetch_all": true, "per_page": 2000}

estamos ejecutando una consulta (JSON)

formato

JSON

Método

GET

URL

/apps/APP_ID/dtypes/entity/ENTITY_ID.json

contenido de la solicitud

{"rest_api_key":"API_KEY", "page": 1, "name_value": 1, "view": 'EaWQZdIXfahOqWvcvwrGTP'}

respuesta

    
{"records":[
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"value name 1":"2",
"aNW4nkW5bdUjldO8oKuSku":"value name 1",
"value name 2":"aaa",
"aMW4HKWR9bnOoGWQbpWQS4":"value name 2",
"value name 3":"ddd",
"cMW6pcTSjbWOFdTCkBtmkN":"value name 3"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
},
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"value name 1":"2",
"aNW4nkW5bdUjldO8oKuSku":"value name 1",
"value name 2":"aaa",
"aMW4HKWR9bnOoGWQbpWQS4":"value name 2",
"value name 3":"ddd",
"cMW6pcTSjbWOFdTCkBtmkN":"value name 3"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
]
}

estamos ejecutando una consulta (XML)

formato

XML

Método

GET

URL

/apps/APP_ID/dtypes/entity/ENTITY_ID.json

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
<view>EaWQZdIXfahOqWvcvwrGTP</view>
</api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
<records type="array">
<record>
<id>bYWQnuBajdBOkAW4BdMmki</id>
<app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
<entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
<values>
  <aNW4nkW5bdUjldO8oKuSku>2</aNW4nkW5bdUjldO8oKuSku>
  <aMW4HKWR9bnOoGWQbpWQS4>aaa</aMW4HKWR9bnOoGWQbpWQS4>
  <cMW6pcTSjbWOFdTCkBtmkN>ddd</cMW6pcTSjbWOFdTCkBtmkN>
</values>
<approved type="boolean">false</approved>
<created-at type="datetime">2011-09-17T10:40:40-05:00</created-at>
<updated-at type="datetime">2011-09-17T10:40:40-05:00</updated-at>
</record>
<record>
<id>dcQSkdWO1odA5HAmkYWOix</id>
<app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
<entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
<values>
  <aNW4nkW5bdUjldO8oKuSku>1</aNW4nkW5bdUjldO8oKuSku>
  <aMW4HKWR9bnOoGWQbpWQS4>test</aMW4HKWR9bnOoGWQbpWQS4>
  <cMW6pcTSjbWOFdTCkBtmkN>test2</cMW6pcTSjbWOFdTCkBtmkN>
</values>
<approved type="boolean">false</approved>
<created-at type="datetime">2011-09-17T04:28:10-05:00</created-at>
<updated-at type="datetime">2011-09-17T04:28:10-05:00</updated-at>
</record>
</records>

obtener un registro

Parámetros

rest_api_key

tu clave API

APP_ID

Debe conocer el ID del registro. El ID se puede encontrar después de recibir todos los registros . Cuando conoce el ID, debe reemplazar el ID en la URL, por ejemplo:/apps/APP_ID/dtypes/ID. json en /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

name_value

Use el parámetro para obtener registros de la forma: "nombre de campo": "valor", "id de campo": "nombre de campo"

estamos ejecutando una consulta (JSON)

formato

JSON

Método

GET

URL

/apps/APP_ID/dtypes/ID.json

contenido de la solicitud

{"rest_api_key":"API_KEY", "name_value": 1}

respuesta

    
{"record":
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"value name 1":"2",
"aNW4nkW5bdUjldO8oKuSku":"value name 1",
"value name 2":"aaa",
"aMW4HKWR9bnOoGWQbpWQS4":"value name 2",
"value name 3":"ddd",
"cMW6pcTSjbWOFdTCkBtmkN":"value name 3"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
}

estamos ejecutando una consulta (XML)

formato

XML

Método

GET

URL

/apps/APP_ID/dtypes/ID.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
<record>
<id>bYWQnuBajdBOkAW4BdMmki</id>
<app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
<entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
<values>
  <aNW4nkW5bdUjldO8oKuSku>2</aNW4nkW5bdUjldO8oKuSku>
  <aMW4HKWR9bnOoGWQbpWQS4>aaa</aMW4HKWR9bnOoGWQbpWQS4>
  <cMW6pcTSjbWOFdTCkBtmkN>ddd</cMW6pcTSjbWOFdTCkBtmkN>
</values>
<approved type="boolean">false</approved>
<created-at type="datetime">2011-09-17T10:40:40-05:00</created-at>
<updated-at type="datetime">2011-09-17T10:40:40-05:00</updated-at>
</record>

Actualiza el registro

Parámetros

rest_api_key

tu clave API

APP_ID

values

valores de registro de hash, donde la clave es la ID del campo de formulario

json_values

Si usa jQuery, Ruby u otro lenguaje de programación, ingrese los valores de los registros como un hash codificado en el parámetro 'valores'. Pero si su marco no le permite hacerlo, puede enviar los valores de los registros, JSON, por ejemplo: "{" aNW4nkW5bdUjldO8oKuSku ": " 2 ", " aMW4HKWR9bnOoGWQbpWQS4 ": " aaa "} ". Pero luego use el nombre del parámetro 'json_values'.

subforms_values / subforms_json_values

Para crear o actualizar subformularios de la misma manera, use 'subforms_values' o' Json_subforms_values'.
el siguiente formato:
"{property1_id: {entity_id: subform1_id, subform1_record1_id: {subform1_field1_id: "2 ", subform1_field2_id: "aaa "}, subform1_record2_id: {subform1_field1_id: "3 ", subform1_field2_id: "bb "}}, propiedad2_id: {entidad_id: subform2_id, subform2_record1_id: {subform2_field1_id: "4 ", subform2_field2_id: "bb "}, subform2_record2_id: {subform2_field1_id: "5 ", subform2_field2_id: "dd "}}} ".

Donde property1_id y property2_id es la ID de los campos de Subformulario en la tabla principal.
subform1_id, subform2_id: el ID del módulo al que apuntan los campos property1_id y property2_id.
subform1_record1_id y subform1_record2_id: este es el ID de los registros de subformulario nuevos o existentes.
subform1_field1_id, subform1_field2_id: ID de los campos en el formulario subform1_id.
subform2_field1_id, subform2_field2_id: ID de los campos en el formulario subform2_id.

Todas las ID son códigos base64 seguros con URL de 22 caracteres, puede tomarlas de otras API de conexión o crear las suyas propias para las nuevas ID de registro.

estamos ejecutando una consulta (JSON)

formato

JSON

Método

PUT

URL

/apps/APP_ID/dtypes/ID.json

contenido de la solicitud

{"rest_api_key":"API_KEY", "values": {"aNW4nkW5bdUjldO8oKuSku" : 3, "aMW4HKWR9bnOoGWQbpWQS4" : "b", "cMW6pcTSjbWOFdTCkBtmkN" : "c"}}

respuesta

    
{"record":
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"aNW4nkW5bdUjldO8oKuSku":"3",
"aMW4HKWR9bnOoGWQbpWQS4":"b",
"cMW6pcTSjbWOFdTCkBtmkN":"c"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
}

estamos ejecutando una consulta (XML)

formato

XML

Método

PUT

URL

/apps/APP_ID/dtypes/ID.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<values>{"aNW4nkW5bdUjldO8oKuSku"=>3, "aMW4HKWR9bnOoGWQbpWQS4"=>"b", "cMW6pcTSjbWOFdTCkBtmkN"=>"c"}</values> <rest_api_key>API_KEY</rest_api_key> </api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
<record>
<id>bYWQnuBajdBOkAW4BdMmki</id>
<app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
<entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
<values>
  <aNW4nkW5bdUjldO8oKuSku>3</aNW4nkW5bdUjldO8oKuSku>
  <aMW4HKWR9bnOoGWQbpWQS4>b</aMW4HKWR9bnOoGWQbpWQS4>
  <cMW6pcTSjbWOFdTCkBtmkN>c</cMW6pcTSjbWOFdTCkBtmkN>
</values>
<approved type="boolean">false</approved>
<created-at type="datetime">2011-09-17T10:40:40-05:00</created-at>
<updated-at type="datetime">2011-09-17T10:40:40-05:00</updated-at>
</record>

Actualiza varios registros

Parámetros

rest_api_key

tu clave API

confirm_action

Se requiere el siguiente parámetro para ejecutar la actualización en la tabla o informe: confirm_action: update

ENTITY_ID

Debe conocer el identificador de formulario de su campo para actualizar la configuración del campo. Puede encontrar ENTITY_ID utilizando la llamada Obtener todos los formularios.

APP_ID

Debe conocer el identificador de su base de datos para obtener la información de la base de datos. Puede encontrar la identificación mediante la llamada Obtener todas las bases de datos.

dtype_ids

Tiene que conocer los identificadores de sus registros. Puede encontrar la identificación mediante la llamada Obtener todos los registros

json_dtype_ids

Debe conocer los identificadores de sus registros. Puede encontrar la identificación usando la llamada Obtener todos los registros.

update_id

Debe conocer el identificador de su campo. Puede encontrar el ID usando la llamada Obtener todos los campos de formulario.

update_term

Nuevo valor para registros

view

para obtener los registros, debe conocer la ID del informe. (No necesariamente)

estamos ejecutando una consulta (JSON)

formato

JSON

Método

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

contenido de la solicitud

{rest_api_key: "YOUR_KEY",
confirm_action: "update",
entity_id: "ENTITY_ID",
app_id: "APP_ID",
json_dtype_ids: "[\"ID1\",\"ID2\"...]",
update_id: "UPDATE_ID",
update_term: "UPDATE_TERM"}

{rest_api_key: "YOUR_KEY",
confirm_action: "update",
entity_id: "ENTITY_ID",
app_id: "APP_ID",
dtype_ids: ["ID1","ID2"...],
update_id: "UPDATE_ID",
update_term: "UPDATE_TERM"}

respuesta

    
{\"success\":\"Done\"}

estamos ejecutando una consulta (XML)

formato

XML

Método

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

contenido de la solicitud


  <?xml version="1.0" encoding="UTF-8"?>
  <api_call_params>
    <rest_api_key>API_KEY</rest_api_key>
    <confirm_action>update</confirm_action>
    <entity_id>ENTITY_ID</entity_id>
    <app_id>APP_ID</app_id>
    <dtype_ids>"ID1","ID2"...</dtype_ids>
    <update_id>UPDATE_ID</update_id>
    <update_term>UPDATE_TERM</update_term>
  </api_call_params>


  <?xml version="1.0" encoding="UTF-8"?>
  <api_call_params>
    <rest_api_key>API_KEY</rest_api_key>
    <confirm_action>update</confirm_action>
    <entity_id>ENTITY_ID</entity_id>
    <app_id>APP_ID</app_id>
    <json_dtype_ids>"[\"ID1\",\"ID2\"...]"</json_dtype_ids>
    <update_id>UPDATE_ID</update_id>
    <update_term>UPDATE_TERM</update_term>
  </api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
  <success>Done</success>

Actualizar todos los registros

Parámetros

rest_api_key

tu clave API

confirm_action

Se requiere el siguiente parámetro para ejecutar la actualización de todos los registros en la tabla o informe: confirm_action: update_all

ENTITY_ID

Debe conocer el identificador de formulario de su campo para actualizar la configuración del campo. Puede encontrar ENTITY_ID utilizando la llamada Obtener todos los formularios.

APP_ID

Debe conocer el identificador de su base de datos para obtener la información de la base de datos. Puede encontrar la identificación mediante la llamada Obtener todas las bases de datos.

update_id

Debe conocer el identificador de su campo. Puede encontrar el ID usando la llamada Obtener todos los campos de formulario.

update_term

Nuevo valor para registros

view

para obtener los registros, debe conocer la ID del informe. (No necesariamente)

estamos ejecutando una consulta (JSON)

formato

JSON

Método

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

contenido de la solicitud

{rest_api_key: "YOUR_KEY",
confirm_action: "update_all",
entity_id: "ENTITY_ID",
app_id: "APP_ID",
update_id: "UPDATE_ID",
update_term: "UPDATE_TERM"}

respuesta

    
{\"success\":\"Done\"}

estamos ejecutando una consulta (XML)

formato

XML

Método

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

contenido de la solicitud


  <?xml version="1.0" encoding="UTF-8"?>
  <api_call_params>
    <rest_api_key>API_KEY</rest_api_key>
    <confirm_action>update_all</confirm_action>
    <entity_id>ENTITY_ID</entity_id>
    <app_id>APP_ID</app_id>
    <update_id>UPDATE_ID</update_id>
    <update_term>UPDATE_TERM</update_term>
  </api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
  <success>Done</success>

actualiza los datos de la celda

Parámetros

rest_api_key

tu clave API

PROPERTY_ID

DTYPE_ID

val

el nuevo valor de la celda de datos

estamos ejecutando una consulta (JSON)

formato

JSON

Método

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json

contenido de la solicitud

{"rest_api_key":"API_KEY", "property_id": "aNW4nkW5bdUjldO8oKuSku", "dtype_id": "cMW6pcTSjbWOFdTCkBtmkN", "val": "John Smith"}

respuesta

    
{"new_value": "John Smith"}

estamos ejecutando una consulta (XML)

formato

XML

Método

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<val>John Smith</val> <rest_api_key>API_KEY</rest_api_key> <dtype-id>cMW6pcTSjbWOFdTCkBtmkN</dtype-id> <property-id>aNW4nkW5bdUjldO8oKuSku</property-id> </api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
<new_value>
John Smith
</new_value>

eliminar el registro

Parámetros

rest_api_key

tu clave API

APP_ID

estamos ejecutando una consulta (JSON)

formato

JSON

Método

DELETE

URL

/apps/APP_ID/dtypes/ID.json

contenido de la solicitud

{"rest_api_key":"API_KEY"}

respuesta

    
{"record":
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"aNW4nkW5bdUjldO8oKuSku":"3",
"aMW4HKWR9bnOoGWQbpWQS4":"b",
"cMW6pcTSjbWOFdTCkBtmkN":"c"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
}

estamos ejecutando una consulta (XML)

formato

XML

Método

DELETE

URL

/apps/APP_ID/dtypes/ID.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
<record>
  <id>bYWQnuBajdBOkAW4BdMmki</id>
  <app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
  <entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
  <values>
    <aNW4nkW5bdUjldO8oKuSku>3</aNW4nkW5bdUjldO8oKuSku>
    <aMW4HKWR9bnOoGWQbpWQS4>b</aMW4HKWR9bnOoGWQbpWQS4>
    <cMW6pcTSjbWOFdTCkBtmkN>c</cMW6pcTSjbWOFdTCkBtmkN>
  </values>
  <approved type="boolean">false</approved>
  <created-at type="datetime">2011-09-17T10:40:40-05:00</created-at>
  <updated-at type="datetime">2011-09-17T10:40:40-05:00</updated-at>
</record>

Eliminar varios registros

Parámetros

rest_api_key

tu clave API

ENTITY_ID

Debe conocer el identificador de formulario de su campo para actualizar la configuración del campo. Puede encontrar ENTITY_ID utilizando la llamada Obtener todos los formularios.

APP_ID

Debe conocer el identificador de su base de datos para obtener la información de la base de datos. Puede encontrar la identificación mediante la llamada Obtener todas las bases de datos.

dtype_ids

Tiene que conocer los identificadores de sus registros. Puede encontrar la identificación mediante la llamada Obtener todos los registros

json_dtype_ids

Debe conocer los identificadores de sus registros. Puede encontrar la identificación usando la llamada Obtener todos los registros. (No necesariamente)

estamos ejecutando una consulta (JSON)

formato

JSON

Método

POST

URL

/apps/APP_ID/dtypes/delete_multiple.json

contenido de la solicitud

{rest_api_key: "YOUR_KEY",
entity_id: "ENTITY_ID",
app_id: "APP_ID",
json_dtype_ids: "[\"ID1\",\"ID2\"...]"}

{rest_api_key: "YOUR_KEY",
entity_id: "ENTITY_ID",
app_id: "APP_ID",
dtype_ids: ["ID1","ID2"...]}

respuesta

    
{\"success\":\"Done\"}

estamos ejecutando una consulta (XML)

formato

XML

Método

POST

URL

/apps/APP_ID/dtypes/delete_multiple.xml

contenido de la solicitud


  <?xml version="1.0" encoding="UTF-8"?>
  <api_call_params>
    <rest_api_key>API_KEY</rest_api_key>
    <entity_id>ENTITY_ID</entity_id>
    <app_id>APP_ID</app_id>
    <json_dtype_ids>"[\"ID1\",\"ID2\"...]"</json_dtype_ids>
  </api_call_params>


  <?xml version="1.0" encoding="UTF-8"?>
  <api_call_params>
    <rest_api_key>API_KEY</rest_api_key>
    <entity_id>ENTITY_ID</entity_id>
    <app_id>APP_ID</app_id>
    <dtype_ids>"ID1","ID2"...</dtype_ids>
  </api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
  <success>Done</success>

Eliminar todo

Parámetros

rest_api_key

tu clave API

APP_ID

Debe conocer el identificador de su base de datos para obtener la información de la base de datos. Puede encontrar la identificación mediante la llamada Obtener todas las bases de datos.

ENTITY_ID

Debe conocer el identificador de formulario de su campo para actualizar la configuración del campo. Puede encontrar ENTITY_ID utilizando la llamada Obtener todos los formularios.

view

para obtener los registros, debe conocer la ID del informe. (No necesariamente)

estamos ejecutando una consulta (JSON)

formato

JSON

Método

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.json

contenido de la solicitud

{rest_api_key: "YOUR_KEY", entity_id: "ENTITY_ID"}

respuesta

    
{\"success\":\"Done\"}

estamos ejecutando una consulta (XML)

formato

XML

Método

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.xml

contenido de la solicitud


  <?xml version="1.0" encoding="UTF-8"?>
  <api_call_params>
    <rest_api_key>API_KEY</rest_api_key>
    <entity_id>ENTITY_ID</entity_id>
  </api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
  <success>Done</success>

nuevo registro

Parámetros

rest_api_key

tu clave API

APP_ID

ENTITY_ID

Si necesita utilizar su ID personal, puede generar UUID (identificador único) Base64 segura para URL de 22 caracteres Por ejemplo en Ruby . A continuación, deberá pasarlo al hash de 'valores', por ejemplo: valores => {'id' => ID}, cambie a: values => {'id' => '22adadVXHdHie1WeGFE8k2'}, de lo contrario, el sistema generará un identificador único para usted

values / json_values

subforms_values / subforms_json_values

estamos ejecutando una consulta (JSON)

formato

JSON

Método

POST

URL

/apps/APP_ID/dtypes.json

contenido de la solicitud

{"rest_api_key":"API_KEY", "values": {"entity_id" : ENTITY_ID, "id" : ID, "aNW4nkW5bdUjldO8oKuSku":"3", "aMW4HKWR9bnOoGWQbpWQS4":"b","cMW6pcTSjbWOFdTCkBtmkN":"c"}}

respuesta: devuelve información sobre formularios

    
{"record":
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"aNW4nkW5bdUjldO8oKuSku":"3",
"aMW4HKWR9bnOoGWQbpWQS4":"b",
"cMW6pcTSjbWOFdTCkBtmkN":"c"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
}

estamos ejecutando una consulta (XML)

formato

XML

Método

POST

URL

/apps/APP_ID/dtypes.xml

contenido de la solicitud

<?xml version="1.0" encoding="UTF-8"?> <api_call_params>
<values>{"aNW4nkW5bdUjldO8oKuSku"=>3,"entity_id"=>ENTITY_ID, "id"=>ID,"aMW4HKWR9bnOoGWQbpWQS4"=>"b", "cMW6pcTSjbWOFdTCkBtmkN"=>"c"}</values>< <rest_api_key>API_KEY</rest_api_key> </api_call_params>

respuesta: devuelve información sobre formularios

    
<?xml version="1.0" encoding="UTF-8"?>
<record>
  <id>bYWQnuBajdBOkAW4BdMmki</id>
  <app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
  <entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
  <values>
    <aNW4nkW5bdUjldO8oKuSku>3</aNW4nkW5bdUjldO8oKuSku>
    <aMW4HKWR9bnOoGWQbpWQS4>b</aMW4HKWR9bnOoGWQbpWQS4>
    <cMW6pcTSjbWOFdTCkBtmkN>c</cMW6pcTSjbWOFdTCkBtmkN>
  </values>
  <approved type="boolean">false</approved>
  <created-at type="datetime">2011-09-17T10:40:40-05:00</created-at>
  <updated-at type="datetime">2011-09-17T10:40:40-05:00</updated-at>
</record>

Buscar

Parámetros

rest_api_key

tu clave API

APP_ID

ENTITY_ID

view

para obtener los registros, debe conocer la ID del informe. (No necesariamente)

search

¿Quieres una película sobre la mesa? "SEARCH_TERM", "o" => "SEARCH_CRITERIA"}]].
PROPERTY_ID - identificador de campo por el que estamos buscando ( -ALL - - para un empujón en todas las columnas),
SEARCH_TERM - es decir, lo que estamos buscando,
SEARCH_CRITERIA - criterio para un mensaje, tal vez uno de ellos:
is, is_not, is_empty, is_not_empty, starts_with, ends_with, like, contains, not_contains.

Para números y fechas regulares : less_than, greater_than, less_than_or_equal_to, greater_than_or_equal_to.

Para una cita de aproximadamente una hora : before, after, this_day_and_before, this_day_and_after, yesterday, today, tomorrow, today_or_later, last_7_days, last_30_days,
last_60_days, last_90_days, last_120_days, next_7_days, next_30_days, next_60_days, next_90_days, next_120_days, next_n_days, last_n_days,
last_week, this_week, next_week, current_and_prev_week, current_and_next_week, next_n_weeks, last_n_weeks, last_month, this_month, next_month,
current_and_prev_month, current_and_next_month, next_n_months, last_n_months, last_year, this_year, last_2_years, next_2_years, current_and_prev_year,
current_and_next_year, next_n_years, last_n_years.

System columns : added_by, created_at, updated_at, ip.

Si desea buscar en varias columnas con un criterio "Y" unificador, estos criterios deben colocarse en una matriz, si es "O", entonces en uno separado, por ejemplo:
[[{"a" => "PROPERTY_ID_1", "b" => "A", "o" => "is"}, {"a" => "PROPERTY_ID_2", "b" => "A", "o" => "is"}],
[{"a" => "PROPERTY_ID_3", "b" => "B", "o" => "SEARCH_CRITERIA"}]]

la fórmula de búsqueda será: "Find all records where PROPERTY_ID_1 AND PROPERTY_ID_2 are equal to A OR PROPERTY_ID_3 is equal to B"

limit

El número de registros en los resultados de la búsqueda, el máximo es 200.

estamos ejecutando una consulta (JSON)

formato

JSON

Método

POST

URL

/search/APP_ID.json

contenido de la solicitud

{"rest_api_key":"API_KEY", "entity_id" => "ENTITY_ID", "search": [[{"a"=>"aNW4nkW5bdUjldO8oKuSku", "b"=>"value name 1", "o"=>"is"}]]}

respuesta

    
{"records":[
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"value name 1":"2",
"aNW4nkW5bdUjldO8oKuSku":"value name 1",
"value name 2":"aaa",
"aMW4HKWR9bnOoGWQbpWQS4":"value name 2",
"value name 3":"ddd",
"cMW6pcTSjbWOFdTCkBtmkN":"value name 3"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
},
{
"id":"bYWQnuBajdBOkAW4BdMmki",
"app_id":"ddIbpcNSncW5xcHxpdHCoW",
"entity_id":"aEWQZdIXfahOqWvcvwrGTP",
"values":{"value name 1":"2",
"aNW4nkW5bdUjldO8oKuSku":"value name 1",
"value name 2":"aaa",
"aMW4HKWR9bnOoGWQbpWQS4":"value name 2",
"value name 3":"ddd",
"cMW6pcTSjbWOFdTCkBtmkN":"value name 3"},
"approved":false,
"created_at":"2011-09-17T10:40:40-05:00",
"updated_at":"2011-09-17T10:40:40-05:00"
}
]
}

Relación

Cómo vincular registros:

Para establecer una relación entre registros, debe enviar un hash separado en la consulta CREAR O ACTUALIZAR registro.

curl -H 'Content-Type: application/json' -X PUT -d ' {"rel ": {REL_ID: RECORD_ID}} '"https://quintadb.com/apps/APP_ID/dtypes/CURRENT_RECORD_ID.json? rest_api_key=API_KEY "

El hash debe tener la forma 'rel' => {rel_id => RECORD_ID} o 'rel' => {rel_id => [RECORD_ID, RECORD_ID2]} si tiene muchas relaciones -a-muchos. Donde RECORD_ID es la ID del registro donde desea combinar el registro actual. Aquí se explica cómo obtener rel_id

Parámetros

rest_api_key

tu clave API

PROPERTY_ID

ENTITY_ID

Necesita conocer la ID del módulo. Puede encontrar ENTITY_ID después de recibir todos los módulos . Conociendo la ID del módulo, deberá reemplazar ENTITY_ID en la URL, por ejemplo /apps/APP_ID/entities/ENTITY_ID/properties.json con/apps/qweWO_dVXHdHie1WeGFE8k2/entidades/aOWO_dVXHdHie1WeGFE8k2'proper

estamos ejecutando una consulta (JSON)

formato

JSON

Método

GET

URL

/entities/ENTITY_ID/get_rel_id/PROPERTY_ID.json?rest_api_key=API_KEY

contenido de la solicitud

{"rest_api_key":"API_KEY", {"entity_id" : ENTITY_ID, "property_id" : PROPERTY_ID}}

respuesta

Informes

Se puede acceder a estos atributos de informe a través de la API REST

name

Nombre

Obtener informes

Parámetros

rest_api_key

tu clave API

APP_ID

ID de la aplicación

ENTITY_ID

ID de tabla (formulario)

estamos ejecutando una consulta (JSON)

formato

JSON

Método

GET

URL

/apps/APP_ID/entities/ENTITY_ID/views/index.json

contenido de la solicitud

{"rest_api_key":"API_KEY"}

respuesta: devuelve todos los informes de la tabla.

    
{"reports":[
{"id"              : "aOWO_dVXHdHie1WeGFE8k2"
 "name"            : "Report Name 1",
 "created_at"      : "2011-08-16T05:42:40-05:00",
 "updated_at"      : "2011-08-16T05:42:40-05:00",
 "entity_id"    : 'aEWQZdIXfahOqWvcvwrGTP',
 "app_id"  : 'ddIbpcNSncW5xcHxpdHCoW'
 },
{"id"              : "aOWO3eVXHdHie1WeGFE8k2"
 "name"            : "Report Name 2",
 "created_at"      : "2011-04-29T01:26:22-05:00",
 "updated_at"      : "2011-08-16T00:47:56-05:00",
 "entity_id"       : 'RtWQZdIXfahOqWvcvwrGTP',
 "app_id"          : 'ddIbpcNSncW5xcHxpdHCoW'
} ]}

estamos ejecutando una consulta (XML)

formato

XML

Método

GET

URL

/apps/APP_ID/entities/ENTITY_ID/views/index.xml

contenido de la solicitud: devuelve todos los informes de la tabla.

<?xml version="1.0" encoding="UTF-8"?>
<api_call_params>
<rest_api_key>API_KEY</rest_api_key>
</api_call_params>

respuesta

    
<?xml version="1.0" encoding="UTF-8"?>
<reports type="array">
<report>
<id>bYWQnuBajdBOkAW4BdMmki</id>
<app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
<entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
<created-at type="datetime">2011-09-17T10:40:40-05:00</created-at>
<updated-at type="datetime">2011-09-17T10:40:40-05:00</updated-at>
</record>
<record>
<id>dcQSkdWO1odA5HAmkYWOix</id>
<app-id>ddIbpcNSncW5xcHxpdHCoW</app-id>
<entity-id>aEWQZdIXfahOqWvcvwrGTP</entity-id>
<created-at type="datetime">2011-09-17T04:28:10-05:00</created-at>
<updated-at type="datetime">2011-09-17T04:28:10-05:00</updated-at>
</report>
</reports>

Archivos

ver el enlace al archivo

para obtener un enlace al archivo, primero obtenga los valores de los campos de registro y descargue el archivo desde el enlace https://quintadb.com/images/data/PROPERTY_ID/RECORD_ID/FILE_NAME, donde FILE_NAME: el nombre del archivo descargado, obtenido en hashes de tipo PROPERTY_ID => VALUE, RECORD_ID - ID de registro, PROPERTY_ID - ID de campo

Descargue los archivos

Para cargar un archivo en un registro, debe realizar una solicitud POST al método de API upload_file con un encabezado de tipo de contenido multipart / form-data y solo después de eso debe crear o actualizar su registro. Entonces, el ID del registro debe generarse antes de las llamadas. Y también tendrá que generar el encabezado Multipart, por favor, siga el ejemplo de Ruby con la clase MultipartPost a continuación. En el ejemplo, también aprenderá a cargar el archivo en el subformulario.

Ejemplo en Ruby

  
    require 'open-uri'
    require 'openssl'

    require 'net/http'
    require 'json'
    require 'securerandom'

    #MultipartPost
    class MultipartPost
      BOUNDARY = "-----------RubyMultipartPost"
      EOL = "\r\n"

      def initialize uri, &block
        @params = Array.new
        @uri = URI.parse uri
        instance_eval &block if block
      end

      def params_part key, value
        @params << multipart_text(key, value)
      end

      def files_part key, filename, mime_type, content
        @params << multipart_file(key, filename, mime_type, content)
      end

      def request_body
        body = @params.map{|p| "--#{BOUNDARY}#{EOL}" << p}.join ""
        body << "#{EOL}--#{BOUNDARY}--#{EOL}"
      end

      def run
        https = Net::HTTP.new @uri.host, @uri.port
        https.use_ssl = true
        https.verify_mode = (OpenSSL::SSL::VERIFY_PEER)
        request = Net::HTTP::Post.new @uri.request_uri
        request.body = request_body
        request.set_content_type "multipart/form-data", {"boundary" => BOUNDARY}
        res = https.request request
        res.body
      end

      private
      def multipart_text key, value
        content = "Content-Disposition: form-data; name=\"#{key}\"" <<
          EOL <<
          EOL <<
          "#{value}" << EOL
      end

      def multipart_file key, filename, mime_type, content
        content = "Content-Disposition: form-data; name=\"#{key}\"; filename=\"#{filename}\"#{EOL}" <<
          "Content-Type: #{mime_type}\r\n" <<
          EOL <<
          "#{content}" << EOL
      end
    end #MultipartPost

    def call_quinta(url, format, method, params={})
      uri = URI.parse(url)

      req = case method
              when "get"
                Net::HTTP::Get.new(uri.path) 
              when "post" 
                Net::HTTP::Post.new(uri.path)
              when "put"
                Net::HTTP::Put.new(uri.path)
              when "delete"
                Net::HTTP::Delete.new(uri.path)
            end

      req.body = case format
                  when "json"
                    JSON.generate(params)
                  else
                    "no"
                end
      
      req["Content-Type"] = "application/#{format}"

      https = Net::HTTP.new(uri.host, uri.port)

      https.use_ssl = (uri.scheme == 'https')
      https.verify_mode = (OpenSSL::SSL::VERIFY_PEER)

      https.start do |htt| 
        htt.request(req)
      end
    end

    dtype_id = SecureRandom.urlsafe_base64

    app_id   = "bsx8kgWR9jWOBdUftcRXf9"
    entity_id = "arjadcLJzeWOi1WPddL8ol"
    property_id = "bwW68wWP1cSikQqSkhl04I"

    post_url = "https://localhost:3001/entities/#{app_id}/upload_file/#{property_id}.json?dtype_id=#{dtype_id}"

    # Path to your file
    file_path = "/home/igor/Pictures/Selection_001.png"
    file = File.open file_path
    # getting file's content type, i.e. 'image/png'
    file_content_type =  `file --b --mime-type '#{file_path}'`.strip


    multi_part = MultipartPost.new post_url do
      params_part "rest_api_key", rest_api_key
      files_part "dtype[#{property_id}]", "Selection_001.png",
        file_content_type, file.read
    end
    p multi_part.run

    # And below is the example of how to upload the file to Subform
    rest_api_key          = "API_KEY"
    subform_field_id      = "dcL8kXB8npd5pdRmk7BCoR"
    subform_file_field_id = "aVWR3cNtvdUikQn8o3yCo1"
    subform_form_id       = "cCcxjdWRXpWPTLWOjvWPfO"
    subform_dtype_id      = SecureRandom.urlsafe_base64

    file_path = "/home/igor/Pictures/Selection_002.png"
    file = File.open file_path
    # getting file's content type, i.e. 'image/png'
    file_content_type =  `file --b --mime-type '#{file_path}'`.strip

    post_url = "https://quintadb.com/entities/#{app_id}/upload_file/#{subform_file_field_id}.json?dtype_id=#{subform_dtype_id}"

    # upload file into subform record
    multi_part = MultipartPost.new post_url do
      params_part "rest_api_key", rest_api_key
      params_part "subform_field", subform_field_id
      params_part "property_id", subform_file_field_id
      params_part "subform_dtype_id", subform_dtype_id
      files_part "subforms[#{subform_field_id}][#{subform_dtype_id}][#{subform_file_field_id}]", "Selection_002.png",
        file_content_type, file.read
    end
    p multi_part.run

    text_field_on_a_form = "agW6rGWQHiWPvdWPL0oCoj"
    text_field_on_a_subform = "dcV8k6y8nhWP4JF0r6W5LI"
    params = { 
      :page => 1,
      :rest_api_key => rest_api_key,  
      values: {entity_id: entity_id, id: dtype_id, text_field_on_a_form =>  "Test"},
      subforms: {subform_field_id => {entity_id: subform_form_id, subform_dtype_id => { text_field_on_a_subform => "Test2"}}}
    }
    response = call_quinta "https://quintadb.com/apps/#{app_id}/dtypes.json", "json", "post", params

    puts response.body

Parámetros

rest_api_key

tu clave API

APP_ID

property_id

dtype_id

estamos ejecutando una consulta (JSON)

formato

JSON

Método

POST

URL

/entities/APP_ID/upload_file/PROPERTY_ID.json?dtype_id=DTYPE_ID

contenido de la solicitud

{"rest_api_key"=>API_KEY, "filedata"="your_file_here", "dtype_id"=>"fRLA83jrnAUOi5TEQLyuGw", "app_id"=>"bsx8kgWR9jWOBdUftcRXf9"}

respuesta

    Uploaded

Eliminar archivos

Parámetros

rest_api_key

tu clave API

APP_ID

property_id

DTYPE_ID

SINGLE_FILE_NAME

Nombre de archivo

estamos ejecutando una consulta (JSON)

formato

JSON

Método

GET

URL

/dtypes/delete_dtype_file/APP_ID/DTYPE_ID/PROPERTY_ID.json

contenido de la solicitud

{"rest_api_key"=>API_KEY, "single_file_name"=>"Selection_002.png", "app_id"=>"bsx8kgWR9jWOBdUftcRXf9", "dtype_id"=>"wlS5MeyMqQiCv16FdG3ztQ", "property_id"=>"bwW68wWP1cSikQqSkhl04I"}

respuesta

    File removed

Ejemplos

Ruby ~ Javascript (jQuery)

    	
require 'open-uri'
require 'openssl'

require 'net/http'
require 'json'

def call_mth(url, format, method, params={})
  uri = URI.parse(url)

	# Crear una llamada al método solicitado: GET/POST/PUT/DELETE
  req = case method
          when "get"
            Net::HTTP::Get.new(uri.path) 
          when "post" 
            Net::HTTP::Post.new(uri.path)
          when "put"
            Net::HTTP::Put.new(uri.path)
          when "delete"
            Net::HTTP::Delete.new(uri.path)
        end

   # Convierte parámetros a JSON/XML y establece el tipo de contenido como application/json o application/xml   Tenga en cuenta el formato del parámetro XML, donde el elemento principal es api_call_params  
  req.body = case format
              when "xml"
                "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
                  <api_call_params>
                    #{params.collect{|key, value| "<#{key}>#{value}"}.join("")}
                  </api_call_params>"
              when "json"
                JSON.generate(params)
              else
                "no"
            end
	# establece el tipo de contenido
  req["Content-Type"] = "application/#{format}"

  https = Net::HTTP.new(uri.host, uri.port)

  # se verifican todas las conexiones HTTPS y los certificados SSL

  https.use_ssl = (uri.scheme == 'https')
  https.verify_mode = (OpenSSL::SSL::VERIFY_PEER)
	# estamos ejecutando una consulta
  https.start do |htt| 
    htt.request(req)
  end
end


# recuerde configurar API_KEY
params = { 
  :page => 1,
  :rest_api_key => "API_KEY"
}

response = call_mth "https://quintadb.ru/apps.json", "json", "get", params
# la respuesta estará disponible response.body
puts response.body

Esta es la API REST básica y debe ser suficiente para crear cosas interesantes y útiles. Sin embargo, si desea algo más, por ejemplo, más métodos, etc. contáctenos en cualquier momento. ¡Siempre nos complace saber de usted!

API REST de QuintaDB

Información general sobre llamadas a API

Base de datos

Formulario

campo

Registro

Informes

Archivos

Utilizamos cookies para proporcionar la funcionalidad necesaria del sitio web. Al hacer clic en "Aceptar", acepta el uso de cookies en nuestro sitio web.