pres:gerti:manuais:integracaoiagoxetce

Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

Link para esta página de comparações

Ambos lados da revisão anterior Revisão anterior
Próxima revisão		 Revisão anterior
pres:gerti:manuais:integracaoiagoxetce [24/09/2026 17:00] – rmpirespres:gerti:manuais:integracaoiagoxetce [24/09/2026 17:58] (atual) – [RN06 — Ementa] rmpires
Linha 1: Linha 1:
-====== Integração IAGO × eTCE — Criação de Peças/Minutas ======+====== IAGO-MinutAI — Endpoint de Criação de Peças/Minutas no eTCE ======
  
 ===== 1. Objetivo ===== ===== 1. Objetivo =====
  
-Este documento descreve a integração utilizada pelo **IAGO** para criação automática de peças no **eTCE-GO / TCE-Docs**, incluindo:+Este documento descreve a integração utilizada pelo **IAGO** para criação automática de peças no **eTCE-GO**, incluindo:
  
   * endpoint utilizado;   * endpoint utilizado;
Linha 16: Linha 16:
   * regras específicas da primeira versão da integração.   * regras específicas da primeira versão da integração.
  
-A finalidade do endpoint é permitir que uma peça produzida com apoio de Inteligência Artificial seja criada no TCE-Docs e vinculada ao último andamento do processo no setor informado.+A finalidade do endpoint é permitir que uma peça produzida com apoio de Inteligência Artificial seja criada no eTCE e vinculada ao último andamento do processo no setor informado.
  
 > **Importante:** a peça criada pelo IAGO deve ser considerada uma **minuta sujeita à revisão de um servidor**.  > **Importante:** a peça criada pelo IAGO deve ser considerada uma **minuta sujeita à revisão de um servidor**. 
Linha 67: Linha 67:
 ==== Descrição ==== ==== Descrição ====
  
-Cria o documento gerado pelo IAGO no **TCE-Docs** e vincula o documento ao **último andamento do processo**, considerando o processo, o setor informado e o usuário autenticado.+Cria o documento gerado pelo IAGO no **eTCE** e vincula o documento ao **último andamento do processo**, considerando o processo, o setor informado e o usuário autenticado.
  
 O endpoint centraliza as validações necessárias para a criação da peça. O endpoint centraliza as validações necessárias para a criação da peça.
Linha 149: Linha 149:
 { {
   "setorGeralId": 26,   "setorGeralId": 26,
-  "conversaId": 0, 
   "codigoProcesso": 202400047002057,   "codigoProcesso": 202400047002057,
   "tipoDocumento": "DP",   "tipoDocumento": "DP",
Linha 164: Linha 163:
 | ''tipoDocumento'' | Sim | Indicador do tipo de documento. Na primeira versão da integração deve ser utilizado ''DP'', correspondente a **Parecer**. | | ''tipoDocumento'' | Sim | Indicador do tipo de documento. Na primeira versão da integração deve ser utilizado ''DP'', correspondente a **Parecer**. |
 | ''corpoDocumento'' | Sim | Conteúdo da peça em HTML simples. | | ''corpoDocumento'' | Sim | Conteúdo da peça em HTML simples. |
-| ''conversaId'' | Não | Identificador da conversa do IAGO, utilizado para rastreabilidade quando informado. O valor ''0'' é aceito e tratado como não informado. | 
 | ''ementa'' | Não | Ementa que será associada ao documento. Quando informada, será utilizada na criação da peça; quando omitida, a API utiliza a ementa cadastrada na autuação do processo. | | ''ementa'' | Não | Ementa que será associada ao documento. Quando informada, será utilizada na criação da peça; quando omitida, a API utiliza a ementa cadastrada na autuação do processo. |
  
Linha 179: Linha 177:
 ===== 8. Regra da ementa ===== ===== 8. Regra da ementa =====
  
-O campo ''ementa'' é **opcional**.+O campo ''ementa'' da requisição é **opcional**.
  
-==== Quando a ementa é informada ====+Durante o processamento, a API também considera a ementa cadastrada na autuação do processo.
  
-A ementa do documento será gerada utilizando o conteúdo enviado na própria requisição:+A definição da ementa do documento ocorre da seguinte forma:
  
-<code json> +  * quando o campo ''ementa'' é informado na requisição, esse conteúdo será utilizado na peça; 
-{ +  * quando o campo ''ementa'' não é informado, será utilizada a ementa cadastrada na autuação.
-  "ementa": "Análise da prestação de contas..." +
-} +
-</code>+
  
-==== Quando a ementa não é informada ====+Para que a criação do documento seja concluída, o processo deve possuir ementa cadastrada na autuação.
  
-A API busca a ementa cadastrada no processo, proveniente do cadastro da **autuação**. +Caso essa informação não esteja preenchida, a API retorna:
- +
-A prioridade para definição da ementa é: +
- +
-  - ementa informada no body da requisição; +
-  - ementa cadastrada na autuação do processo. +
- +
-Se nenhuma ementa estiver disponível para ser utilizada, a criação não poderá prosseguir. +
- +
-Retorno:+
  
 <code json> <code json>
Linha 216: Linha 202:
 </code> </code>
  
-> Se uma ''ementa'' válida for enviada diretamente na requisição, ela será utilizada. Caso contrário, será utilizada a ementa cadastrada na autuação. +^ Campo ''ementa'' no endpoint ^ Ementa utilizada no documento ^ 
 +| Informado | Conteúdo enviado na requisição | 
 +| Não informado | Ementa cadastrada na autuação |
 ---- ----
  
Linha 374: Linha 361:
 ==== RN06 — Ementa ==== ==== RN06 — Ementa ====
  
-A ementa utilizada no documento segue a seguinte prioridade:+Aplica-se a regra descrita no tópico **8. Regra da ementa**:
  
-  - ''ementa'' informada no body da requisição; +  * se ''ementa'' for informada na requisição, esse conteúdo será utilizado no documento; 
-  - ementa cadastrada na autuação do processo. +  * se não for informada, será utilizada a ementa cadastrada na autuação; 
- +  * em ambos os casos, o processo deve possuir ementa cadastrada na autuação para que a criação seja concluída.
-Caso não exista uma ementa válida disponível, a criação é interrompida.+
  
 ---- ----
Linha 590: Linha 576:
 </code> </code>
  
-==== conversaId ==== 
  
-O campo não é obrigatório. 
- 
-São permitidos: 
- 
-  * atributo não informado; 
-  * ''conversaId = 0''. 
- 
----- 
  
 ===== 13. Exemplo de requisição ===== ===== 13. Exemplo de requisição =====
Linha 611: Linha 588:
   --data '{   --data '{
     "setorGeralId": 26,     "setorGeralId": 26,
-    "conversaId": 0, 
     "codigoProcesso": 202400047002057,     "codigoProcesso": 202400047002057,
     "tipoDocumento": "DP",     "tipoDocumento": "DP",
Linha 701: Linha 677:
 | ''corpoDocumento'' vazio ou ''null'' | ''400'' | | ''corpoDocumento'' vazio ou ''null'' | ''400'' |
 | HTML inválido/tags vazias | ''400'' | | HTML inválido/tags vazias | ''400'' |
-| ''conversaId'' ausente | Permitido | +
-| ''conversaId = 0'' | Permitido |+
  
 ---- ----
Linha 733: Linha 708:
   * enviar HTML válido e não vazio em ''corpoDocumento'';   * enviar HTML válido e não vazio em ''corpoDocumento'';
   * enviar ''ementa'' quando o IAGO possuir uma ementa específica para a peça;   * enviar ''ementa'' quando o IAGO possuir uma ementa específica para a peça;
-  * utilizar ''conversaId'' quando houver necessidade de rastreabilidade da interação; 
   * tratar ''409'' e ''422'' como respostas funcionais de regra de negócio/validação;   * tratar ''409'' e ''422'' como respostas funcionais de regra de negócio/validação;
   * não realizar substituição forçada quando a API indicar alteração humana, assinatura ou edição do documento.   * não realizar substituição forçada quando a API indicar alteração humana, assinatura ou edição do documento.
  
 ---- ----
  • pres/gerti/manuais/integracaoiagoxetce.1790269256.txt.gz
  • Última modificação: 24/09/2026 17:00
  • por rmpires