Métodos

Login
Efetua login no SuiteCRM e retorna um id de sessão usado para chamadas API subsequentes.

 

Argumentos

Nome	Tipo	Descrição
user_auth	array	Detalhes de autenticação para o usuário API.
user_auth[user_name]	string	O nome de usuário do usuário SuiteCRM. Requeridos.
user_auth[password]	string	O hash MD5 da senha para user_name. Requeridos.
application_name	string	Um identificador para o aplicativo que acessa a API.
name_value_list	name_value_list	Uma variedade de opções de login.
name_value_list[language]	string	O idioma deste usuário.
name_value_list[notifyonsave]	bool	Enviar notificações por e-mail quando um novo registro for salvo e atribuído a um usuário.

 

Resposta

Nome	Tipo	Descrição
id	string	A identificação da sessão para este login. Obrigatório para todas as outras chamadas de API.
name_value_list	name_value_list	Um array contendo informações sobre este usuário.
name_value_list[user_id]	string	A id do usuário conectado.
name_value_list[user_name]	string	O user_name do usuário conectado.
name_value_list[user_language]	string	A configuração de idioma do usuário conectado.
name_value_list[user_currency_id]	string	O id da moeda do usuário conectado. -99 é a moeda padrão.
name_value_list[user_currency_name]	string	O nome da moeda do usuário conectado.
name_value_list[user_is_admin]	bool	Se o usuário conectado é um administrador.
name_value_list[user_default_team_id]	string	A equipe padrão do usuário conectado. Este valor vem antes da bifurcação do SuiteCRM e não é usado.
name_value_list[user_default_dateformat]	string	O formato de data padrão do usuário conectado.
name_value_list[user_default_timeformat]	string	O formato de hora padrão do usuário conectado.
name_value_list[user_number_seperator]	string	O separador de número do usuário conectado. (Ou seja, vírgula para números no formato 1.000,00).
name_value_list[user_decimal_seperator]	string	O separador decimal do usuário conectado. (Ou seja, ponto final para números no formato 1.000,00).
name_value_list[mobile_max_list_entries]	int	Máximo de entradas da lista para o usuário conectado (simplesmente pega a chave de configuração wl_list_max_entries_per_subpanel).
name_value_list[mobile_max_subpanel_entries]	int	Máximo de entradas de subpainel para o usuário conectado (simplesmente pega a chave de configuração wl_list_max_entries_per_subpanel).

 

 

Logout
Desconecta o usuário da web do SuiteCRM e destrói a sessão.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.

 

Resposta
Sem resposta.

 

 

get_available_modules
Retorna uma lista dos módulos disponíveis para uso. Também retorna a ACL (Lista de Controle de Acesso) para cada módulo.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
filter	string	Filtre os módulos retornados. Pode ser ‘padrão’, ‘móvel’ ou ‘todos’.

 

Respostas

Nome	Tipo	Descrição
modules	array	Um array contendo os detalhes do módulo.
modules[][module_key]	string	A chave para este módulo.
modules[][module_label]	string	O rótulo para este módulo.
modules[][favorite_enabled]	bool	Os favoritos eram a funcionalidade do SugarCRM Professional. Isso está sempre vazio.
modules[][acls]	array	Uma matriz contendo a lista ACL – é isso que as ações são permitidas.
modules[][acls][][action]	string	A ação, ou seja, editar, excluir, listar etc.
modules[][acls][][access]	bool	Se o acesso é permitido ou não.

 

 

get_document_revision
Retorna os detalhes de uma revisão específica do documento.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
i	string	O id da revisão do documento a ser recuperado.

 

Respostas

Nome	Tipo	Descrição
document_revision	array	Um array contendo os detalhes da revisão do documento.
document_revision[id]	string	O id da revisão do documento.
document_revision[document_name]	string	O nome da revisão do documento.
document_revision[revision]	int	O número de revisão da revisão do documento.
document_revision[filename]	string	O nome do arquivo.
document_revision[file]	binary string	O conteúdo completo do arquivo.

 

 

get_entries
Obtém uma lista de entradas para um módulo específico e uma lista de ids de módulo. Opcionalmente, permite retornar registros relacionados.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
module_name	string	O nome do módulo para o qual exibir entradas.
ids	array	Uma matriz de IDs de registro para buscar.
ids[]	string	Um id individual.
select_fields	array	Uma matriz de campos a serem retornados. Uma matriz vazia retornará todos os campos.
select_fields[]	string	O nome de um campo a ser retornado.
link_name_to_fields_array	name_value_list	Uma matriz de relacionamentos a serem recuperados.
link_name_to_fields_array[][name]	string	O nome do link a seguir (conforme definido em module_name).
link_name_to_fields_array[][value]	array	Uma matriz dos campos a serem retornados para este módulo relacionado.
link_name_to_fields_array[][value][]	string	O nome do campo.
track_view	bool	Se deve marcar esses registros como vistos recentemente.

 

Respostas

Nome	Tipo	Descrição
entry_list	array	Uma série de registros.
entry_list[]	array	Detalhes de um registro individual.
entry_list[][id]	string	A id deste registro.
entry_list[][module_name]	string	O nome do módulo ao qual este registro pertence.
entry_list[][name_value_list]	name_value_list	Uma matriz contendo cada campo retornado.
entry_list[][name_value_list][]	array	Uma matriz contendo cada campo retornado.
entry_list[][name_value_list][][name]	string	O nome do campo.
entry_list[][name_value_list][][value]	string	O nome do campo.
relationship_list	array	Uma matriz de matrizes contendo os relacionamentos para o registro correspondente.
relationship_list[]	array	Os relacionamentos para o registro correspondente.
relationship_list[link_list]	array	A lista de relacionamentos para este registro.
relationship_list[link_list][]	array	Detalhes de um único relacionamento.
relationship_list[link_list][][name]	string	O nome deste relacionamento.
relationship_list[link_list][][records]	array	Os registros relacionados a este relacionamento.
relationship_list[link_list][][records][]	array	Detalhes de um único registro relacionado.
relationship_list[link_list][][records][][link_value]	name_value_list	Uma matriz dos campos solicitados para este relacionamento.
relationship_list[link_list][][records][][link_value][]	array	Um par de valor de nome para este campo específico.
relationship_list[link_list][][records][][link_value][name]	string	O nome do campo.
relationship_list[link_list][][records][][link_value][value]	string	O valor do campo.

 

 

get_entries_count
Retorna uma contagem de entradas que correspondem à consulta fornecida.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
module_name	string	O nome do módulo para o qual exibir entradas.
query	string	Uma cláusula SQL WHERE a ser aplicada à consulta.
deleted	bool	Se incluir registros excluídos.

 

Respostas

Nome	Tipo	Descrição
result_count	int	A contagem de entradas correspondentes.

 

 

get_entry
Retorna os detalhes de um único registro. Opcionalmente, permite retornar registros relacionados.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
module_name	string	O nome do módulo para o qual buscar a entrada.
id	string	O id do registro para buscar.
select_fields	array	Uma matriz de campos a serem retornados. Uma matriz vazia retornará todos os campos.
select_fields[]	string	O nome de um campo a ser retornado.
link_name_to_fields_array	name_value_list	Uma matriz de relacionamentos a serem recuperados.
link_name_to_fields_array[][name]	string	O nome do link a seguir (conforme definido em module_name).
link_name_to_fields_array[][value]	array	Uma matriz dos campos a serem retornados para este módulo relacionado.
link_name_to_fields_array[][value][]	string	O nome do campo.
track_view	bool	Se deve marcar esses registros como vistos recentemente.

 

Resposta
Idêntica à resposta de get_entries, exceto que apenas um registro será retornado.

 

 

get_entry_list

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
module_name	string	O nome do módulo para o qual buscar a entrada.
query	string	Uma cláusula SQL WHERE a ser aplicada à consulta.
order_by	string	Em teoria, para resultados de pedidos, mas isso não é usado.
offset	int	O resultado compensado. Útil para paginação.
select_fields	array	Uma matriz de campos a serem retornados. Uma matriz vazia retornará todos os campos.
select_fields[]	string	O nome de um campo a ser retornado.
link_name_to_fields_array	name_value_list	Uma matriz de relacionamentos a serem recuperados.
link_name_to_fields_array[][name]	string	O nome do link a seguir (conforme definido em module_name).
link_name_to_fields_array[][value]	array	Uma matriz dos campos a serem retornados para este módulo relacionado.
link_name_to_fields_array[][value][]	string	O nome do campo.
max_results	int	O número máximo de resultados a serem retornados. Útil para paginação.
deleted	bool	Se incluir registros excluídos.
favorites	bool	Os favoritos eram a funcionalidade do SugarCRM Professional. Isso não é usado.

 

Resposta

Nome	Tipo	Descrição
result_count	int	O número de registros retornados.
total_count	int	O número total de registros que correspondem à consulta.
next_offset	int	O deslocamento do próximo conjunto de registros.
entry_list	array	Uma série de registros.
entry_list[]	array	Detalhes de um registro individual.
entry_list[][id]	string	A id deste registro.
entry_list[][module_name]	string	O nome do módulo ao qual este registro pertence.
entry_list[][name_value_list]	name_value_list	Uma matriz contendo cada campo retornado.
entry_list[][name_value_list][]	array	Uma matriz contendo cada campo retornado.
entry_list[][name_value_list][][name]	string	O nome do campo.
entry_list[][name_value_list][][value]	string	O valor do campo.
relationship_list	array	Uma matriz de matrizes contendo os relacionamentos para o registro correspondente.
relationship_list[]	array	Os relacionamentos para o registro correspondente.
relationship_list[link_list]	array	A lista de relacionamentos para este registro.
relationship_list[link_list][]	array	Detalhes de um único relacionamento.
relationship_list[link_list][][name]	string	O nome deste relacionamento.
relationship_list[link_list][][records]	array	Os registros relacionados a este relacionamento.
relationship_list[link_list][][records][]	array	Detalhes de um único registro relacionado.
relationship_list[link_list][][records][][link_value]	name_value_list	Uma matriz dos campos solicitados para este relacionamento.
relationship_list[link_list][][records][][link_value][]	array	Um par de valor de nome para este campo específico.
relationship_list[link_list][][records][][link_value][name]	string	O nome do campo.
relationship_list[link_list][][records][][link_value][value]	string	O valor do campo.

 

 

get_language_definition
Devoluções

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
modules	array	Uma matriz de módulos para retornar rótulos de idioma.
modules[]	string	O nome dos módulos.
md5	bool	Se deve retornar o md5 para cada módulo. Pode ser útil para armazenar respostas em cache.

 

Respostas

Nome	Tipo	Descrição
result[<modulename>]</modulename>	string/array	Uma matriz de rótulos ou uma string md5 para <modulename />

 

 

get_last_viewed
Retorna uma lista dos módulos vistos mais recentemente para o usuário atual.

Argumentos

session	string	O id da sessão. Veja o login.
module_names	array	Uma matriz dos módulos para retornar os últimos registros visualizados.
module_names[]	string	O nome dos módulos.

 

Respostas

Nome	Tipo	Descrição
result[]	array
result[][id]	int
result[][item_id]	string
result[][item_summary]	string
result[][module_name]	string
result[][monitor_id]	string
result[][date_modified	string

 

 

get_modified_relationships
Retorna uma lista dos relacionamentos modificados para o usuário atual entre um dos módulos de Chamadas, Reuniões ou Contatos.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
module_name	string	O nome do módulo para o qual recuperar relacionamentos. Sempre usuários.
related_module	string	O módulo relacionado para o qual recuperar registros. Uma das reuniões, chamadas ou contatos.
from_date	string	A data de início do intervalo a pesquisar. No formato Y-m-d H: i: s.
to_date	string	A data de término do intervalo a ser pesquisado. No formato Y-m-d H: i: s.
offset	int	O deslocamento do registro para começar.
max_results	int	O número máximo de resultados a serem retornados.
deleted	bool	Se incluir registros excluídos.
module_user_id	string	Em teoria, o id do usuário para o qual retornar relacionamentos. No entanto, o usuário atual é sempre usado.
select_fields	array	Uma matriz dos campos a serem retornados para o registro de relacionamento. Uma matriz vazia retornará todos os campos.
select_fields[]	string	O nome do campo a ser retornado.
relationship_name	string	O nome do relacionamento entre module_name e related_module.
deletion_date	string	Uma data de início para o intervalo no qual retornar os registros excluídos. No formato Y-m-d H: i: s.

 

Respostas

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
module_name	string	O nome do módulo para o qual recuperar relacionamentos. Sempre usuários.
related_module	string	O módulo relacionado para o qual recuperar registros. Uma das reuniões, chamadas ou contatos.
from_date	string	A data de início do intervalo a pesquisar. No formato Y-m-d H: i: s.
to_date	string	A data de término do intervalo a ser pesquisado. No formato Y-m-d H: i: s.
offset	int	O deslocamento do registro para começar.
max_results	int	O número máximo de resultados a serem retornados.
deleted	bool	Se incluir registros excluídos.
module_user_id	string	Em teoria, o id do usuário para o qual retornar relacionamentos. No entanto, o usuário atual é sempre usado.
select_fields	array	Uma matriz dos campos a serem retornados para o registro de relacionamento. Uma matriz vazia retornará todos os campos.
select_fields[]	string	O nome do campo a ser retornado.
relationship_name	string	O nome do relacionamento entre module_name e related_module.
deletion_date	string	Uma data de início para o intervalo no qual retornar os registros excluídos. No formato Y-m-d H: i: s.

 

 

get_module_fields
Retorna as definições de campo para um determinado módulo.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
module_name	string	O nome do módulo para o qual retornar definições de campo.
fields[]	array	Uma matriz de campos para os quais retornar definições. Uma matriz vazia retornará todos os campos.
fields[]	string	O nome do campo.

 

Respostas

Nome	Tipo	Descrição
module_name	string	O nome do módulo.
table_name	string	O nome da tabela do banco de dados para este módulo.
module_fields	array	Uma matriz dos campos solicitados para este módulo.
module_fields[]	array	Os detalhes de um campo específico.
module_fields[name]	string	O nome do campo.
module_fields[type]	string	O tipo do campo.
module_fields[group]	string	O grupo de campos ao qual este campo pertence. Usado para endereços ou definições de link.
module_fields[id_name]	string	O nome do campo de id neste módulo para este link, se apropriado.
module_fields[label]	string	O rótulo de exibição para este campo.
module_fields[required]	bool	Se este campo é obrigatório ou não.
module_fields[options]	name_value_list	Uma série de opções possíveis para este campo. Uma matriz vazia se as opções não forem apropriadas para este tipo de campo.
module_fields[options][]	array	Um par de valor de nome de uma única opção.
module_fields[options][][name]	string	Um par de valor de nome de uma única opção.
module_fields[options][][value]	string	Um par de valor de nome de uma única opção.
module_fields[related_module]	string	O módulo relacionado para este campo se for um tipo relacionado. Caso contrário, vazio.
module_fields[calculated]	string	Os campos calculados eram um recurso profissional do SugarCRM. Estará vazio.
module_fields[len]	int	O comprimento deste campo ou uma string vazia se não for apropriado para este tipo de campo.
link_fields	array	Uma matriz dos campos de link solicitados para este módulo.
link_fields[]	array	Os detalhes de um campo específico.
link_fields[name]	string	O nome do campo.
link_fields[type]	string	O tipo do campo. Sempre será link.
link_fields[group]	string	O grupo de campos ao qual este campo pertence. Estará vazio para links.
link_fields[id_name]	string	O nome do campo de id neste módulo para este link, se apropriado.
link_fields[relationship]	string	O nome do relacionamento para este link.
link_fields[module]	string	O módulo ao qual este campo está vinculado.
link_fields[bean_name]	string	O bean ao qual este campo está vinculado.

 

 

get_module_fields_md5
Retorna um md5 das definições de campo de um módulo. Útil para armazenamento em cache.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
module_names	array	Um conjunto de módulos para o qual retornar o MD5.
module_names[]	string	O nome do módulo para retornar as definições de campo md5.

 

Respostas

Nome	Tipo	Descrição
result[]	array	Uma matriz do md5 codificada pelo nome do módulo.
result[<modulename>]</modulename>	string	A string md5 para <modulename />

 

 

get_module_layout
Retorna o layout para módulos e visualizações especificados. Opcionalmente, retorna um md5 dos layouts.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
modules	array	Uma matriz de módulos para os quais retornar layouts.
modules[]	string	O nome do módulo.
types	array	Uma matriz dos tipos de visualizações a serem retornados. Apenas o padrão é compatível.
types[]	string	O tipo de visualizações.
views	array	Uma matriz das visualizações a serem retornadas. Um de edição, detalhe, lista e subpainel.
views[]	string	O nome da visualização.
acl_check	bool	Se deve ou não verificar se o usuário atual tem acesso a este módulo e visualização.
md5	bool	Se deve ou não retornar a visualização como uma string md5. Útil para armazenamento em cache.

 

Respostas

Nome	Tipo	Descrição
result	array	A matriz de resultados codificados pelo nome do módulo.
result[<modulename>]</modulename>	array	Uma matriz de layouts para <modulename>. </modulename>
result[<modulename>][default]</modulename>	array	Uma matriz de layouts codificados pelo nome da visualização.
result[<modulename>][default][<viewname>]</viewname></modulename>	array/string	O layout da visualização <viewname> para o módulo <modulename> ou um md5 do layout. Veja a seção sobre metadados para o formato do layout. </modulename> </viewname>.

 

 

get_module_layout_md5
Retorna o md5 das visualizações especificadas para os módulos especificados. Comporta-se de forma idêntica a get_module_layout com o parâmetro md5 definido como verdadeiro.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
modules	array	Uma matriz de módulos para os quais retornar layouts.
modules[]	string	O nome do módulo.
types	array	Uma matriz dos tipos de visualizações a serem retornados. Apenas o padrão é compatível.
types[]	string	O tipo de visualizações.
views	array	Uma matriz das visualizações a serem retornadas. Um de edição, detalhe, lista e subpainel.
views[]	string	O nome da visualização.
acl_check	bool	Se deve ou não verificar se o usuário atual tem acesso a este módulo e visualização.

 

Respostas

Nome	Tipo	Descrição
md5	array	A matriz de resultados codificados pelo nome do módulo.
md5[<modulename>]</modulename>	array	Uma matriz de layouts para <modulename>. </modulename>
md5[<modulename>][default]</modulename>	array	Uma matriz de layouts codificados pelo nome da visualização.
md5[<modulename>][default][<viewname>]</viewname></modulename>	string	O md5 do layout do layout da visão <viewname> para o módulo <modulename>.</modulename> </viewname>.

 

 

get_relationships
Retorna registros relacionados a um módulo específico, registro e lista de links.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
module_name	string	O módulo para o qual retornar relacionamentos.
module_id	string	O registro para o qual retornar relacionamentos.
link_field_name	string	O campo de link a seguir para este registro.
related_module_query	string	Uma cláusula WHERE a ser usada para filtrar os módulos relacionados.
related_fields	array	Uma matriz dos campos a serem retornados para registros correspondentes.
related_fields[]	string	O nome do campo.
related_module_link_name_to_fields_array	name_value_list	Uma matriz de campos relacionados a serem retornados para registros correspondentes.
related_module_link_name_to_fields_array[]	array	Detalhes para um link específico.
related_module_link_name_to_fields_array[][name]	string	O nome do link a seguir para registros correspondentes.
related_module_link_name_to_fields_array[][value]	array	Uma matriz de campos a serem retornados para este link.
related_module_link_name_to_fields_array[][value][]	string	O nome do campo.
deleted	bool	Se incluir registros excluídos.
order_by	string	Em teoria, para resultados de pedidos, mas isso não é usado.
offset	int	O deslocamento do registro para começar.
limit	int	O número máximo de resultados a serem retornados.

 

Resposta
Idêntica à resposta de get_entries.

 

 

get_server_info
Retorna informações sobre o servidor SuiteCRM. Atualmente ainda retorna informações sobre o sabor e versões do SugarCRM.

Argumentos
Sem argumentos.

 

Resposta

Nome	Tipo	Descrição
flavor	string	O sabor SugarCRM. Para SuiteCRM será sempre ‘CE’.
version	string	A versão SugarCRM. Observe que isso é diferente da versão SuiteCRM
gmt_time	string	A hora do servidor em UTC.

 

 

get_upcoming_activities
Retorna uma lista das 10 atividades futuras (reuniões, chamadas e tarefas – também inclui oportunidades) para o usuário conectado no momento.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.

 

Respostas

Nome	Tipo	Descrição
result	array	Uma série de atividades futuras.
result[]	array	Os detalhes de uma única atividade.
result[][id]	string	Os detalhes de uma única atividade.
result[][module]	string	O módulo para esta atividade.
result[][date_due]	string	A data de vencimento para esta atividade.
result[][summary]	string	O resumo desta atividade. Normalmente é simplesmente o nome.

 

 

get_user_id
Retorna o id do usuário atualmente conectado.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.

 

Respostas

Nome	Tipo	Descrição
id	string	A id do usuário atual.

 

 

seamless_login
Marca uma sessão como permitindo um login contínuo. Se for bem-sucedido, o ID da sessão (consulte a chamada de login) pode ser usado em um URL (como MSID) para fazer o login do usuário no SuiteCRM no navegador sem problemas. Por exemplo, se você tiver o id de sessão 1234, acesse a URL example.com/index.php?MSID=1234. O parâmetro MSID pode ser usado em qualquer URL SuiteCRM válido.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.

 

Respostas

Nome	Tipo	Descrição
result	bool	Booleano indicando sucesso.

 

 

search_by_module
Permite pesquisar registros que contenham uma string de pesquisa específica.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
search_string	string	A string a ser pesquisada.
modules	array	Uma matriz dos módulos a serem incluídos na pesquisa.
modules[]	string	Uma matriz dos módulos a serem incluídos na pesquisa.
offset	int	Uma matriz dos módulos a serem incluídos na pesquisa.
max_results	int	O número máximo de resultados a serem retornados. Útil para paginação.
assigned_user_id	string	Filtrar pelo usuário atribuído fornecido. Deixe em branco para não filtrar o usuário.
select_fields	array	Uma matriz dos campos a serem retornados para os registros encontrados. Uma matriz vazia retornará todos os campos.
select_fields[]	string	O nome do campo a ser retornado.
unified_search_only	bool	Se deve retornar apenas registros para módulos que participam da pesquisa global.
favorites	bool	Os favoritos eram a funcionalidade do SugarCRM Professional. Isso não é usado.

 

Respostas

Nome	Tipo	Descrição
entry_list	array	Uma matriz dos resultados para cada módulo.
entry_list[]	array	Resultados para um módulo específico.
entry_list[][name]	string	O nome do módulo para o qual esta entrada contém resultados.
entry_list[][records]	array	Uma matriz dos resultados do registro.
entry_list[][records][]	name_value_list	Uma lista de valores de nomes de registros de id e nome.
entry_list[][records][][id]	array	Um par de valor de nome contendo o id deste registro.
entry_list[][records][][name]	array	Um par de valor de nome contendo o id deste registro.

 

 

set_document_revision
Cria uma nova revisão de documento para um documento.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
note	array	Uma matriz contendo os detalhes da revisão do documento.
note[id]	string	O id do documento ao qual adicionar esta revisão.
note[file]	binary string	O conteúdo binário do arquivo, codificado em base 64.
note[filename]	string	O nome do arquivo.
note[revision]	int	O número de revisão para esta revisão.

 

Respostas

Nome	Tipo	Descrição
id	string	O id da revisão do documento recém-criado.

 

 

set_entries
Cria ou atualiza uma lista de registros.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
module_name	string	O nome do módulo para o qual criar / atualizar registros.
name_value_lists	name_value_list	Uma matriz de detalhes para cada registro a ser criado / atualizado.
name_value_lists[]	array	Detalhes de um registro individual.
name_value_lists[][]	array	Um par de valor de nome para cada valor de campo.
name_value_lists[][][name]	array	O nome do campo.
name_value_lists[][][value]	array	O valor do campo.

 

Respostas

Nome	Tipo	Descrição
ids	array	Uma matriz dos IDs resultantes. Retornado na mesma ordem especificada na chamada para set_entries.
ids[]	array	O id para este registro.

 

 

set_entry
Cria ou atualiza um único registro.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
module_name	string	O nome do módulo para o qual criar / atualizar um registro.
name_value_list	name_value_list	Uma matriz dos campos para o registro novo / atualizado.
name_value_lists[]	array	Um par de valor de nome para cada valor de campo.
name_value_lists[][name]	array	O nome do campo.
name_value_lists[][value]	array	O valor do campo.

 

Respostas

Nome	Tipo	Descrição
id	string	O valor do campo.

 

 

get_note_attachment
Retorna os detalhes de um determinado anexo de nota.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
id	string	O id da nota para a qual recuperar informações.

 

Respostas

Nome	Tipo	Descrição
note_attachment	array	Os detalhes do anexo da nota.
note_attachment	string	O id da nota para a qual recuperar informações.
note_attachment[filename]	string	O nome do arquivo.
note_attachment[file]	binary string	O conteúdo completo do arquivo.
note_attachment[related_module_id]	string	A id do registro ao qual este anexo está relacionado.
note_attachment[related_module_name]	string	O módulo do registro ao qual este anexo está relacionado.

 

 

set_note_attachment
Cria um não anexo para um registro especificado.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
note	array	O id da sessão. Veja o login.
note[id]	string	O id da nota à qual adicionar um anexo.
note[filename]	string	O nome do arquivo
note[file]	binary string	O conteúdo completo do arquivo codificado com base em 64.

 

Respostas

Nome	Tipo	Descrição
id	string	O id da nota para este anexo.

 

 

set_relationship
Define um relacionamento entre um registro e outros registros.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
module_name	string	O nome do módulo ao qual relacionar os registros.
module_id	string	O id do registro ao qual relacionar os registros.
link_field_name	string	O nome do campo do link no módulo por meio do qual os registros serão relacionados.
related_ids	array	Uma matriz de IDs de registro para relacionar.
related_ids[]	string	O id de um registro a ser relacionado.
name_value_list	name_value_list	Uma lista de valores de nomes de campos de relacionamento adicionais a serem definidos.
name_value_list[]	array	Um par de valor de nome para um campo de relacionamento a ser definido.
name_value_list[][name]	string	O nome do campo a ser definido.
name_value_list[][value]	string	O valor do campo a ser definido.
delete	bool	Se deve ou não excluir o relacionamento especificado em vez de criá-lo / atualizá-lo.

 

Respostas

Nome	Tipo	Descrição
created	int	O número de relacionamentos criados.
failed	int	O número de relacionamentos que não foram criados / excluídos.
deleted	int	O número de relacionamentos excluídos.

 

 

set_relationships
Define relacionamentos entre vários registros.

Argumentos

Nome	Tipo	Descrição
session	string	O id da sessão. Veja o login.
module_names	array	Uma série de módulos para relacionar os registros.
module_names[]	string	O nome do módulo ao qual relacionar os registros.
module_ids	array	Uma matriz de ids de registros aos quais relacionar os registros.
module_ids[]	string	O id do registro ao qual relacionar os registros.
link_field_names	string	Uma matriz de nomes de links por meio dos quais os registros serão relacionados.
link_field_names[]	string	O nome do campo do link no módulo por meio do qual os registros serão relacionados.
related_ids	array	Uma matriz de uma matriz de IDs de registro para cada módulo especificado.
related_ids[]	array	Uma matriz de IDs de registro para o módulo correspondente.
related_ids[][]	string	O ID do registro.
name_value_lists	array	Uma matriz de uma lista de matriz de valor de nome de campos de relacionamento adicionais para definir.
name_value_lists[]	name_value_list	Uma matriz de uma lista de matriz de valor de nome de campos de relacionamento adicionais para definir.
name_value_lists[][name]	string	O nome do campo a ser definido.
name_value_lists[][value]	string	O valor do campo a ser definido.
delete_array	array	Uma matriz de booleanos indicando se o relacionamento deve ou não ser excluído para cada módulo.
delete_array[]	bool	Se deve ou não excluir o relacionamento especificado em vez de criá-lo / atualizá-lo.

 

Respostas

Nome	Tipo	Descrição
created	int	O número de relacionamentos criados.
failed	int	O número de relacionamentos que não foram criados / excluídos.
deleted	int	O número de relacionamentos excluídos.