Validação
Validada no navegador em modo autenticado e somente leitura.
Voltar para a documentaçãoAbrir na plataforma
Guia operacional gerado e rastreável
Catálogo do tenant
/documents/configuracao
Treinamento da tela Catálogo do tenant, com fluxo operacional, permissões e APIs relacionadas à rota.
Permissões
documents.manage, tenant.users.manage, documents.read
Integração
6 endpoint(s) relacionados automaticamente à tela.
1
Entenda o objetivo da tela
Use Catálogo do tenant para consultar e operar o módulo documents dentro do escopo autorizado. Antes de agir, confirme o tenant, o registro e os filtros exibidos.
2
Localize a área de trabalho
Confirme o contexto, os filtros e o registro selecionado antes de prosseguir.
3
Execute somente a ação necessária
As principais ações identificadas são: Documentos gerais, Documentos do contrato, Documentos de faturamento, Criar, Salvar. Botões disponíveis continuam sujeitos às permissões e validações da API.
4
Confira o resultado
Revise mensagens, contagens e o registro afetado. Para suporte técnico, relacione a operação aos 6 endpoint(s) listados neste guia.
Áreas e ações
Elementos identificados na tela
Catálogo do tenant
Documentos gerais
Documentos do contrato
Documentos de faturamento
Criar
Salvar
Controle de acesso
Permissões e escopo
Permissões
documents.manage, tenant.users.manage, documents.read
Entitlements
Nenhum localizado
Módulo
documents
Interface → API
Rotas relacionadas ao fluxo
A correlação é feita a partir das chamadas encontradas na página. Componentes delegados podem adicionar outras rotas.
| Método | Endpoint | Finalidade | Permissão | Evidência |
|---|---|---|---|---|
| GET | /api/v1/documents | List | documents.read | 401 · limite de autenticação testado |
| DELETE | /api/v1/documents/:id | Delete | documents.manage | Código inspecionado; runtime não exercitado |
| PATCH | /api/v1/documents/:id | Update | documents.manage | Código inspecionado; runtime não exercitado |
| GET | /api/v1/documents/categories | List Categories | documents.read | Código inspecionado; runtime não exercitado |
| POST | /api/v1/documents/categories | Create Category | documents.read | Código inspecionado; runtime não exercitado |
| PATCH | /api/v1/documents/categories/:id | Update Category | documents.read | Código inspecionado; runtime não exercitado |
Limite de validação
Catálogo, grupos e regras dos tipos documentais foram inspecionados; nenhum tipo foi criado ou alterado.