EspoCRM Tool icon

EspoCRM Tool

CRUD no EspoCRM (entidades dinâmicas por instância)

Actions14

Documentos → Listar documentos

AI-generated

Summary

Lista os documentos vinculados a um registro do EspoCRM por meio de um relacionamento do tipo Document. Pode aplicar paginação, ordenação, filtros e seleção de atributos; por padrão, retorna a resposta da API em um único item.

Inputs

  • entity (required) — Entidade do registro, escolhida nas opções disponíveis.
  • recordIdListDocuments (required) — ID do registro cujos documentos serão listados.
  • documentLinkField (required) — Relacionamento da entidade que aponta para Document.
  • options — Opções de consulta: desativar o cálculo do total, retornar cada documento como item, buscar todas as páginas automaticamente, definir tamanho máximo e deslocamento, ordenar, filtrar por filtro primário, filtros booleanos ou texto, selecionar atributos e fornecer um whereGroup.

Output shape

Por padrão, um item JSON com a resposta da API, normalmente contendo list e total. Com “Retornar lista como itens” ativado, retorna um item por documento da lista.

A consulta usa GET em entity/recordIdListDocuments/documentLinkField. “Retornar tudo” pagina automaticamente e agrega os resultados em list; o tamanho de cada página é limitado a 200 e usa 200 quando Tamanho Máx. está em 0. Sem essa opção, a resposta mantém a forma retornada pela API. Se a API não retornar um objeto JSON, a saída é um objeto com entity, recordId, linkFieldName e documents.

Links

Discussion