API REST do QuintaDB

API REST do QuintaDB Projetado para permitir que você explore totalmente o potencial dos dados armazenados no banco de dados do QuintaDB. Ao usar esta API, você pode obter mais do que a interface do QuintaDB oferece atualmente. Na verdade, oferecemos a você a oportunidade de fazer tudo o que você precisa com os dados. Por exemplo, você pode criar seus próprios scripts, aplicativos de computador e aplicativos móveis para várias plataformas, como iPhone/Android e others. E o QuintaDB ficará lá, onde você armazena, gerencia e usa seus dados com outras pessoas

Informações gerais sobre chamadas de API

Todas as chamadas devem conter uma chave de API REST, que pode ser encontrada clicando no botão "Chaves de API" no início da página.
A resposta do servidor pode ser recebida no formato JSON ou XML , dependendo de sua solicitação.
Abaixo, mostramos tabelas com respostas do servidor para cada solicitação. Os URLs serão mostrados como /apps.json , o que significa que você deve chamar o método com o link https://QuintaDB.ru /apps.json em seu programa. Observe que todas as chamadas devem usar o protocolo https e você deve verificar a validade do certificado SSL do servidor.

Banco de Dados

Esses atributos do banco de dados podem ser obtidos usando a API REST.

o identificador exclusivo do banco de dados

name

Nome

created_at

horário em que o banco de dados foi criado

updated_at

horário em que o banco de dados foi atualizado

veja todos os bancos de dados

Parâmetros

rest_api_key

sua chave de API

page

os bancos de dados são exibidos 20 por página; portanto, a página pode ter 1..5

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

GET

URL

/apps.json

Conteúdo da solicitação

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

resposta: retorna todos os bancos de dados

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

GET

URL

/apps.xml

Conteúdo da solicitação

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

resposta: retorna todos os bancos de dados

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

obtenha o banco de dados para identificação

Parâmetros

rest_api_key

sua chave de API

APP_ID

Você deve saber o ID do banco de dados que deseja excluir. Você pode encontrar o ID depois de receber todos os bancos de dados . Conhecendo o ID do banco de dados, você deve substituir o ID no URL, por exemplo:/apps/ID.json em /apps/aOWO_dVXHdHie1WeGFE8k2.json

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

GET

URL

/apps/APP_ID.json

Conteúdo da solicitação

{"rest_api_key":"API_KEY"}

resposta: retorna informações sobre o banco de dados

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

GET

URL

/apps/APP_ID.xml

Conteúdo da solicitação

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

resposta: retorna informações sobre o banco de dados

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

obtém o banco de dados por nome

Parâmetros

rest_api_key

sua chave de API

Nome

Você deve saber o nome do banco de dados. Você pode obter o nome executando a consulta Obter todos os bancos de dados ..

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

GET

URL

/apps/search.json

Conteúdo da solicitação

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

resposta: retorna informações sobre o banco de dados

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

GET

URL

/apps/search.xml

Conteúdo da solicitação

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

resposta: retorna informações sobre o banco de dados

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

atualize o banco de dados

Parâmetros

rest_api_key

sua chave de API

APP_ID

name

novo nome do banco de dados

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

PUT

URL

/apps/APP_ID.json

Conteúdo da solicitação

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

resposta: retorna informações sobre o banco de dados

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

PUT

URL

/apps/APP_ID.xml

Conteúdo da solicitação

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

resposta: retorna informações sobre o banco de dados

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

Exclua o banco de dados

Parâmetros

rest_api_key

sua chave de API

APP_ID

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

DELETE

URL

/apps/APP_ID.json

Conteúdo da solicitação

{"rest_api_key":"API_KEY"}

resposta

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

DELETE

URL

/apps/APP_ID.xml

Conteúdo da solicitação

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

resposta

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

Após excluir o banco de dados, este método retorna todos os bancos de dados restantes.

Crie uma projeto

Parâmetros

rest_api_key

sua chave de API

database_name

o nome do banco de dados

form_name

o nome do formulário. Você não pode criar uma banco de dados sem uma formulário porque não há nenhone ponto em uma banco de dados sem uma formulário.

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

POST

URL

/apps.json

Conteúdo da solicitação

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

resposta: retorna informações sobre o banco de dados

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

POST

URL

/apps.xml

Conteúdo da solicitação

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

resposta: retorna informações sobre o banco de dados

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

Em caso de erro. Você receberá uma mensagem de erro, ou seja, 'Esse nome de aplicativo já existe'.

Form

Esses atributos de forma podem ser obtidos pela API REST.

o identificador exclusivo para o formulário

name

Nome

desc

Descrição

post_action

lista de destinatários de mensagens de email

Obtenha qualquer formulário

Parâmetros

rest_api_key

sua chave de API

APP_ID

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

GET

URL

/apps/APP_ID/entities.json

Conteúdo da solicitação

{rest_api_key":"API_KEY"}

resposta: Obtém todos os formulários do banco de dados

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

GET

URL

/apps/APP_ID/entities.xml

Conteúdo da solicitação

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

resposta: Obtém todos os formulários do banco de dados

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

faça o download do formulário no ID

Parâmetros

rest_api_key

sua chave de API

APP_ID

Você deve conhecer o ID do formulário. Você pode encontrar ENTITY_ID depois de receber todos os formulários . Ao conhecer o ID do formulário, você precisa listar ENTITY_ID no URL, por exemplo:/apps/APP_ID/entity. json em /apps/aOWO_dVXHdHie1WeGFE8k2/entities.json

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

GET

URL

/apps/APP_ID/entities/ID.json

Conteúdo da solicitação

{"rest_api_key":"API_KEY"}

resposta: retorna informações sobre formulários

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

GET

URL

/apps/APP_ID/entities/ID.xml

Conteúdo da solicitação

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

resposta: retorna informações sobre formulários

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

obtenha o formulário por nome

Parâmetros

rest_api_key

sua chave de API

database_name

Você deve saber o nome do banco de dados. Você pode obter o nome executando a consulta Obter todos os bancos de dados ..

form_name

Você deve saber o nome do formulário. Você pode obtê-lo conectando Obtenha todos os formulários .

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

GET

URL

/apps/search/entities/search.json

Conteúdo da solicitação

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

resposta: retorna informações sobre formulários

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

GET

URL

/apps/search/entities/search.xml

Conteúdo da solicitação

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

resposta: retorna informações sobre formulários

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

Atualize o formulário

Parâmetros

rest_api_key

sua chave de API

APP_ID

name

Novo nome do formulário. Veja todas as opções disponíveis aqui

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

PUT

URL

/apps/APP_ID/entities/ID.json

Conteúdo da solicitação

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

resposta: retorna informações sobre formulários

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

PUT

URL

/apps/APP_ID/entities/ID.xml

Conteúdo da solicitação

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

resposta: retorna informações sobre formulários

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

exclua o formulário

Parâmetros

rest_api_key

sua chave de API

APP_ID

Você deve saber o ID do formulário que deseja excluir. Você pode encontrar o ID depois de receber todos os formulários . Conhecendo o ID do formulário, você deve substituir o ID no URL, por exemplo:/apps/APP_ID /entities/ID.json em /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2.json

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

DELETE

URL

/apps/APP_ID/entities/ID.json

Conteúdo da solicitação

{"rest_api_key":"API_KEY"}

resposta

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

DELETE

URL

/apps/APP_ID/entities/ID.xml

Conteúdo da solicitação

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

resposta

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

Crie uma formulário

Parâmetros

rest_api_key

sua chave de API

APP_ID

name

Nome do formulário

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

POST

URL

/apps/APP_ID/entities.json

Conteúdo da solicitação

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

resposta: retorna informações sobre formulários

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

POST

URL

/apps/APP_ID/entities.xml

Conteúdo da solicitação

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

resposta: retorna informações sobre formulários

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

Esses atributos do campo podem ser obtidos pela API REST.

o identificador exclusivo do campo

entity_id

ID do campo do formulário

name

Nome

type_name

tipo de campo. Talvez: 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

obtém campos de formulário

Parâmetros

rest_api_key

sua chave de API

APP_ID

ENTITY_ID

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

GET

URL

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

Conteúdo da solicitação

{rest_api_key":"API_KEY"}

resposta: obtém todos os campos do formulário

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

GET

URL

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

Conteúdo da solicitação

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

resposta: obtém todos os campos do formulário

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

obtém uma campo

Parâmetros

rest_api_key

sua chave de API

APP_ID

ENTITY_ID

Você deve conhecer o ID do campo. Você pode encontrar o ID depois de receber todos os campos do formulário . Conhecendo o ID do campo, é necessário substituir o ID no URL, por exemplo:/apps/APP_ID/entity/ENTITY_ID/properties/ID.json em /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties/asdasddVXHdHie1WeGFE8k2.json

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

GET

URL

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

Conteúdo da solicitação

{"rest_api_key":"API_KEY"}

resposta

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

GET

URL

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

Conteúdo da solicitação

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

resposta

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

obtém uma campo com Nome

Parâmetros

rest_api_key

sua chave de API

database_name

Você deve saber o nome do banco de dados. Você pode obter o nome executando a consulta Obter todos os bancos de dados ..

form_name

Você deve saber o nome do formulário. Você pode obtê-lo conectando Obtenha todos os formulários .

field_name

Você deve saber o nome do campo. Você pode obtê-lo conectando Obtenha todos os campos do formulário .

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

GET

URL

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

Conteúdo da solicitação

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

resposta

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

GET

URL

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

Conteúdo da solicitação

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

resposta

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

Executar ação

Parâmetros

rest_api_key

sua chave de API

DTYPE_ID

Você precisa saber seu identificador de registro. Você pode encontrar o ID usando a chamada Buscar todos os registros.

ACTION_PROPERTY_ID

Você precisa saber o identificador do seu campo. Você pode encontrar o ID usando a chamada Buscar todos os campos do formulário.

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

GET

URL

/actions/ACTION_PROPERTY_ID.json

Conteúdo da solicitação

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

resposta

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

Estamos fazendo onea consulta (XML)

Formato

XML

Método

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Conteúdo da solicitação

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

resposta

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

Executar ações

Parâmetros

rest_api_key

sua chave de API

ACTION_PROPERTY_ID

Você precisa saber o identificador do seu campo. Você pode encontrar o ID usando a chamada Buscar todos os campos do formulário.

dtype_ids

Você precisa conhecer os identificadores de seus registros. Você pode encontrar o ID usando a chamada Buscar todos os registros.

json_dtype_ids

Você precisa conhecer os identificadores de seus registros. Você pode encontrar o ID usando a chamada Buscar todos os registros.

run_by_all_table_or_report

O seguinte parâmetro está disponível para executar todas as ações na tabela ou relatório: run_by_all_table_or_report=true.

view

para obter registros, você precisa conhecer o ID do relatório. (Não necessariamente)

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

GET

URL

/actions/ACTION_PROPERTY_ID.json

Conteúdo da solicitação

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

resposta

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

Estamos fazendo onea consulta (XML)

Formato

XML

Método

GET

URL

/actions/ACTION_PROPERTY_ID.xml

Conteúdo da solicitação

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

resposta

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

Atualiza o campo

Parâmetros

rest_api_key

sua chave de API

APP_ID

ENTITY_ID

name

Novo nome do campo. Todos os atributos disponíveis podem ser encontrados aqui

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

PUT

URL

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

Conteúdo da solicitação

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

resposta

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

PUT

URL

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

Conteúdo da solicitação

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

resposta

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

Excluir campo

Parâmetros

rest_api_key

sua chave de API

APP_ID

ENTITY_ID

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

DELETE

URL

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

Conteúdo da solicitação

{"rest_api_key":"API_KEY"}

resposta

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

DELETE

URL

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

Conteúdo da solicitação

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

resposta

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

Crie uma campo

Parâmetros

rest_api_key

sua chave de API

APP_ID

ENTITY_ID

name

Nome do campo

type_name

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

POST

URL

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

Conteúdo da solicitação

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

resposta: retorna informações sobre formulários

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

POST

URL

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

Conteúdo da solicitação

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

resposta: retorna informações sobre formulários

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

Obtenha os totais na coluna

Parâmetros

rest_api_key

sua chave de API

ENTITY_ID

view

para obter registros, você precisa conhecer o ID do relatório. (Não necessariamente)

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

GET

URL

/search/sum/ENTITY_ID/ID.json

Conteúdo da solicitação

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

resposta

    
{total: 3}

Estamos fazendo onea consulta (XML)

Formato

XML

Método

GET

URL

/search/sum/ENTITY_ID/ID.xml

Conteúdo da solicitação

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

resposta

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

Record

Esses atributos de gravação podem ser obtidos pela API REST.

O identificador exclusivo para o registro.

app_id

ID do projeto

entity_id

ID do formulário de registro

values

Hash write values. Onde a chave é o ID do campo e o valor é o valor do campo.

json_values

Registre hash de valores. Onde chave é id de campo e valor é esse valor de campo. Análogo de values_hash mas no formato JSON

rel_values

O hash do valor do link do registro. Onde a chave é o ID do campo e o valor é o ID do registro associado.

obtenha registros

Parâmetros

rest_api_key

sua chave de API

APP_ID

ENTITY_ID

view

para obter registros, você precisa conhecer o ID do relatório. (Não necessariamente)

page

Número da página com registros. De 1 ao número de registros/ por_página .

name_value

Use o parâmetro para obter os registros do formulário: "nome do campo": "valor", "id do campo": "nome do campo"

fetch_all

Para proprietários de contas pagas, o seguinte parâmetro está disponível: fetch_all=true.
Para obter um número específico de postagens, use o parâmetro per_page.
Restrições ao número máximo de entradas per_page para diferentes planos:
FREE - 200
STANDARD - 500
PROFESSIONAL - 1000
ENTERPRISE - 2000
STANDARD EXPRESS - 4000
PROFESSIONAL EXPRESS - 8000
ENTERPRISE EXPRESS - 15000

Corpo da solicitação
{"rest_api_key":"API_KEY", "page": 1, "name_value": 1, "view": 'EaWQZdIXfahOqWvcvwrGTP', "fetch_all": true, "per_page": 2000}

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

GET

URL

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

Conteúdo da solicitação

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

resposta

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

GET

URL

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

Conteúdo da solicitação

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

resposta

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

obtenha uma registro

Parâmetros

rest_api_key

sua chave de API

APP_ID

Você deve conhecer o ID do registro. O ID pode ser encontrado após o recebimento de todos os registros . Quando você conhece o ID, é necessário substituir o ID no URL, por exemplo:/apps/APP_ID/dtypes/ID. json em /apps/aOWO_dVXHdHie1WeGFE8k2/dtypes/asd987asdasd97asd.json

name_value

Use o parâmetro para obter os registros do formulário: "nome do campo": "valor", "id do campo": "nome do campo"

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

GET

URL

/apps/APP_ID/dtypes/ID.json

Conteúdo da solicitação

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

resposta

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

GET

URL

/apps/APP_ID/dtypes/ID.xml

Conteúdo da solicitação

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

resposta

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

Atualiza o registro

Parâmetros

rest_api_key

sua chave de API

APP_ID

values

valores de registro de hash, em que a chave é o ID do campo do formulário

json_values

Se você usa jQuery, Ruby ou outra linguagem de programação, insira os valores do registro como o hash codificado no parâmetro 'values'. Mas se sua estrutura não permitir, envie os valores do registro, JSON, por exemplo: " {"aNW4nkW5bdUjldO8oKuSku ": "2 ", "aMW4HKWR9bnOoGWQbpWQS4 ": "aaa "} ". Mas use o nome do parâmetro 'json_values'.

subforms_values / subforms_json_values

Para criar ou atualizar subformulários, da mesma forma, use o 'subforms_values' ou 'json_subforms_values'.
o seguinte 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 "}}, 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 "}}} ".

Onde property1_id e property2_id é o ID dos campos do subformulário na tabela principal.
subform1_id, subform2_id - O ID do formulário, para o qual os campos property1_id e property2_id apontam.
subform1_record1_id e subform1_record2_id - esse é o ID dos registros novos ou existentes do subformulário.
subform1_field1_id, subform1_field2_id - ID dos campos no formulário subform1_id.
subform2_field1_id, subform2_field2_id - ID dos campos no formulário subform2_id.

Todos os IDs são códigos base64 seguros para URLs de 22 caracteres. Você pode retirá-los de outras APIs de conexão ou criar seus próprios para novos IDs de registros.

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

PUT

URL

/apps/APP_ID/dtypes/ID.json

Conteúdo da solicitação

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

resposta

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

PUT

URL

/apps/APP_ID/dtypes/ID.xml

Conteúdo da solicitação

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

resposta

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

Atualize vários registros

Parâmetros

rest_api_key

sua chave de API

confirm_action

O seguinte parâmetro é necessário para executar a atualização na tabela ou relatório: confirm_action: update.

ENTITY_ID

Você precisa saber o identificador de formulário do seu campo para atualizar as configurações do campo. Você pode encontrar ENTITY_ID usando a chamada Buscar todos os formulários.

APP_ID

Você precisa conhecer o identificador do seu banco de dados para obter informações do banco de dados. Você pode encontrar o ID usando a chamada Buscar todos os bancos de dados.

dtype_ids

Você precisa conhecer os identificadores de seus registros. Você pode encontrar o ID usando a chamada Buscar todos os registros.

json_dtype_ids

Você precisa conhecer os identificadores de seus registros. Você pode encontrar o ID usando a chamada Buscar todos os registros.

update_id

Você precisa saber o identificador do seu campo. Você pode encontrar o ID usando a chamada Buscar todos os campos do formulário.

update_term

Novo valor para registros

view

para obter registros, você precisa conhecer o ID do relatório. (Não necessariamente)

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Conteúdo da solicitação

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

resposta

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

Estamos fazendo onea consulta (XML)

Formato

XML

Método

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Conteúdo da solicitação


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

resposta

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

Atualizar todos os registros

Parâmetros

rest_api_key

sua chave de API

confirm_action

O seguinte parâmetro é necessário para executar a atualização de todos os registros na tabela ou relatório: confirm_action: update_all.

ENTITY_ID

Você precisa saber o identificador de formulário do seu campo para atualizar as configurações do campo. Você pode encontrar ENTITY_ID usando a chamada Buscar todos os formulários.

APP_ID

Você precisa conhecer o identificador do seu banco de dados para obter informações do banco de dados. Você pode encontrar o ID usando a chamada Buscar todos os bancos de dados.

update_id

Você precisa saber o identificador do seu campo. Você pode encontrar o ID usando a chamada Buscar todos os campos do formulário.

update_term

Novo valor para registros

view

para obter registros, você precisa conhecer o ID do relatório. (Não necessariamente)

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.json

Conteúdo da solicitação

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

resposta

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

Estamos fazendo onea consulta (XML)

Formato

XML

Método

POST

URL

/dtypes/confirm_action/APP_ID/ENTITY_ID.xml

Conteúdo da solicitação


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

resposta

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

Atualiza dados da célula

Parâmetros

rest_api_key

sua chave de API

PROPERTY_ID

DTYPE_ID

val

o novo valor da célula de dados

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.json

Conteúdo da solicitação

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

resposta

    
{"new_value": "John Smith"}

Estamos fazendo onea consulta (XML)

Formato

XML

Método

PATCH/PUT/POST

URL

/cell_values/DTYPE_ID/update_cell_value/PROPERTY_ID.xml

Conteúdo da solicitação

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

resposta

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

excluir registro

Parâmetros

rest_api_key

sua chave de API

APP_ID

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

DELETE

URL

/apps/APP_ID/dtypes/ID.json

Conteúdo da solicitação

{"rest_api_key":"API_KEY"}

resposta

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

DELETE

URL

/apps/APP_ID/dtypes/ID.xml

Conteúdo da solicitação

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

resposta

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

Excluir vários registros

Parâmetros

rest_api_key

sua chave de API

ENTITY_ID

Você precisa saber o identificador de formulário do seu campo para atualizar as configurações do campo. Você pode encontrar ENTITY_ID usando a chamada Buscar todos os formulários.

APP_ID

Você precisa conhecer o identificador do seu banco de dados para obter informações do banco de dados. Você pode encontrar o ID usando a chamada Buscar todos os bancos de dados.

dtype_ids

Você precisa conhecer os identificadores de seus registros. Você pode encontrar o ID usando a chamada Buscar todos os registros.

json_dtype_ids

Você precisa conhecer os identificadores de seus registros. Você pode encontrar o ID usando a chamada Buscar todos os registros. (Não necessariamente)

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

POST

URL

/apps/APP_ID/dtypes/delete_multiple.json

Conteúdo da solicitação

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

resposta

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

Estamos fazendo onea consulta (XML)

Formato

XML

Método

POST

URL

/apps/APP_ID/dtypes/delete_multiple.xml

Conteúdo da solicitação


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

resposta

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

excluir tudo

Parâmetros

rest_api_key

sua chave de API

APP_ID

Você precisa conhecer o identificador do seu banco de dados para obter informações do banco de dados. Você pode encontrar o ID usando a chamada Buscar todos os bancos de dados.

ENTITY_ID

Você precisa saber o identificador de formulário do seu campo para atualizar as configurações do campo. Você pode encontrar ENTITY_ID usando a chamada Buscar todos os formulários.

view

para obter registros, você precisa conhecer o ID do relatório. (Não necessariamente)

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.json

Conteúdo da solicitação

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

resposta

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

Estamos fazendo onea consulta (XML)

Formato

XML

Método

DELETE

URL

/dtypes/APP_ID/delete_all/ENTITY_ID.xml

Conteúdo da solicitação


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

resposta

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

Novo registro

Parâmetros

rest_api_key

sua chave de API

APP_ID

ENTITY_ID

Se precisar usar seu ID pessoal, você pode gerar UUID (identificador exclusivo) base64 segura para URL com 22 caracteres de comprimento Por exemplo em Ruby . Em seguida, você precisará passá-lo para o hash 'valores', por exemplo: valores => {'id' => ID}, mude para: values => {'id' => '22adadVXHdHie1WeGFE8k2'}, caso contrário, o sistema irá gerar um identificador único para você.

values / json_values

subforms_values / subforms_json_values

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

POST

URL

/apps/APP_ID/dtypes.json

Conteúdo da solicitação

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

resposta: retorna informações sobre formulários

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

POST

URL

/apps/APP_ID/dtypes.xml

Conteúdo da solicitação

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

resposta: retorna informações sobre formulários

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

Pesquisar

Parâmetros

rest_api_key

sua chave de API

APP_ID

ENTITY_ID

view

para obter registros, você precisa conhecer o ID do relatório. (Não necessariamente)

search

Você gostaria de um movimento rápido na mesa? "SEARCH_TERM", "o" => "SEARCH_CRITERIA"}]].
PROPERTY_ID - identificador de campo pelo qual estamos pesquisando ( -ALL - - para pesquisar todas as colunas),
SEARCH_TERM - o valor que procuramos,
SEARCH_CRITERIA - critério para uma mensagem, talvez um deles:
is, is_not, is_empty, is_not_empty, starts_with, ends_with, like, contains, not_contains.

Para números e datas regulares : less_than, greater_than, less_than_or_equal_to, greater_than_or_equal_to.

Para um encontro por cerca de uma 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.

Colunas do sistema : added_by, created_at, updated_at, ip.

Se você deseja pesquisar em várias colunas com um critério "E" unificador, esses critérios devem ser colocados em uma matriz, se "OU", então em um separado, por exemplo:
[[{"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"}]]

a fórmula de pesquisa 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

O número de registros nos resultados da pesquisa, o máximo é 200.

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

POST

URL

/search/APP_ID.json

Conteúdo da solicitação

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

resposta

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

Relacionamento

Como vincular registros:

Para estabelecer uma relacionamento entre registros, você deve enviar uma hash separado no registro CREATE OR UPDATE da consulta.

curl -H 'Tipo de conteúdo: 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 "

Hash deve esteja no formato 'rel' => {rel_id => RECORD_ID} ou 'rel' => {rel_id => [RECORD_ID, RECORD_ID2]} se você tiver uma relacionamento Muitos-para-Muitos. Onde RECORD_ID é o ID do registro no qual você deseja combinar o atual Aqui está como obter rel_id.

Parâmetros

rest_api_key

sua chave de API

PROPERTY_ID

ENTITY_ID

Você deve saber o ID do formulário. Você pode encontrar ENTITY_ID depois de receber todos os formulários . Conhecendo o ID do formulário, você precisará substituir ENTITY_ID na URL, por exemplo /apps/APP_ID/entities/ENTITY_ID/properties.json por /apps/qweWO_dVXHdHie1WeGFE8k2/entities/aOWO_dVXHdHie1WeGFE8k2/properties.json

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

GET

URL

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

Conteúdo da solicitação

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

resposta

Relatórios

Tais atributos de relatório podem ser acessados via API REST.

name

Nome

Obter relatórios

Parâmetros

rest_api_key

sua chave de API

APP_ID

ID do projeto

ENTITY_ID

ID da tabela (formulário)

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

GET

URL

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

Conteúdo da solicitação

{"rest_api_key":"API_KEY"}

resposta: retorna todos os relatórios da tabela.

    
{"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 fazendo onea consulta (XML)

Formato

XML

Método

GET

URL

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

Conteúdo da solicitação: retorna todos os relatórios da tabela.

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

resposta

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

Arquivos

veja o link do arquivo

para obter o link para o arquivo, primeiro obtenha os valores do campo de registro e você pode fazer o download do arquivo no link https://quintadb.com/images/data/PROPERTY_ID/RECORD_ID/FILE_NAME, em que FILE_NAME - o nome do arquivo baixado, obtido em hashes do tipo PROPERTY_ID => VALUE, RECORD_ID - ID do registro, PROPERTY_ID - ID do campo.

baixar arquivos

Para fazer upload de um arquivo em um registro, você deve fazer uma solicitação POST ao método da API upload_file com o cabeçalho de tipo de conteúdo multipart / form-data e somente depois disso você deve criar ou atualizar seu registro. Portanto, o ID do registro deve ser gerado antes das chamadas. E você também terá que gerar o cabeçalho Multipart, por favor, siga o exemplo Ruby com a classe MultipartPost abaixo. No exemplo, você aprenderá como fazer upload do arquivo no subformulário também.

Exemplo em 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

sua chave de API

APP_ID

property_id

dtype_id

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

POST

URL

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

Conteúdo da solicitação

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

resposta

    Uploaded

Remover arquivos

Parâmetros

rest_api_key

sua chave de API

APP_ID

property_id

DTYPE_ID

SINGLE_FILE_NAME

Nome do arquivo

Estamos fazendo onea consulta (JSON)

Formato

JSON

Método

GET

URL

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

Conteúdo da solicitação

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

resposta

    File removed

Exemplos

Ruby ~ Javascript (jQuery)

    	
require 'open-uri'
require 'openssl'

require 'net/http'
require 'json'

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

	# Creating proper call with Method: 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

   # Converta parâmetros em JSON/XML e defina o tipo de conteúdo como application/json ou application/xml   Observe o formato do parâmetro XML, no qual o elemento principal é 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
	# Setting content type
  req["Content-Type"] = "application/#{format}"

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

  # Todas as conexões HTTPS e certificados SSL são verificados

  https.use_ssl = (uri.scheme == 'https')
  https.verify_mode = (OpenSSL::SSL::VERIFY_PEER)
	# Estamos fazendo onea consulta
  https.start do |htt| 
    htt.request(req)
  end
end


# Lembre-se de definir o API_KEY
params = { 
  :page => 1,
  :rest_api_key => "API_KEY"
}

response = call_mth "https://quintadb.ru/apps.json", "json", "get", params
# A resposta estará disponível response.body
puts response.body

Esta é a API REST básica e deve ser suficiente para criar coisas interessantes e úteis. No entanto, se você quiser algo mais, por exemplo, mais métodos, etc. Entre em contato com entre em contato nós a qualquer momento. Estamos sempre animados para ouvir de você!

API REST do QuintaDB

Informações gerais sobre chamadas de API

Banco de Dados

Form

campo

Record

Relatórios

Arquivos

Utilizamos cookies para fornecer a funcionalidade necessária do site. Ao clicar em "Aceitar", você concorda com o uso de cookies em nosso site.