API REST QuintaDB

API REST QuintaDB Conçu pour évaluer le plein potentiel des données stockées dans votre base de données QuintaDB. En utilisant cette API, vous pouvez réaliser plus que ce que l`interface QuintaDB offre actuellement. En fait, nous vous donnons la possibilité de faire tout ce dont vous avez besoin avec vos données, par exemple, vous pouvez créer vos propres scripts, ordinateurs de bureau et applications mobiles pour différentes plates-formes, telles que iPhone/Android . et plus encore. Et QuintaDB restera un endroit où vous stockez, gérez et partagez vos données avec les autres.

Informations générales sur les appels API

Tous les appels doivent contenir une clé API REST, qui peut être trouvée en cliquant sur le bouton "Clés API" au début de la page.
La réponse du serveur peut être reçue au format JSON ou XML , en fonction de votre demande.
Ci-dessous, nous montrons des tableaux avec les réponses du serveur pour chaque demande. Les URL seront affichées sous la forme /apps.json , ce qui signifie que vous devez appeler la méthode avec le lien https://QuintaDB.ru /apps.json dans votre programme. Veuillez noter que tous les appels doivent utiliser le protocole https et que vous devez vérifier la validité du certificat SSL du serveur.

Database

Ces attributs de base de données peuvent être obtenus à l`aide de l`API REST.

identifiant de base de données unique

name

Nom

created_at

heure de création de la base de données

updated_at

heure à laquelle la base de données a été mise à jour

récupère toutes les bases de données

Paramètres

rest_api_key

Votre clé API

page

Les bases de données sont affichées à 20 par page, c'est-à-dire que la page peut être 1..5

nous faisons une demande (JSON)

Format

JSON

Méthode

GET

URL

/apps.json

Le corps de la demande

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

Réponse: retourne toutes les bases de données

    
{"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
} ]}

nous faisons une demande (XML)

Format

XML

Méthode

GET

URL

/apps.xml

Le corps de la demande

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

Réponse: retourne toutes les bases de données

    
<?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>

récupère la base de données par ID

Paramètres

rest_api_key

Votre clé API

APP_ID

Vous devez connaître l`ID de la base de données que vous souhaitez supprimer. Vous pouvez trouver l`ID en obtenant toutes les bases de données . Connaissant l`ID de la base de données, vous devez remplacer l`ID dans l`URL, par exemple:/apps /ID.json sur /apps/aOWO_dVXHdHie1WeGFE8k2.json

nous faisons une demande (JSON)

Format

JSON

Méthode

GET

URL

/apps/APP_ID.json

Le corps de la demande

{"rest_api_key":"API_KEY"}

Réponse: retourne des informations sur la base de données

    
{"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
 }
}

nous faisons une demande (XML)

Format

XML

Méthode

GET

URL

/apps/APP_ID.xml

Le corps de la demande

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

Réponse: retourne des informations sur la base de données

    
<?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>

récupère la base de données par nom

Paramètres

rest_api_key

Votre clé API

Nom

Vous devez connaître le nom de la base de données. Vous pouvez obtenir le nom en interrogeant Obtenir toutes les bases de données .

nous faisons une demande (JSON)

Format

JSON

Méthode

GET

URL

/apps/search.json

Le corps de la demande

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

Réponse: retourne des informations sur la base de données

    
{"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
 }
}

nous faisons une demande (XML)

Format

XML

Méthode

GET

URL

/apps/search.xml

Le corps de la demande

<?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>

Réponse: retourne des informations sur la base de données

    
<?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>

Mettre à jour la base de données

Paramètres

rest_api_key

Votre clé API

APP_ID

name

nouveau nom de base de données

nous faisons une demande (JSON)

Format

JSON

Méthode

PUT

URL

/apps/APP_ID.json

Le corps de la demande

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

Réponse: retourne des informations sur la base de données

    
{"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
 }
}

nous faisons une demande (XML)

Format

XML

Méthode

PUT

URL

/apps/APP_ID.xml

Le corps de la demande

<?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>

Réponse: retourne des informations sur la base de données

    
<?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>

Supprimer la base de données

Paramètres

rest_api_key

Votre clé API

APP_ID

nous faisons une demande (JSON)

Format

JSON

Méthode

DELETE

URL

/apps/APP_ID.json

Le corps de la demande

{"rest_api_key":"API_KEY"}

Réponse

    
{"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
} ]}

nous faisons une demande (XML)

Format

XML

Méthode

DELETE

URL

/apps/APP_ID.xml

Le corps de la demande

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

Réponse

    
<?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>

Après avoir supprimé la base de données, cette méthode renvoie toutes les bases de données restantes.

Créer un app

Paramètres

rest_api_key

Votre clé API

database_name

nom de la base de données

form_name

nom du formulaire. Vous ne pouvez pas créer une base de données sans forme car il n`y a aucun intérêt dans une base de données sans forme.

nous faisons une demande (JSON)

Format

JSON

Méthode

POST

URL

/apps.json

Le corps de la demande

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

Réponse: retourne des informations sur la base de données

    
{"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
    }
}

nous faisons une demande (XML)

Format

XML

Méthode

POST

URL

/apps.xml

Le corps de la demande

<?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>

Réponse: retourne des informations sur la base de données

    
  <?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 cas d'erreur. Vous obtiendrez un message d'erreur, c'est-à-dire 'Un tel nom d'application existe déjà'.

Form

Ces formulaires de formulaire peuvent être obtenus via l`API REST.

identifiant de formulaire unique

name

Nom

desc

Description

post_action

liste des destinataires des e-mails

récupère tous les formulaires

Paramètres

rest_api_key

Votre clé API

APP_ID

nous faisons une demande (JSON)

Format

JSON

Méthode

GET

URL

/apps/APP_ID/entities.json

Le corps de la demande

{rest_api_key":"API_KEY"}

Réponse: récupère tous les formulaires de base de données

    
{"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
      } ]}

nous faisons une demande (XML)

Format

XML

Méthode

GET

URL

/apps/APP_ID/entities.xml

Le corps de la demande

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

Réponse: récupère tous les formulaires de base de données

    
<?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>

récupère le formulaire d`identification

Paramètres

rest_api_key

Votre clé API

APP_ID

Vous devez connaître l`ID du formulaire. Vous pouvez trouver l`ENTITY_ID en récupérant tous les formulaires . Connaissant l`ID du formulaire, vous devez remplacer l`ENTITY_ID dans l`URL, par exemple:/apps/APP_ID/entity. json sur /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

nous faisons une demande (JSON)

Format

JSON

Méthode

GET

URL

/apps/APP_ID/entities/ID.json

Le corps de la demande

{"rest_api_key":"API_KEY"}

Réponse: retourne des informations sur le formulaire

    
{"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
      }
}

nous faisons une demande (XML)

Format

XML

Méthode

GET

URL

/apps/APP_ID/entities/ID.xml

Le corps de la demande

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

Réponse: retourne des informations sur le formulaire

    
<?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>

récupère le formulaire par nom

Paramètres

rest_api_key

Votre clé API

database_name

Vous devez connaître le nom de la base de données. Vous pouvez obtenir le nom en interrogeant Obtenir toutes les bases de données .

form_name

Vous devez connaître le nom du formulaire. Vous pouvez l`obtenir en appelant Obtenir tous les formulaires .

nous faisons une demande (JSON)

Format

JSON

Méthode

GET

URL

/apps/search/entities/search.json

Le corps de la demande

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

Réponse: retourne des informations sur le formulaire

    
{"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
      }
}

nous faisons une demande (XML)

Format

XML

Méthode

GET

URL

/apps/search/entities/search.xml

Le corps de la demande

<?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>

Réponse: retourne des informations sur le formulaire

    
<?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>

Met à jour le formulaire

Paramètres

rest_api_key

Votre clé API

APP_ID

name

Nouveau nom de formulaire. Voir toutes les options disponibles ici

nous faisons une demande (JSON)

Format

JSON

Méthode

PUT

URL

/apps/APP_ID/entities/ID.json

Le corps de la demande

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

Réponse: retourne des informations sur le formulaire

    
{"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
     }
}

nous faisons une demande (XML)

Format

XML

Méthode

PUT

URL

/apps/APP_ID/entities/ID.xml

Le corps de la demande

<?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>

Réponse: retourne des informations sur le formulaire

    
<?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>

supprimer le formulaire

Paramètres

rest_api_key

Votre clé API

APP_ID

Vous devez connaître l`ID du formulaire que vous souhaitez supprimer. Vous pouvez trouver l`ID en récupérant tous les formulaires . Connaissant l`ID du formulaire, vous devez remplacer l`ID dans l`URL, par exemple:/apps/APP_ID/entités/ID.json sur /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2.json

nous faisons une demande (JSON)

Format

JSON

Méthode

DELETE

URL

/apps/APP_ID/entities/ID.json

Le corps de la demande

{"rest_api_key":"API_KEY"}

Réponse

    
{"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
      } ]}

nous faisons une demande (XML)

Format

XML

Méthode

DELETE

URL

/apps/APP_ID/entities/ID.xml

Le corps de la demande

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

Réponse

    
<?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>

Crée un formulaire

Paramètres

rest_api_key

Votre clé API

APP_ID

name

Form name

nous faisons une demande (JSON)

Format

JSON

Méthode

POST

URL

/apps/APP_ID/entities.json

Le corps de la demande

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

Réponse: retourne des informations sur le formulaire

    
{"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
      }
}

nous faisons une demande (XML)

Format

XML

Méthode

POST

URL

/apps/APP_ID/entities.xml

Le corps de la demande

<?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>

Réponse: retourne des informations sur le formulaire

    
<?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>

Champ

Ces attributs de champ peuvent être obtenus via l`API REST.

identifiant de champ unique

entity_id

identificateur de formulaire de champ

name

Nom

type_name

type de champ. Peut être: 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

récupère les champs du formulaire

Paramètres

rest_api_key

Votre clé API

APP_ID

ENTITY_ID

nous faisons une demande (JSON)

Format

JSON

Méthode

GET

URL

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

Le corps de la demande

{rest_api_key":"API_KEY"}

Réponse: récupère tous les champs du formulaire

    
{"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
 }
  ]}

nous faisons une demande (XML)

Format

XML

Méthode

GET

URL

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

Le corps de la demande

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

Réponse: récupère tous les champs du formulaire

    
<?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>

Obtenir le champ

Paramètres

rest_api_key

Votre clé API

APP_ID

ENTITY_ID

Vous devez connaître l`ID du champ. Vous pouvez trouver l`ID en récupérant tous les champs du formulaire . Connaissant l`ID du champ, vous devez remplacer l`ID dans l`URL, par exemple:/apps/APP_ID/entity /ENTITY_ID/properties/ID.json sur /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

nous faisons une demande (JSON)

Format

JSON

Méthode

GET

URL

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

Le corps de la demande

{"rest_api_key":"API_KEY"}

Réponse

    
{"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
}
}

nous faisons une demande (XML)

Format

XML

Méthode

GET

URL

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

Le corps de la demande

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

Réponse

    
<?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>

récupère un champ par nom

Paramètres

rest_api_key

Votre clé API

database_name

Vous devez connaître le nom de la base de données. Vous pouvez obtenir le nom en interrogeant Obtenir toutes les bases de données .

form_name

Vous devez connaître le nom du formulaire. Vous pouvez l`obtenir en appelant Obtenir tous les formulaires .

field_name

Vous devez connaître le nom du champ. Vous pouvez l`obtenir en appelant Récupérer tous les champs du formulaire .

nous faisons une demande (JSON)

Format

JSON

Méthode

GET

URL

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

Le corps de la demande

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

Réponse

    
{"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
 }
}

nous faisons une demande (XML)

Format

XML

Méthode

GET

URL

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

Le corps de la demande

<?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>

Réponse

    
<?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>

Exécuter l'action

Paramètres

rest_api_key

Votre clé API

DTYPE_ID

Vous devez connaître l'identifiant de votre enregistrement. Vous pouvez trouver l'identifiant en utilisant l'appel Fetch All Records.

ACTION_PROPERTY_ID

Vous devez connaître l'identifiant de votre champ. Vous pouvez trouver l'identifiant en utilisant l'appel Fetch All Form Fields.

nous faisons une demande (JSON)

Format

JSON

Méthode

GET

URL

/actions/ACTION_PROPERTY_ID.json

Le corps de la demande

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

Réponse

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

nous faisons une demande (XML)

Format

XML

Méthode

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Le corps de la demande

<?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>

Réponse

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

Exécuter des actions

Paramètres

rest_api_key

Votre clé API

ACTION_PROPERTY_ID

Vous devez connaître l'identifiant de votre champ. Vous pouvez trouver l'identifiant en utilisant l'appel Fetch All Form Fields.

dtype_ids

Vous devez connaître les identifiants de vos enregistrements. Vous pouvez trouver l'ID en utilisant l'appel Fetch All Records.

json_dtype_ids

Vous devez connaître les identifiants de vos enregistrements. Vous pouvez trouver l'ID en utilisant l'appel Fetch All Records.

run_by_all_table_or_report

Le paramètre suivant est disponible pour exécuter toutes les actions dans le tableau ou le rapport : run_by_all_table_or_report=true.

view

Pour obtenir des enregistrements, vous devez connaître l`ID du rapport. (facultatif)

nous faisons une demande (JSON)

Format

JSON

Méthode

GET

URL

/actions/ACTION_PROPERTY_ID.json

Le corps de la demande

{"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}

Réponse

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

nous faisons une demande (XML)

Format

XML

Méthode

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Le corps de la demande

<?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>

Réponse

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

Champ de mise à jour

Paramètres

rest_api_key

Votre clé API

APP_ID

ENTITY_ID

name

Nouveau nom de champ. Tous les attributs disponibles peuvent être trouvés ici

nous faisons une demande (JSON)

Format

JSON

Méthode

PUT

URL

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

Le corps de la demande

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

Réponse

    
{"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
}
}

nous faisons une demande (XML)

Format

XML

Méthode

PUT

URL

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

Le corps de la demande

<?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>

Réponse

    
<?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>

supprime le champ

Paramètres

rest_api_key

Votre clé API

APP_ID

ENTITY_ID

nous faisons une demande (JSON)

Format

JSON

Méthode

DELETE

URL

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

Le corps de la demande

{"rest_api_key":"API_KEY"}

Réponse

    
{"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
 }
  ]}

nous faisons une demande (XML)

Format

XML

Méthode

DELETE

URL

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

Le corps de la demande

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

Réponse

    
<?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>

Crée un champ

Paramètres

rest_api_key

Votre clé API

APP_ID

ENTITY_ID

name

Nom du champ

type_name

nous faisons une demande (JSON)

Format

JSON

Méthode

POST

URL

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

Le corps de la demande

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

Réponse: retourne des informations sur le formulaire

    
{"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
 }
}

nous faisons une demande (XML)

Format

XML

Méthode

POST

URL

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

Le corps de la demande

<?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>

Réponse: retourne des informations sur le formulaire

    
<?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>

récupère le montant par colonne

Paramètres

rest_api_key

Votre clé API

ENTITY_ID

view

Pour obtenir des enregistrements, vous devez connaître l`ID du rapport. (facultatif)

nous faisons une demande (JSON)

Format

JSON

Méthode

GET

URL

/search/sum/ENTITY_ID/ID.json

Le corps de la demande

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

Réponse

    
{total: 3}

nous faisons une demande (XML)

Format

XML

Méthode

GET

URL

/search/sum/ENTITY_ID/ID.xml

Le corps de la demande

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

Réponse

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

Dossier

Ces enregistrements d`attribut peuvent être obtenus via l`API REST.

identifiant d`enregistrement unique.

app_id

ID du app

entity_id

ID de formulaire d`enregistrement.

values

Valeurs d`enregistrement de hachage. Où la clé correspond à l ' ID de champ et la valeur à la valeur du champ.

json_values

Enregistrement des valeurs de hachage. Où la clé est l'ID de champ et la valeur est la valeur de ce champ. Analogue de values_hash mais au format JSON

rel_values

Hachage des valeurs des liens d`enregistrement. Où la clé est l`ID champ et la valeur est l`ID de l`enregistrement associé.

récupère les enregistrements

Paramètres

rest_api_key

Votre clé API

APP_ID

ENTITY_ID

view

Pour obtenir des enregistrements, vous devez connaître l`ID du rapport. (facultatif)

page

Numéro de page d`enregistrement. De 1 au nombre d`enregistrements/ par_page .

name_value

Utilisez le paramètre pour obtenir des enregistrements de la forme: "field name": "value", "field id": "field name"

fetch_all

Pour les propriétaires de comptes payants, le paramètre suivant est disponible : fetch_all=true.
Pour obtenir un nombre spécifique de publications, utilisez le paramètre per_page.
Restrictions sur le nombre maximum d'entrées par_page pour différents forfaits :
FREE - 200
STANDARD - 500
PROFESSIONAL - 1000
ENTERPRISE - 2000
STANDARD EXPRESS - 4000
PROFESSIONAL EXPRESS - 8000
ENTERPRISE EXPRESS - 15000

Corps de la requête
{"rest_api_key":"API_KEY", "page": 1, "name_value": 1, "view": 'EaWQZdIXfahOqWvcvwrGTP', "fetch_all": true, "per_page": 2000}

nous faisons une demande (JSON)

Format

JSON

Méthode

GET

URL

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

Le corps de la demande

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

Réponse

    
{"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"
}
]
}

nous faisons une demande (XML)

Format

XML

Méthode

GET

URL

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

Le corps de la demande

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

Réponse

    
<?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>

Récupère un enregistrement

Paramètres

rest_api_key

Votre clé API

APP_ID

Vous devez connaître l`ID d`enregistrement. l`ID peut être trouvé après avoir obtenu tous les enregistrements . Connaissant l`ID, vous devez remplacer l`ID dans l`URL par exemple: /apps/APP_ID/dtypes/ID.json à /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

name_value

Utilisez le paramètre pour obtenir des enregistrements de la forme: "field name": "value", "field id": "field name"

nous faisons une demande (JSON)

Format

JSON

Méthode

GET

URL

/apps/APP_ID/dtypes/ID.json

Le corps de la demande

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

Réponse

    
{"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"
}
}

nous faisons une demande (XML)

Format

XML

Méthode

GET

URL

/apps/APP_ID/dtypes/ID.xml

Le corps de la demande

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

Réponse

    
<?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>

Met à jour l`enregistrement

Paramètres

rest_api_key

Votre clé API

APP_ID

values

hachage de valeurs d`enregistrement dont la clé est l`identifiant du champ de formulaire

json_values

If you using jQuery, Ruby or another programming language then, please, use 'values' parameter to send encoding parameters. However, if your framework doesn't allow this you can send record values as JSON string, but in this case specify your parameter name as 'json_values'. And your JSON values string will looks like this: "{"aNW4nkW5bdUjldO8oKuSku":"2", "aMW4HKWR9bnOoGWQbpWQS4":"aaa"}"

subforms_values / subforms_json_values

To create or update subforms, in the same way, use 'subforms_values' or 'json_subforms_values'.
With a format below:
"{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"}}, property2_id: {entity_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"}}}" .

Where property1_id and property2_id - this is Fields ID's with a Subform type in the main table.
subform1_id, subform2_id - Forms ID's, which was set in property1_id and property2_id settings.
subform1_record1_id и subform1_record2_id - this is new or existent subform records ID's.
subform1_field1_id, subform1_field2_id - fields ID's in the form subform1_id.
subform2_field1_id, subform2_field2_id - fields ID's in the form subform2_id.

All ID's - it's a 22 characters URL-save base64 code, you can get them from other API calls or create for new subform records.

nous faisons une demande (JSON)

Format

JSON

Méthode

PUT

URL

/apps/APP_ID/dtypes/ID.json

Le corps de la demande

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

Réponse

    
{"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"
}
}

nous faisons une demande (XML)

Format

XML

Méthode

PUT

URL

/apps/APP_ID/dtypes/ID.xml

Le corps de la demande

<?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>

Réponse

    
<?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>

Met à jour plusieurs entrées

Paramètres

rest_api_key

Votre clé API

confirm_action

Le paramètre suivant est requis pour exécuter la mise à jour dans le tableau ou le rapport : confirm_action: update.

ENTITY_ID

Vous devez connaître l'identifiant de formulaire de votre champ afin de mettre à jour les paramètres du champ. Vous pouvez trouver ENTITY_ID en utilisant l'appel Fetch All Forms.

APP_ID

Vous devez connaître l'identifiant de votre base de données pour récupérer les informations de la base de données. Vous pouvez trouver l'identifiant en utilisant l'appel Fetch All Databases.

dtype_ids

Vous devez connaître les identifiants de vos enregistrements. Vous pouvez trouver l'ID en utilisant l'appel Fetch All Records.

json_dtype_ids

Vous devez connaître les identifiants de vos enregistrements. Vous pouvez trouver l'ID en utilisant l'appel Fetch All Records.

update_id

Vous devez connaître l'identifiant de votre champ. Vous pouvez trouver l'identifiant en utilisant l'appel Fetch All Form Fields.

update_term

Nouvelle valeur pour les enregistrements

view

Pour obtenir des enregistrements, vous devez connaître l`ID du rapport. (facultatif)

nous faisons une demande (JSON)

Format

JSON

Méthode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Le corps de la demande

{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"}

Réponse

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

nous faisons une demande (XML)

Format

XML

Méthode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Le corps de la demande


  <?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>

Réponse

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

Mettre à jour tous les enregistrements

Paramètres

rest_api_key

Votre clé API

confirm_action

Le paramètre suivant est requis pour exécuter la mise à jour de tous les enregistrements de la table ou du rapport : confirm_action: update_all.

ENTITY_ID

Vous devez connaître l'identifiant de formulaire de votre champ afin de mettre à jour les paramètres du champ. Vous pouvez trouver ENTITY_ID en utilisant l'appel Fetch All Forms.

APP_ID

Vous devez connaître l'identifiant de votre base de données pour récupérer les informations de la base de données. Vous pouvez trouver l'identifiant en utilisant l'appel Fetch All Databases.

update_id

Vous devez connaître l'identifiant de votre champ. Vous pouvez trouver l'identifiant en utilisant l'appel Fetch All Form Fields.

update_term

Nouvelle valeur pour les enregistrements

view

Pour obtenir des enregistrements, vous devez connaître l`ID du rapport. (facultatif)

nous faisons une demande (JSON)

Format

JSON

Méthode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Le corps de la demande

{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"}

Réponse

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

nous faisons une demande (XML)

Format

XML

Méthode

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Le corps de la demande


  <?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>

Réponse

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

Met à jour la cellule de données

Paramètres

rest_api_key

Votre clé API

PROPERTY_ID

DTYPE_ID

val

la nouvelle valeur de la cellule de données

nous faisons une demande (JSON)

Format

JSON

Méthode

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json

Le corps de la demande

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

Réponse

    
{"new_value": "John Smith"}

nous faisons une demande (XML)

Format

XML

Méthode

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml

Le corps de la demande

<?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>

Réponse

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

supprime l`enregistrement

Paramètres

rest_api_key

Votre clé API

APP_ID

nous faisons une demande (JSON)

Format

JSON

Méthode

DELETE

URL

/apps/APP_ID/dtypes/ID.json

Le corps de la demande

{"rest_api_key":"API_KEY"}

Réponse

    
{"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"
}
}

nous faisons une demande (XML)

Format

XML

Méthode

DELETE

URL

/apps/APP_ID/dtypes/ID.xml

Le corps de la demande

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

Réponse

    
<?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>

Supprimer plusieurs entrées

Paramètres

rest_api_key

Votre clé API

ENTITY_ID

Vous devez connaître l'identifiant de formulaire de votre champ afin de mettre à jour les paramètres du champ. Vous pouvez trouver ENTITY_ID en utilisant l'appel Fetch All Forms.

APP_ID

Vous devez connaître l'identifiant de votre base de données pour récupérer les informations de la base de données. Vous pouvez trouver l'identifiant en utilisant l'appel Fetch All Databases.

dtype_ids

Vous devez connaître les identifiants de vos enregistrements. Vous pouvez trouver l'ID en utilisant l'appel Fetch All Records.

json_dtype_ids

Vous devez connaître les identifiants de vos enregistrements. Vous pouvez trouver l'ID en utilisant l'appel Fetch All Records. (facultatif)

nous faisons une demande (JSON)

Format

JSON

Méthode

POST

URL

/apps/APP_ID/dtypes/delete_multiple.json

Le corps de la demande

{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"...]}

Réponse

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

nous faisons une demande (XML)

Format

XML

Méthode

POST

URL

/apps/APP_ID/dtypes/delete_multiple.xml

Le corps de la demande


  <?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>

Réponse

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

Supprimer tout

Paramètres

rest_api_key

Votre clé API

APP_ID

Vous devez connaître l'identifiant de votre base de données pour récupérer les informations de la base de données. Vous pouvez trouver l'identifiant en utilisant l'appel Fetch All Databases.

ENTITY_ID

Vous devez connaître l'identifiant de formulaire de votre champ afin de mettre à jour les paramètres du champ. Vous pouvez trouver ENTITY_ID en utilisant l'appel Fetch All Forms.

view

Pour obtenir des enregistrements, vous devez connaître l`ID du rapport. (facultatif)

nous faisons une demande (JSON)

Format

JSON

Méthode

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.json

Le corps de la demande

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

Réponse

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

nous faisons une demande (XML)

Format

XML

Méthode

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.xml

Le corps de la demande


  <?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>

Réponse

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

Crée une entrée

Paramètres

rest_api_key

Votre clé API

APP_ID

ENTITY_ID

Si vous devez utiliser votre identifiant personnel, vous pouvez générer un UUID (identifiant unique) 22 caractères base64 sécurisée pour les URL Par exemple dans Ruby . Ensuite, vous devrez le transmettre au hachage 'values', par exemple: values => {'id' => ID}, changez en: values => {'id' => '22adadVXHdHie1WeGFE8k2'}, sinon le système générera un identifiant unique pour vous.

values / json_values

subforms_values / subforms_json_values

nous faisons une demande (JSON)

Format

JSON

Méthode

POST

URL

/apps/APP_ID/dtypes.json

Le corps de la demande

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

Réponse: retourne des informations sur le formulaire

    
{"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"
}
}

nous faisons une demande (XML)

Format

XML

Méthode

POST

URL

/apps/APP_ID/dtypes.xml

Le corps de la demande

<?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>

Réponse: retourne des informations sur le formulaire

    
<?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>

Chercher

Paramètres

rest_api_key

Votre clé API

APP_ID

ENTITY_ID

view

Pour obtenir des enregistrements, vous devez connaître l`ID du rapport. (facultatif)

search

Voulez-vous un film sur la table? "SEARCH_TERM", "o" => "SEARCH_CRITERIA"}]].
PROPERTY_ID - identifiant de champ par lequel nous recherchons ( -ALL - - pour un poke sur toutes les colonnes),
SEARCH_TERM - signifiant, yake shukaєmo,
SEARCH_CRITERIA - critère pour un message, peut-être l`un d`entre eux:
is, is_not, is_empty, is_not_empty, starts_with, ends_with, like, contains, not_contains.

Pour les numéros et dates réguliers : less_than, greater_than, less_than_or_equal_to, greater_than_or_equal_to.

Pour un rendez-vous d`environ une heure : 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.

Colonnes système : added_by, created_at, updated_at, ip.

Si vous souhaitez effectuer une recherche dans plusieurs colonnes avec un critère "ET" unificateur, alors ces critères doivent être placés dans un tableau, si "OU", puis dans un autre, par exemple:
[[{"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 formule de recherche sera: "Find all records where PROPERTY_ID_1 AND PROPERTY_ID_2 are equal to A OR PROPERTY_ID_3 is equal to B"

limit

Le nombre d'enregistrements dans les résultats de la recherche, le maximum est de 200.

nous faisons une demande (JSON)

Format

JSON

Méthode

POST

URL

/search/APP_ID.json

Le corps de la demande

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

Réponse

    
{"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"
}
]
}

Relations

Comment lier des enregistrements:

Afin d`établir un lien entre les enregistrements, vous devez envoyer un hachage distinct dans la demande pour CRÉER ou RENOUVELER l`enregistrement.

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 "

Le hachage doit être sous la forme 'rel` => {rel_id => RECORD_ID} ou 'rel` => {rel_id => [RECORD_ID, RECORD_ID2]} si vous avez une relation plusieurs-à-plusieurs. Où RECORD_ID est un identifiant l`enregistrement avec lequel vous souhaitez fusionner l`enregistrement en cours. Ce qui suit montre comment obtenir rel_id.

Paramètres

rest_api_key

Votre clé API

PROPERTY_ID

ENTITY_ID

Vous devez connaître l`ID du formulaire. Vous pouvez trouver ENTITY_ID obtenir tous les formulaires . Connaissant l`ID de formulaire dont vous avez besoin pour remplacer ENTITY_ID dans l`URL, par exemple /apps/APP_ID/entities/ENTITY_ID/properties.json par/apps/qweWO_dVXHdHie1WeGFE8k2/entity/aOWO_dVXHdHie1WeGFE8k2/proties.

nous faisons une demande (JSON)

Format

JSON

Méthode

GET

URL

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

Le corps de la demande

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

Réponse

Rapports

Ces attributs de rapport peuvent être accessibles via l'API REST.

name

Nom

obtenir des rapports

Paramètres

rest_api_key

Votre clé API

APP_ID

ID du app

ENTITY_ID

ID de la table (formulaire)

nous faisons une demande (JSON)

Format

JSON

Méthode

GET

URL

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

Le corps de la demande

{"rest_api_key":"API_KEY"}

Réponse: retourne tous les rapports de table.

    
{"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'
} ]}

nous faisons une demande (XML)

Format

XML

Méthode

GET

URL

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

Le corps de la demande: retourne tous les rapports de table.

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

Réponse

    
<?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>

Fichiers

Obtenir un lien vers le fichier

Pour obtenir un lien vers le fichier, obtenez d`abord les valeurs des champs d`enregistrement et pouvez télécharger le fichier en suivant le lien sous la forme https://quintadb.com/images/data/PROPERTY_ID/RECORD_ID/FILE_NAME, où FILE_NAME est le nom le fichier téléchargé obtenu dans le hachage de valeurs de la forme PROPERTY_ID => VALUE, RECORD_ID - ID d`enregistrement, PROPERTY_ID - ID de champ.

Télécharger des fichiers

Pour télécharger un fichier dans un enregistrement, vous devez faire une requête POST à la méthode API upload_file avec un en-tête de type de contenu multipart / form-data et seulement après cela, vous devez créer ou mettre à jour votre enregistrement. Donc l'ID d'enregistrement doit être généré avant les appels. Et vous devrez également générer l'en-tête Multipart, veuillez suivre l'exemple Ruby avec la classe MultipartPost ci-dessous. Par exemple, vous apprendrez à télécharger le fichier dans le sous-formulaire.

Exemple sur 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

Paramètres

rest_api_key

Votre clé API

APP_ID

property_id

dtype_id

nous faisons une demande (JSON)

Format

JSON

Méthode

POST

URL

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

Le corps de la demande

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

Réponse

    Uploaded

Supprimer des fichiers

Paramètres

rest_api_key

Votre clé API

APP_ID

property_id

DTYPE_ID

SINGLE_FILE_NAME

Nom de fichier

nous faisons une demande (JSON)

Format

JSON

Méthode

GET

URL

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

Le corps de la demande

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

Réponse

    File removed

Exemples

Ruby ~ Javascript (jQuery)

    	
require 'open-uri'
require 'openssl'

require 'net/http'
require 'json'

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

	# Créez un appel à la méthode requise: 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

   # Convertissez les paramètres en JSON/XML et définissez le type de contenu sur application/json ou application/xml   Notez le format XML, où l`élément racine est 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
	# définir le type de contenu
  req["Content-Type"] = "application/#{format}"

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

  # tous les appels via HTTPS et vérifier les certificats SSL

  https.use_ssl = (uri.scheme == 'https')
  https.verify_mode = (OpenSSL::SSL::VERIFY_PEER)
	# nous faisons une demande
  https.start do |htt| 
    htt.request(req)
  end
end


# N'oubliez pas d`installer votre propre clé API_KEY
params = { 
  :page => 1,
  :rest_api_key => "API_KEY"
}

response = call_mth "https://quintadb.ru/apps.json", "json", "get", params
# La réponse sera dans response.body
puts response.body

Il s'agit d`une API REST de base et elle devrait être suffisante pour créer des choses intéressantes et utiles. Cependant, si vous avez besoin d`autre chose, comme plus de méthodes, etc., veuillez Contactez-nous à tout moment. Nous sommes toujours heureux d`avoir de vos nouvelles!

API REST QuintaDB

Informations générales sur les appels API

Database

Form

Champ

Dossier

Rapports

Fichiers

Nous utilisons des cookies pour fournir les fonctionnalités requises du site. En cliquant sur "Accepter", vous autorisez l`utilisation de cookies sur notre site Internet.