Holmes

Connect to Holmes Doc to manage processes, tasks, documents, and business tables.

Authentication

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use

Using the Smart Chat

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions

This connector provides 36 actions:

Action	Purpose	Parameters
post_v2_search	Procurar processos abertos Esta ação também cobre as variantes abaixo da coleção oficial mesmo método e caminho — envie o corpo correspondente em data: Buscar Central de busca / Procurar processos abertos de um fluxo específico json 'query': 'from': 0, 'size': 50, 'context': 'process', 'sort': 'updated_at', 'order': 'desc', 'groups': 'match_all': true, 'terms': 'value': '646e027613a7c30082ab328b', 'typ	data: { . query (object) . trash (boolean) . deleted_by_me (boolean) } (object) required
get_v1_processes_by_process_id_history	Consultar histórico do processo	process_id (string) required
get_v1_processes_by_process_id_details	Consultar detalhes/propriedades do processo	process_id (string) required
post_v1_workflows_by_template_id_start	Essa parte de criação de processo vai depender muito do fluxo a ser utilizado, na listagem de fluxos é possível adquirir um modelo de requisição para abertura daquele fluxo em específico. Veja no print abaixo:	template_id (string) required data: { . workflow (object) } (object) required
post_v1_documents	Caso queira fazer upload utilizando um base64, basta enviar no body em formato JSON. A flag index: 'false', serve para que o documento não fique na parte de meus uploads e sim no processo. O resultado dessa solicitação trás um 'id', esse 'id' é o que será utilizado no 'file_id' para abertura do processo. Esta ação também cobre as variantes abaixo da coleção oficial mesmo método e caminho — envie o corpo correspondente em data: Documentos / Base64 Fazer upload de documento json 'docume	data: { . index (boolean) . document (object) } (object) required
get_v1_processes_by_process_id_documents	Consultar documentos de um processo	process_id (string) required
post_v1_processes_by_process_id_comments	Adicionar comentário ao processo	process_id (string) required data: { . id (string) . message (string) . mentions (array) } (object) required
get_v1_processes_by_process_id	Consultar processo por ID	process_id (string) required
delete_v1_tasks_by_task_id_documents_by_process_document_id	Retirar documento da tarefa	task_id (string) required process_document_id (string) required
get_v1_tasks_by_task_id	Consultar tarefa por ID	task_id (string) required
put_v1_tasks_by_task_id_assign	Assumir tarefa por ID	task_id (string) required data: { . user_id (string) } (object) required
post_v1_tasks_by_task_id_action	Para tomar ação é uma tarefa é necessário que você passe quais valores vão constar no formulário ao tomar a ação. Esses valores estão presentes no body dentro de um array chamado property_values, os valores são passados no formato id-value, sendo o id da propriedade e o value o valor no qual você deseja que aquela propriedade assuma.	task_id (string) required data: { . task (object) } (object) required
post_v1_processes_by_process_id_tables_by_table_id_items	Essa requisição adiciona itens a uma tabela dentro de uma tarefa no Holmes, um exemplo seria adicionar itens a tabela Itens do reembolso no processo de Reembolso mensal.	process_id (string) required table_id (string) required data: { . item (object) } (object) required
get_v1_admin_entities_by_entity_id	Consultar propriedades de uma tabela	entity_id (string) required
post_v1_admin_entities_by_entity_id_instances_list	Consultar itens de uma tabela	entity_id (string) required data: { . page (integer) . per_page (integer) . sort_by (array) . filters (array) } (object) required
get_v1_admin_instances_by_instance_id	Consultar registro por Id na tabela	instance_id (string) required
put_v1_admin_instances_by_instance_id	Atualizar registro em uma tabela	instance_id (string) required data: { . instance (object) } (object) required
post_v1_admin_entities_by_entity_id_instances	Inserir registros em uma tabela	entity_id (string) required data: { . instance (object) } (object) required
post_v1_admin_natures_list	A busca de documentos no Holmes é paginada, com isso, é necessário que seja passado os parâmetros via body do page e per_page.	data: { . page (integer) . per_page (integer) . sort_by (array) . filters (array) } (object) required
post_v1_admin_natures	Inserir tipos de documentos	data: { . nature (object) } (object) required
put_v1_admin_natures_by_nature_id_properties	Inserir/alterar indexadores do documento	nature_id (string) required data: { . properties (array) } (object) required
get_v1_admin_natures_by_nature_id	Ver detalhes de natureza Configuração, propriedades	nature_id (string) required
put_v1_admin_natures_by_nature_id	Modificar configurações da natureza	nature_id (string) required data: { . nature (object) } (object) required
delete_v1_documents_by_document_id	Endpoint para deletar documentos da central de buscas. Para enviar um documento a lixeira, é possível utilizar esse endpoint e passando via URL uma descrição do motivo do qual se está enviando o documento para a lixeira, essa descrição poderá ser consultada no histórico do documento: Caso a descrição não seja enviada, o sistema automaticamente colocará 'Teste' como descrição. Caso deseje excluir definitivamente o documento da lixeira, basta utilizar o mesmo endpoint. Lembrando que apenas super	document_id (string) required description (string)
post_v1_documents_by_document_id_restore	Endpoint para restaurar documentos da lixeira.	document_id (string) required
post_v1_documents_by_document_id_classify	Classificação de documentos. Esta requisição utiliza o método POST para classificar documentos. Certifique-se de incluir no corpo body da requisição os seguintes parâmetros: nature_id: ID da natureza a ser classificado. property_values: Lista contendo objetos com os seguintes atributos: id: ID do indexador desejado. value: Valor que o indexador conterá.	document_id (string) required data: { . classification (object) } (object) required
get_v1_documents_by_document_id_download	Endpoint para baixar documento. Caso não queira o documento em base64 deve se enviado false no parâmetro base64	document_id (string) required base64 (string)
post_v1_admin_users	Segue a descrição dos itens enviados na requisição: language: Contém informações sobre o idioma. text: O nome do idioma em formato de texto 'Português'. value: O valor do idioma em formato de código 'pt-BR'. timezone: Define o fuso horário 'America/Sao_Paulo'. support: Um valor booleano indicando se há suporte true. system_modules: Uma lista de módulos do sistema, incluindo 'tasks', 'processes', 'reports' e 'search'. skip_welcome_email: Um valor booleano indicando se deve pular	data: { . user (object) } (object) required
put_v1_admin_users_by_user_id	Segue a descrição dos itens enviados na requisição: Claro, vou explicar cada parte do segundo JSON fornecido: user: Contém informações específicas sobre o usuário. Informações Básicas: name: Nome do usuário 'Lucas Borges'. email: Endereço de e-mail do usuário 'lucas.oliveira+teste@hotmail.com'. language: Idioma do usuário 'pt-BR'. timezone: Fuso horário do usuário 'America/Sao_Paulo'. superuser: Valor nulo não é um superusuário. admin: Um valor booleano indicando se o usuário é um admi	user_id (string) required data: { . user (object) } (object) required
post_v1_admin_users_by_user_id_deactivate	Endpoint utilizado para inativar um usuário na aplicação	user_id (string) required
post_v1_admin_users_by_user_id_activate	Endpoint utilizado para ativar um usuário na aplicação	user_id (string) required
post_v1_search_export	Explanação do Body da Requisição: Parâmetro Descrição type Define o formato do arquivo de saída, que pode ser 'csv' ou 'excel'. filename Nome do arquivo de relatório a ser exportado. query Contém os filtros e configurações para a consulta de dados. Esses filtros podem ser montados conforme explicado no passo 1. - context Define o contexto da consulta, podendo ser 'process', 'search_task' ou 'entity' para processos, tarefas e tabelas respectivamente. - groups Define os grupos de fi	data: { . type (string) . filename (string) . query (object) . only_columns (boolean) } (object) required
post_v1_search_list_exports	Endpoint utilizado para listar as exportações disponíveis, através desse endpoint é possível verificar se a exportação desejada está com o status de 'done'.	data: { . page (integer) . per_page (integer) . filters (array) } (object) required
post_v1_search_export_by_export_id	Endpoint utilizado para baixar o arquivo de uma exportação.	export_id (string) required
delete_v1_search_export_by_export_id	Endpoint utilizado para excluir uma exportação do Holmes.	export_id (string) required
custom	Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body.	_url (string) required _method (string) _query (object) _body _headers (object)