Manual de Desenvolvimento - Conversor de dados para DataJud

1. Introdução

Instituída pela Resolução CNJ nº 331/2020, a Base Nacional de Dados do Poder Judiciário - DataJud é responsável pelo armazenamento centralizado dos dados e metadados processuais de todos os processos físicos ou eletrônicos, públicos ou sigilosos, dos tribunais sob competência do Conselho Nacional de Justiça - CNJ. A Datajud trouxe inovações como a possibilidade dos dados serem disponibilizados por meio de API pública, resguardados o sigilo e a confidencialidade das informações.

Os metadados processuais são encaminhados pelos tribunais a DataJud conforme Modelo de Transmissão de Dados – MTD, baseado no Modelo Nacional de Interoperabilidade – MNI do Poder Judiciário. Além disso, os tribunais devem observar os códigos vinculados às classes, aos assuntos, aos movimentos e aos documentos nas Tabelas Processuais Unificadas - TPU.

O presente documento tem por finalidade apresentar as instruções de desenvolvimento de versão customizada do conversor de dados (API Rest), sendo o micro-serviço responsável por converter os dados dos sistemas processuais para a API da Plataforma Codex, ferramenta oficial de extração de dados estruturados e não estruturados dos processos judiciais eletrônicos em tramitação no Poder Judiciário. Por meio do Codex a Datajud é alimentada de forma automatizada e transforma as decisões e petições em texto puro, para fins de insumo à pesquisas, relatórios estatísticos e modelos de IA.

Voltar ao topo

2. Primeiros passos

Acesso ao projeto no repositório Git/CNJ

O desenvolvedor deve solicitar acesso ao projeto Conversor no repositório GIT do CNJ, no qual é sugerida a criação de branch a partir da branch alpha do conversor do PJe para iniciar a customização.

Projeto Conversor

Acesso aos pacotes no Nexus CNJ

Na sequência o desenvolvedor deve solicitar acesso ao Nexus, local de armazenamento dos pacotes de desenvolvimento do conversor e do extrator de dados.

Nexus

Voltar ao topo

3. Roteiro de Desenvolvimento

3.1. Propriedades de configuração

As variáveis abaixo serão configuradas conforme sua infra-estrutura:

Propriedade de configuração	Tipo de dados	Valor
aplicacao.tipo-storage	String	Define se o tipo de armazenamento é JCR (Padrão) ou LOCAL. Quando o valor for "LOCAL", o volume com o storage deverá ser montado em: "/opt/app/storage".
aplicacao.jcr.url	String	Quando o tipo for JCR, deverá estar preenchido com a url do JCR.
aplicacao.jcr.usuario	String	Quando o tipo for JCR, deverá estar preenchido com o usuário do JCR que tenha privilégio de leitura.
aplicacao.jcr.senha	String	Quando o tipo for JCR, deverá estar preenchido com a senha do JCR.
quarkus.datasource.conversor.jdbc.url	String	Endereço de acesso ao banco do sistema processual.
quarkus.datasource.conversor.username	String	Usuário com privilégio de leitura e escrita.
quarkus.datasource.conversor.password	String	Senha de acesso do usuário de banco de dados.
quarkus.datasource.conversor-sl.jdbc.url	String	Endereço de acesso à replica de "somente leitura" do banco do sistema processual.
quarkus.datasource.conversor-sl.username	String	Usuário com privilégio de leitura.
quarkus.datasource.conversor-sl.password	String	Senha de acesso do usuário de banco de dados.

Propriedade de configuração

Tipo de dados

Valor

aplicacao.tipo-storage

String

Define se o tipo de armazenamento é JCR (Padrão) ou LOCAL. Quando o valor for "LOCAL", o volume com o storage deverá ser montado em: "/opt/app/storage".

aplicacao.jcr.url

String

Quando o tipo for JCR, deverá estar preenchido com a url do JCR.

aplicacao.jcr.usuario

String

Quando o tipo for JCR, deverá estar preenchido com o usuário do JCR que tenha privilégio de leitura.

aplicacao.jcr.senha

String

Quando o tipo for JCR, deverá estar preenchido com a senha do JCR.

quarkus.datasource.conversor.jdbc.url

String

Endereço de acesso ao banco do sistema processual.

quarkus.datasource.conversor.username

String

Usuário com privilégio de leitura e escrita.

quarkus.datasource.conversor.password

String

Senha de acesso do usuário de banco de dados.

quarkus.datasource.conversor-sl.jdbc.url

String

Endereço de acesso à replica de "somente leitura" do banco do sistema processual.

quarkus.datasource.conversor-sl.username

String

Usuário com privilégio de leitura.

quarkus.datasource.conversor-sl.password

String

Senha de acesso do usuário de banco de dados.

Voltar ao topo

3.2. Configuração do Banco de Dados

-- *********************************************************************
-- Update Database Script
-- *********************************************************************
-- Change Log: bd/changelog/changelog-master.yaml
-- Ran at: 21/06/2022 14:29
-- Against: extrator@offline:postgresql?changeLogFile=/tmp/1655832491.csv
-- Liquibase version: 4.2.2
-- *********************************************************************

-- Changeset bd/changelog/migrations/001-create_user_schema_grants.yml::1::Alcides Campos
CREATE SCHEMA IF NOT EXISTS extrator;

-- extrator_apl_master
CREATE USER extrator_apl_master WITH ENCRYPTED PASSWORD 'extrator_apl_master';

GRANT USAGE ON SCHEMA extrator TO extrator_apl_master;

GRANT DELETE ON ALL TABLES IN SCHEMA extrator TO extrator_apl_master;

ALTER DEFAULT PRIVILEGES IN SCHEMA extrator GRANT DELETE ON TABLES TO extrator_apl_master;

-- extrator_apl_replica
CREATE USER extrator_apl_replica WITH ENCRYPTED PASSWORD 'extrator_apl_replica';

GRANT USAGE ON SCHEMA acl, client, core, extrator, public TO extrator_apl_replica;

GRANT SELECT ON ALL TABLES IN SCHEMA acl, client, core, extrator, public TO extrator_apl_replica;

ALTER DEFAULT PRIVILEGES IN SCHEMA acl, client, core, extrator, public GRANT SELECT ON TABLES TO extrator_apl_replica;

/**
  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

  PG_HBA.CONF

   Caso sua infraestrutura tenha a arquitetura master e replica do postgresql:

    - Servidor Master: Liberar acesso somente ao usuario extrator_apl_master
    - Servidor Replica: Liberar acesso somente ao usuario extrator_apl_replica

   Senão:
    - Servidor Master: Liberar acesso aos usuarios extrator_apl_master e extrator_apl_replica
 */;

-- Changeset bd/changelog/migrations/002-processo-alteracao.yml::2::Alcides Campos
CREATE TABLE EXTRATOR.PROCESSO_ALTERACAO (ID BIGINT NOT NULL, TIPO VARCHAR(18) NOT NULL, CATEGORIA VARCHAR(18) NOT NULL, DATA TIMESTAMP WITHOUT TIME ZONE DEFAULT NOW() NOT NULL);

-- Changeset bd/changelog/migrations/003-pessoa-alteracao.yml::3::Alcides Campos
CREATE TABLE EXTRATOR.PESSOA_ALTERACAO (ID BIGINT NOT NULL, TIPO VARCHAR(18) NOT NULL, CATEGORIA VARCHAR(18) NOT NULL, DATA TIMESTAMP WITHOUT TIME ZONE DEFAULT NOW() NOT NULL);

-- Changeset bd/changelog/migrations/004-fc_tipo_alteracao.yml::4::Alcides Campos
CREATE FUNCTION extrator.fc_tipo_alteracao(tg_op varchar) returns varchar AS
$BODY$
DECLARE
        resultado varchar;

BEGIN
        IF (tg_op = 'INSERT')
        THEN
                resultado := 'INSERCAO';

ELSIF (tg_op = 'UPDATE')
        THEN
                resultado := 'ALTERACAO';

ELSE
                resultado := 'EXCLUSAO';

END IF;

RETURN resultado;

END
$BODY$
LANGUAGE 'plpgsql';

-- Changeset bd/changelog/migrations/005-triggers_de_monitoramento.yml::5::Alcides Campos
CREATE FUNCTION extrator.fc_tb_processo_trf_alteracao_metadados() RETURNS trigger AS
$BODY$
DECLARE
        id int8;

tipo varchar := extrator.fc_tipo_alteracao(TG_OP);

categoria varchar := 'METADADOS';

BEGIN

        IF (TG_OP = 'INSERT')
        THEN
                id := NEW.id_processo_trf;

ELSE
                id := OLD.id_processo_trf;

END IF;

INSERT INTO extrator.processo_alteracao VALUES (id, tipo, categoria, now());

RETURN NULL;

END
$BODY$
LANGUAGE 'plpgsql';

CREATE TRIGGER trg_tb_processo_trf_alteracao_metadados
    AFTER INSERT OR UPDATE OR DELETE
    ON client.tb_processo_trf
    FOR EACH ROW
    EXECUTE PROCEDURE extrator.fc_tb_processo_trf_alteracao_metadados();

CREATE FUNCTION extrator.fc_tb_processo_assunto_alteracao_metadados() RETURNS trigger AS
$BODY$
DECLARE
        id int8;

tipo varchar := extrator.fc_tipo_alteracao(TG_OP);

categoria varchar := 'METADADOS';

BEGIN

        IF (TG_OP = 'INSERT')
        THEN
                id := NEW.id_processo_trf;

ELSE
                id := OLD.id_processo_trf;

END IF;

INSERT INTO extrator.processo_alteracao VALUES (id, tipo, categoria, now());

RETURN NULL;

END
$BODY$
LANGUAGE 'plpgsql';

CREATE TRIGGER trg_tb_processo_assunto_alteracao_metadados
    AFTER INSERT OR UPDATE OR DELETE
    ON client.tb_processo_assunto
    FOR EACH ROW
    EXECUTE PROCEDURE extrator.fc_tb_processo_assunto_alteracao_metadados();

CREATE FUNCTION extrator.fc_tb_processo_documento_alteracao_documentos() RETURNS trigger AS
$BODY$
DECLARE
        id int8;

tipo varchar := extrator.fc_tipo_alteracao(TG_OP);

categoria varchar := 'DOCUMENTOS';

BEGIN

        IF (TG_OP = 'INSERT')
        THEN
                id := NEW.id_processo;

ELSE
                id := OLD.id_processo;

END IF;

INSERT INTO extrator.processo_alteracao VALUES (id, tipo, categoria, now());

RETURN NULL;

END
$BODY$
LANGUAGE 'plpgsql';

CREATE TRIGGER trg_tb_processo_documento_alteracao_documentos
    AFTER INSERT OR UPDATE OR DELETE
    ON core.tb_processo_documento
    FOR EACH ROW
    EXECUTE PROCEDURE extrator.fc_tb_processo_documento_alteracao_documentos();

CREATE FUNCTION extrator.fc_tb_processo_movimento_alteracao_movimentos() RETURNS trigger AS
$BODY$
DECLARE
        id int8;

tipo varchar := extrator.fc_tipo_alteracao(TG_OP);

categoria varchar := 'MOVIMENTOS';

BEGIN

        IF (TG_OP = 'INSERT')
        THEN
                id := NEW.id_processo;

ELSE
                id := OLD.id_processo;

END IF;

INSERT INTO extrator.processo_alteracao VALUES (id, tipo, categoria, now());

RETURN NULL;

END
$BODY$
LANGUAGE 'plpgsql';

CREATE TRIGGER trg_tb_processo_movimento_alteracao_movimentos
    AFTER INSERT OR UPDATE OR DELETE
    ON core.tb_processo_evento
    FOR EACH ROW
    EXECUTE PROCEDURE extrator.fc_tb_processo_movimento_alteracao_movimentos();

CREATE FUNCTION extrator.fc_tb_processo_parte_alteracao_partes() RETURNS trigger AS
$BODY$
DECLARE
        id int8;

tipo varchar := extrator.fc_tipo_alteracao(TG_OP);

categoria varchar := 'PARTES';

BEGIN

        IF (TG_OP = 'INSERT')
        THEN
                id := NEW.id_processo_trf;

ELSE
                id := OLD.id_processo_trf;

END IF;

INSERT INTO extrator.processo_alteracao VALUES (id, tipo, categoria, now());

RETURN NULL;

END
$BODY$
LANGUAGE 'plpgsql';

CREATE TRIGGER trg_tb_processo_parte_alteracao_partes
    AFTER INSERT OR UPDATE OR DELETE
    ON client.tb_processo_parte
    FOR EACH ROW
    EXECUTE PROCEDURE extrator.fc_tb_processo_parte_alteracao_partes();

CREATE FUNCTION extrator.fc_tb_processo_trf_conexao_alteracao_metadados() RETURNS trigger AS
$BODY$
DECLARE
        id int8;

tipo varchar := extrator.fc_tipo_alteracao(TG_OP);

categoria varchar := 'METADADOS';

BEGIN

        IF (TG_OP = 'INSERT')
        THEN
                id := NEW.id_processo_trf;

ELSE
                id := OLD.id_processo_trf;

END IF;

INSERT INTO extrator.processo_alteracao VALUES (id, tipo, categoria, now());

RETURN NULL;

END
$BODY$
LANGUAGE 'plpgsql';

CREATE TRIGGER trg_tb_processo_trf_conexao_alteracao_metadados
    AFTER INSERT OR UPDATE OR DELETE
    ON client.tb_processo_trf_conexao
    FOR EACH ROW
    EXECUTE PROCEDURE extrator.fc_tb_processo_trf_conexao_alteracao_metadados();

CREATE FUNCTION extrator.fc_tb_usuario_login_alteracao_metadados() RETURNS trigger AS
$BODY$
DECLARE
        id int8;

tipo varchar := extrator.fc_tipo_alteracao(TG_OP);

categoria varchar := 'METADADOS';

BEGIN

        IF (TG_OP = 'INSERT')
        THEN
                id := NEW.id_usuario;

ELSE
                id := OLD.id_usuario;

END IF;

INSERT INTO extrator.pessoa_alteracao VALUES (id, tipo, categoria, now());

RETURN NULL;

END
$BODY$
LANGUAGE 'plpgsql';

CREATE TRIGGER trg_tb_usuario_login_alteracao_metadados
    AFTER INSERT OR UPDATE OR DELETE
    ON acl.tb_usuario_login
    FOR EACH ROW
    EXECUTE PROCEDURE extrator.fc_tb_usuario_login_alteracao_metadados();

CREATE FUNCTION extrator.fc_tb_pessoa_alteracao_metadados() RETURNS trigger AS
$BODY$
DECLARE
        id int8;

tipo varchar := extrator.fc_tipo_alteracao(TG_OP);

categoria varchar := 'METADADOS';

BEGIN

        IF (TG_OP = 'INSERT')
        THEN
                id := NEW.id_pessoa;

ELSE
                id := OLD.id_pessoa;

END IF;

INSERT INTO extrator.pessoa_alteracao VALUES (id, tipo, categoria, now());

RETURN NULL;

END
$BODY$
LANGUAGE 'plpgsql';

CREATE TRIGGER trg_tb_pessoa_alteracao_metadados
    AFTER INSERT OR UPDATE OR DELETE
    ON client.tb_pessoa
    FOR EACH ROW
    EXECUTE PROCEDURE extrator.fc_tb_pessoa_alteracao_metadados();

CREATE FUNCTION extrator.fc_tb_pessoa_fisica_alteracao_metadados() RETURNS trigger AS
$BODY$
DECLARE
        id int8;

tipo varchar := extrator.fc_tipo_alteracao(TG_OP);

categoria varchar := 'METADADOS';

BEGIN

        IF (TG_OP = 'INSERT')
        THEN
                id := NEW.id_pessoa_fisica;

ELSE
                id := OLD.id_pessoa_fisica;

END IF;

INSERT INTO extrator.pessoa_alteracao VALUES (id, tipo, categoria, now());

RETURN NULL;

END
$BODY$
LANGUAGE 'plpgsql';

CREATE TRIGGER trg_tb_pessoa_fisica_alteracao_metadados
    AFTER INSERT OR UPDATE OR DELETE
    ON client.tb_pessoa_fisica
    FOR EACH ROW
    EXECUTE PROCEDURE extrator.fc_tb_pessoa_fisica_alteracao_metadados();

CREATE FUNCTION extrator.fc_tb_pessoa_juridica_alteracao_metadados() RETURNS trigger AS
$BODY$
DECLARE
        id int8;

tipo varchar := extrator.fc_tipo_alteracao(TG_OP);

categoria varchar := 'METADADOS';

BEGIN

        IF (TG_OP = 'INSERT')
        THEN
                id := NEW.id_pessoa_juridica;

ELSE
                id := OLD.id_pessoa_juridica;

END IF;

INSERT INTO extrator.pessoa_alteracao VALUES (id, tipo, categoria, now());

RETURN NULL;

END
$BODY$
LANGUAGE 'plpgsql';

CREATE TRIGGER trg_tb_pessoa_juridica_alteracao_metadados
    AFTER INSERT OR UPDATE OR DELETE
    ON client.tb_pessoa_juridica
    FOR EACH ROW
    EXECUTE PROCEDURE extrator.fc_tb_pessoa_juridica_alteracao_metadados();

CREATE FUNCTION extrator.fc_tb_pessoa_autoridade_alteracao_metadados() RETURNS trigger AS
$BODY$
DECLARE
        id int8;

tipo varchar := extrator.fc_tipo_alteracao(TG_OP);

categoria varchar := 'METADADOS';

BEGIN

        IF (TG_OP = 'INSERT')
        THEN
                id := NEW.id_pessoa_autoridade;

ELSE
                id := OLD.id_pessoa_autoridade;

END IF;

INSERT INTO extrator.pessoa_alteracao VALUES (id, tipo, categoria, now());

RETURN NULL;

END
$BODY$
LANGUAGE 'plpgsql';

CREATE TRIGGER trg_tb_pessoa_autoridade_alteracao_metadados
    AFTER INSERT OR UPDATE OR DELETE
    ON client.tb_pessoa_autoridade
    FOR EACH ROW
    EXECUTE PROCEDURE extrator.fc_tb_pessoa_autoridade_alteracao_metadados();

CREATE FUNCTION extrator.fc_tb_endereco_alteracao_enderecos() RETURNS trigger AS
$BODY$
DECLARE
        id int8;

tipo varchar := extrator.fc_tipo_alteracao(TG_OP);

categoria varchar := 'ENDERECOS';

BEGIN

        IF (TG_OP = 'INSERT')
        THEN
                id := NEW.id_usuario;

ELSE
                id := OLD.id_usuario;

END IF;

IF id IS NOT NULL
        THEN
                INSERT INTO extrator.pessoa_alteracao VALUES (id, tipo, categoria, now());

END IF;

RETURN NULL;

END
$BODY$
LANGUAGE 'plpgsql';

CREATE TRIGGER trg_tb_endereco_alteracao_enderecos
    AFTER INSERT OR UPDATE OR DELETE
    ON core.tb_endereco
    FOR EACH ROW
    EXECUTE PROCEDURE extrator.fc_tb_endereco_alteracao_enderecos();

CREATE FUNCTION extrator.fc_tb_pess_doc_identificacao_alteracao_documentos() RETURNS trigger AS
$BODY$
DECLARE
        id int8;

tipo varchar := extrator.fc_tipo_alteracao(TG_OP);

categoria varchar := 'DOCUMENTOS';

BEGIN

        IF (TG_OP = 'INSERT')
        THEN
                id := NEW.id_pessoa;

ELSE
                id := OLD.id_pessoa;

END IF;

INSERT INTO extrator.pessoa_alteracao VALUES (id, tipo, categoria, now());

RETURN NULL;

END
$BODY$
LANGUAGE 'plpgsql';

CREATE TRIGGER trg_tb_pess_doc_identificacao_alteracao_documentos
    AFTER INSERT OR UPDATE OR DELETE
    ON client.tb_pess_doc_identificacao
    FOR EACH ROW
    EXECUTE PROCEDURE extrator.fc_tb_pess_doc_identificacao_alteracao_documentos();

CREATE FUNCTION extrator.fc_tb_pessoa_nome_alternativo_alteracao_outros_nomes() RETURNS trigger AS
$BODY$
DECLARE
        id int8;

tipo varchar := extrator.fc_tipo_alteracao(TG_OP);

categoria varchar := 'OUTROS_NOMES';

BEGIN

        IF (TG_OP = 'INSERT')
        THEN
                id := NEW.id_pessoa;

ELSE
                id := OLD.id_pessoa;

END IF;

INSERT INTO extrator.pessoa_alteracao VALUES (id, tipo, categoria, now());

RETURN NULL;

END
$BODY$
LANGUAGE 'plpgsql';

CREATE TRIGGER trg_tb_pessoa_nome_alternativo_alteracao_outros_nomes
    AFTER INSERT OR UPDATE OR DELETE
    ON client.tb_pessoa_nome_alternativo
    FOR EACH ROW
    EXECUTE PROCEDURE extrator.fc_tb_pessoa_nome_alternativo_alteracao_outros_nomes();

CREATE FUNCTION extrator.fc_tb_relacao_pessoal_alteracao_relacionamentos() RETURNS trigger AS
$BODY$
DECLARE
        id int8;

tipo varchar := extrator.fc_tipo_alteracao(TG_OP);

categoria varchar := 'RELACIONAMENTOS';

BEGIN

        IF (TG_OP = 'INSERT')
        THEN
                id := NEW.id_representante;

ELSE
                id := OLD.id_representante;

END IF;

INSERT INTO extrator.pessoa_alteracao VALUES (id, tipo, categoria, now());

RETURN NULL;

END
$BODY$
LANGUAGE 'plpgsql';

CREATE TRIGGER trg_tb_relacao_pessoal_alteracao_relacionamentos
    AFTER INSERT OR UPDATE OR DELETE
    ON client.tb_relacao_pessoal
    FOR EACH ROW
    EXECUTE PROCEDURE extrator.fc_tb_relacao_pessoal_alteracao_relacionamentos();

-- Changeset bd/changelog/migrations/006-carga_inicial_processo_alteracao.yml::6::Alcides Campos
INSERT INTO extrator.processo_alteracao SELECT id_processo_trf, 'INSERCAO', 'METADADOS', now() FROM client.tb_processo_trf;

-- Changeset bd/changelog/migrations/007-carga_inicial_pessoa_alteracao.yml::1::Alcides Campos
INSERT INTO extrator.pessoa_alteracao SELECT id_pessoa, 'INSERCAO', 'METADADOS', now() FROM client.tb_pessoa;

-- Changeset bd/changelog/migrations/008-dar_permissao_para_triggers_functions.yml::8::Pablo Filetti Moreira
-- Alterar para os usuarios da aplicacao do PJe
GRANT ALL PRIVILEGES ON SCHEMA extrator TO $usuariopje;

GRANT USAGE ON SCHEMA extrator TO $usuariopje;

GRANT SELECT,INSERT,UPDATE,DELETE ON ALL TABLES IN SCHEMA extrator TO $usuariopje;

GRANT SELECT,USAGE,UPDATE ON ALL SEQUENCES IN SCHEMA extrator TO $usuariopje;

GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA extrator TO $usuariopje;

-- Changeset bd/changelog/migrations/009-criar_coluna_cd_orgao_julgador_nacional.yml::9::Alcides Campos
-- Cria a coluna cd_orgao_julgador_nacional na tabela tb_orgao_julgador caso não exista
DO $$
   BEGIN
       BEGIN
           ALTER TABLE client.tb_orgao_julgador ADD COLUMN cd_orgao_julgador_nacional int8 NULL;

EXCEPTION
           WHEN duplicate_column THEN RAISE NOTICE 'column cd_orgao_julgador_nacional already exists in tb_orgao_julgador.';

END;

END;

$$;

-- Changeset bd/changelog/migrations/010-add_idx_pessoa_alteracao_processo_alteracao.yml::10::Pablo Filetti Moreira
CREATE INDEX IDX_PESSOA_ALTERACAO_ID ON EXTRATOR.PESSOA_ALTERACAO(ID);

CREATE INDEX IDX_PROCESSO_ALTERACAO_ID ON EXTRATOR.PROCESSO_ALTERACAO(ID);

Para acompanhar as atualizações, melhorias e evoluções na estrutura do banco de dados proposta pelo conversor do PJe, confira o Guia de Migração.

Voltar ao topo

3.3. Customizar os serviços da API: ExtratorMetadadosBasicoImpl

recuperarCompetencias

Parâmetros de entrada

Sem parâmetros de entrada.

Resposta esperada da API

[
  {
    "id": "string", (1)
    "nome": "string",
    "orgaoJusticaId": "integer" (nullable: true) (2)
  }
]

1	Este atributo deverá ser uma FK do atributo competenciaId da entidade Processo.
2	Atributo opcional, somente deverá ser fornecido caso o sistema processual tenha dados de vários tribunais.

Exemplo de customização

[
  {
    "id": "2",
    "nome": "Plenário",
    "orgaoJusticaId": null
  },
  {
    "id": "3",
    "nome": "Presidência",
    "orgaoJusticaId": null
  },
  {
    "id": "4",
    "nome": "Vara de Execução em Meio Fechado e Semiaberto",
    "orgaoJusticaId": 10
  },
]

recuperarTiposParte

Parâmetros de entrada

Sem parâmetros de entrada.

Resposta esperada da API

[
  {
    "id": "string", (1)
    "nome": "string"
  }
]

1	Este atributo deverá ser uma FK do atributo tipoId da entidade ProcessoParte.

Exemplo de customização

[
  {
    "id": "0",
    "nome": "ATIVO"
  },
  {
    "id": "1",
    "nome": "PASSIVO"
  },
  {
    "id": "2",
    "nome": "VÍTIMA"
  },
  {
    "id": "3",
    "nome": "TESTEMUNHA"
  },
  {
    "id": "5",
    "nome": "SENTENCIADO"
  },
]

recuperarTiposProcessoDocumento

Parâmetros de entrada

Sem parâmetros de entrada.

Resposta esperada da API

[
  {
    "id": "string", (1)
    "nome": "string"
  }
]

1	Este atributo deverá ser uma FK do atributo tipoId da entidade ProcessoDocumento.

Exemplo de customização

[
  {
    "id": "2",
    "nome": "Citação"
  },
  {
    "id": "3",
    "nome": "Conclusão"
  },
  {
    "id": "5",
    "nome": "Intimação"
  },
  {
    "id": "32",
    "nome": "Procuração"
  },
]

recuperarOrgaosJulgadores

Parâmetros de entrada

Sem parâmetros de entrada.

Resposta esperada da API

[
  {
    "id": "string", (1)
    "instancia": "string" Enum:["PRIMEIRO_GRAU", "QUARTO_GRAU", "SEGUNDO_GRAU", "TERCEIRO_GRAU"],
    "nome": "string",
    "orgaoJulgadorNacionalId": "integer" (nullable: true) (2)
  }
]

1	Este atributo deverá ser uma FK do atributo orgaoJulgadorId da entidade Processo.
2	Define o DE-PARA entre o id local e nacional do CNJ (conforme o sistema corporativo). Caso não seja fornecido na carga inicial, deverá ser mapeado via interface do Codex posteriormente.

Exemplo de customização

[
  {
    "id": "2",
    "nome": "Presidência",
    "instancia": "PRIMEIRO_GRAU",
    "orgaoJulgadorNacionalId": 102021
  },
  {
    "id": "15967",
    "nome": "GMF - TJPA",
    "instancia": "PRIMEIRO_GRAU",
    "orgaoJulgadorNacionalId": 0
  },
  {
    "id": "15837",
    "nome": "TJAL - Atalaia - Meio Aberto",
    "instancia": "SEGUNDO_GRAU",
    "orgaoJulgadorNacionalId": 5913
]

recuperarOrgaosJulgadoresColegiados

Parâmetros de entrada

Sem parâmetros de entrada.

Resposta esperada da API

[
  {
    "id": "string", (1)
    "nome": "string",
    "orgaoJusticaId": "integer" (nullable: true) (2)
  }
]

1	Este atributo deverá ser uma FK do atributo orgaoJulgadorColegiadoId da entidade Processo.
2	Atributo opcional, somente deverá ser fornecido caso o sistema processual tenha dados de vários tribunais.

Exemplo de customização

[
  {
    "id": "2",
    "nome": "Plenário",
    "orgaoJusticaId": null
  },
  {
    "id": "3",
    "nome": "Comissão de Acesso à Justiça e à Cidadania",
    "orgaoJusticaId": null
  },
]

Voltar ao topo

3.4. Customizar os serviços da API: ConversorImpl

ConversorImpl.recuperarPessoasMetadadosPorIds

Parâmetros de entrada
Parâmetro	Tipo de Dados	Descrição
incluirEnderecos	Boolean	True or false
incluirOutrosNomes	Boolean	True or false
incluirRelacionamentos	Boolean	True or false

Resposta esperada da API

[
  {
    "documentos": [
      {
        "dataExpedicao": "string" (nullable: true),
        "id": "string",
        "nome": "string" (nullable: true),
        "numero": "string",
        "orgaoExpedidor": "string" (nullable: true),
        "orgaoExpedidorUnidadeFederativa": "string" Enum:["AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO"] (nullable: true),
        "tipo": "string" Enum:["CC", "CEI", "CI", "CN", "CNH", "CNPJ", "CP", "CPF", "CT", "IF", "NB", "NIT", "OAB", "OUTROS", "PAS", "PIS_PASEP", "RGE", "RIC", "RJC", "RJI", "TE"]
      }
    ],
    "enderecos": {} (nullable: true),
    "fisica": {
      "dataNascimento": "string" (nullable: true),
      "dataObito": "string" (nullable: true),
      "genitores": [
        {
          "id": "string",
          "nome": "string",
          "sexo": "string" Enum:["FEMININO", "MASCULINO", "OUTROS"]
        }
      ],
      "nacionalidade": {
        "id": "integer" (nullable: true),
        "nome": "string" (nullable: true),
        "sigla": "string" (nullable: true)
      } (nullable: true),
      "naturalidade": {
        "id": "integer" (nullable: true),
        "nome": "string" (nullable: true),
        "unidadeFederativa": "string" Enum:["AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO"]
      } (nullable: true),
      "sexo": "string" Enum:["FEMININO", "MASCULINO", "OUTROS"] (nullable: true)
    },
    "id": "string",
    "juridica": {
      "dataAbertura": "string" (nullable: true),
      "dataEncerramento": "string" (nullable: true),
      "nomeFantasia": "string" (nullable: true)
    },
    "nome": "string",
    "outrosNomes": {} (nullable: true),
    "relacionamentos": {} (nullable: true),
    "tipo": "string" Enum:["AUTORIDADE", "ENTE_DESPERSONALIZADO", "FISICA", "JURIDICA", "ORGAO_REPRESENTACAO"]
  }
]

ConversorImpl.recuperarProcessoMetadadosPorProcessoId

Parâmetros de entrada
Parâmetro	Tipo de Dados	Descrição
processoId	String	Id do processo no sistema processual
incluirDocumentos	Boolean	True or false
incluirMovimentos	Boolean	True or false
incluirPartes	Boolean	True or false
incluirRelacionamentos	Boolean	True or false

Resposta esperada da API

{
  "id": "string",
  "numero": "string",
  "classeId": "integer",
  "assuntoPrincipalId": "string" (nullable: true),
  "dataAjuizamento": "string",
  "dataDistribuicao": "string",
  "justicaGratuita": "boolean",
  "nivelSigilo": "string" Enum:["PUBLICO", "SEGREDO_JUSTICA", "SIGILO_ABSOLUTO", "SIGILO_INTENSO", "SIGILO_MEDIO", "SIGILO_MINIMO"],
  "liminar": "boolean",
  "valorCausa": "number" (nullable: true),
  "instancia": "string" Enum:["PRIMEIRO_GRAU", "QUARTO_GRAU", "SEGUNDO_GRAU", "TERCEIRO_GRAU"],
  "natureza": "string" Enum:["CIVEL", "CRIMINAL", "ELEITORAL", "FISCAL", "INDEFINIDA", "MILITAR", "TRABALHISTA"],
  "tipoJustica": "string" Enum:["COMUM", "ESPECIAL", "INDEFINIDO"],
  "orgaoJulgadorId": "string",
  "orgaoJulgadorColegiadoId": "string",
  "competenciaId": "string",
  "situacaoMigracao": "string" Enum:["EMIGRANTE", "IMIGRANTE", "NATIVO"],
  "assuntos": [
    {
      "id": "string",
      "assunto": {
        "nacional": {
          "id": "integer"
        } (nullable: true),
        "local": {
          "descricao": "string",
          "id": "string",
          "paiNacionalId": "integer"
        } (nullable: true),
        "definidoLocal": "boolean",
        "definidoNacional": "boolean"
      },
    }
  ],
  "documentos": {
    "id": "string",
    "nome": "string",
    "dataJuntada": "string",
    "dataExclusao": "string" (nullable: true),
    "pai": "string" (nullable: true),
    "tipoId": "string" (nullable: true),
    "nivelSigilo": "string" Enum:["PUBLICO", "SEGREDO_JUSTICA", "SIGILO_ABSOLUTO", "SIGILO_INTENSO", "SIGILO_MEDIO", "SIGILO_MINIMO"],
    "signatarios": "string" (nullable: true)
    } (nullable: true),
  "movimentos": {
    "id": "string",
    "data": "string",
    "dataExclusao": "string" (nullable: true),
    "tipo": {
      "nacional": {
        "id": "integer"
      } (nullable: true),
      "local": {
        "descricao": "string",
        "id": "string",
        "paiNacionalId": "integer"
      } (nullable: true),
    },
    "descricao": "string",
    "documento": {
      "dataExclusao": "string" (nullable: true),
      "dataJuntada": "string",
      "id": "string",
      "nivelSigilo": "string" Enum:["PUBLICO", "SEGREDO_JUSTICA", "SIGILO_ABSOLUTO", "SIGILO_INTENSO", "SIGILO_MEDIO", "SIGILO_MINIMO"],
      "nome": "string",
      "pai": "string" (nullable: true),
      "signatarios": "string" (nullable: true),
      "tipoId": "string"
    } (nullable: true),
    "magistradoCpf": "string" (nullable: true),
    "usuario": "string" (nullable: true),
    "complementos": [
      {
        "id": "string",
        "tipoId": "integer",
        "valor": "string",
        "tabeladoId": "integer" (nullable: true)
      }
    ],
  } (nullable: true),
  "partes": {
    "id": "string",
    "pessoa": {
      "id": "string",
      "nome": "string",
      "tipo": "string" Enum:["AUTORIDADE", "ENTE_DESPERSONALIZADO", "FISICA", "JURIDICA", "ORGAO_REPRESENTACAO"],
      "documentos": [
        {
          "id": "string",
          "tipo": "string" Enum:["CC", "CEI", "CI", "CN", "CNH", "CNPJ", "CP", "CPF", "CT", "IF", "NB", "NIT", "OAB", "OUTROS", "PAS", "PIS_PASEP", "RGE", "RIC", "RJC", "RJI", "TE"],
          "numero": "string",
          "dataExpedicao": "string" (nullable: true),
          "orgaoExpedidor": "string" (nullable: true),
          "orgaoExpedidorUnidadeFederativa": "string" Enum:["AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO"] (nullable: true),
          "nome": "string" (nullable: true)
        }
      ],
      "enderecos": {} (nullable: true),
      "outrosNomes": {} (nullable: true),
      "relacionamentos": {} nullable: true)
  },
    "tipoId": "string",
    "situacao": "string" Enum:["ATIVO", "BAIXADO", "INATIVO", "SUSPENSO"],
    "polo": "string" Enum:["ASSISTENTE_DESINTERESSADO_AMICUS_CURAE", "ATIVO", "FISCAL_LEI", "NAO_VINCULADOS", "OUTROS_PARTICIPANTES", "PASSIVO", "TERCEIRO", "TESTEMUNHA_JUIZO", "VITIMA"],
    "sigilosa": "boolean",
    "endereco": {
      "id": "string",
      "endereco": {
        "cep": {
          "numero": "string" (nullable: true),
          "bairro": "string" (nullable: true),
          "logradouro": "string" (nullable: true),
          "localidade": {
            "id": "integer" (nullable: true),
            "nome": "string" (nullable: true),
            "unidadeFederativa": "string" Enum:["AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO"] (nullable: true)
          },
        },
        "numero": "string" (nullable: true),
        "complemento": "string" (nullable: true),
        "pais": {
          "id": "integer" (nullable: true),
          "nome": "string" (nullable: true),
          "sigla": "string" (nullable: true)
        } (nullable: true)
      },
    } (nullable: true),
    "assistenciaJudiciaria": "boolean" (nullable: true),
    "relacionamentos": [
      {
        "id": "string",
        "relacionada": {
          "documentos": [
            {
              "dataExpedicao": "string" (nullable: true),
              "id": "string",
              "nome": "string" (nullable: true),
              "numero": "string",
              "orgaoExpedidor": "string" (nullable: true),
              "orgaoExpedidorUnidadeFederativa": "string" Enum:["AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO"] (nullable: true),
              "tipo": "string" Enum:["CC", "CEI", "CI", "CN", "CNH", "CNPJ", "CP", "CPF", "CT", "IF", "NB", "NIT", "OAB", "OUTROS", "PAS", "PIS_PASEP", "RGE", "RIC", "RJC", "RJI", "TE"]
            }
          ],
          "enderecos": {} (nullable: true),
          "fisica": {
            "dataNascimento": "string" (nullable: true),
            "dataObito": "string" (nullable: true),
            "genitores": [
              {
                "id": "string",
                "nome": "string",
                "sexo": "string" Enum:["FEMININO", "MASCULINO", "OUTROS"],
              }
            ],
            "nacionalidade": {
              "id": "integer" (nullable: true),
              "nome": "string" (nullable: true),
              "sigla": "string" (nullable: true)
            },
            "naturalidade": {
              "id": "integer" (nullable: true),
              "nome": "string" (nullable: true),
              "unidadeFederativa": "string" Enum:["AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO"] (nullable: true)
            },
            "sexo": "string" Enum:["FEMININO", "MASCULINO", "OUTROS"] (nullable: true)
          },
          "id": "string",
          "juridica": {
            "dataAbertura": "string" (nullable: true),
            "dataEncerramento": "string" (nullable: true),
            "nomeFantasia": "string" (nullable: true)
          },
          "nome": "string",
          "outrosNomes": {} (nullable: true),
          "relacionamentos": {},
          "tipo": "string" Enum:["AUTORIDADE", "ENTE_DESPERSONALIZADO", "FISICA", "JURIDICA", "ORGAO_REPRESENTACAO"]
        },
        "tipo": "string" Enum:["ASSISTENCIA_LEGAL_ASCENDENTE", "ASSISTENTE", "ASSISTENTE_TECNICO", "CURADOR_PROCESSUAL", "OUTRO", "REPRESENTACAO_LEGAL_ASCENDENTE", "SUBSTITUICAO_REPRESENTACAO_PROCESSUAL", "TESTEMUNHA_FATO", "TUTOR_PROCESSUAL"]
      }
    ],
    "representantes": [
      {
        "enviarIntimacao": "boolean" (nullable: true),
        "id": "string",
        "representante": {
          "documentos": [
            {
              "dataExpedicao": "string" (nullable: true),
              "id": "string",
              "nome": "string" (nullable: true),
              "numero": "string",
              "orgaoExpedidor": "string" (nullable: true),
              "orgaoExpedidorUnidadeFederativa": "string" Enum:["AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO"] (nullable: true),
              "tipo": "string" Enum:["CC", "CEI", "CI", "CN", "CNH", "CNPJ", "CP", "CPF", "CT", "IF", "NB", "NIT", "OAB", "OUTROS", "PAS", "PIS_PASEP", "RGE", "RIC", "RJC", "RJI", "TE"]
            }
          ],
          "enderecos": {} (nullable: true),
          "fisica": {
            "dataNascimento": "string" (nullable: true),
            "dataObito": (nullable: true),
            "genitores": [
              {
                "id": "string",
                "nome": "string",
                "sexo": "string" Enum:["FEMININO", "MASCULINO", "OUTROS"]
              }
            ],
            "nacionalidade": {
              "id": "integer" (nullable: true),
              "nome": "string" (nullable: true),
              "sigla": "string" (nullable: true)
            },
            "naturalidade": {
              "id": "integer" (nullable: true),
              "nome": "string" (nullable: true),
              "unidadeFederativa": "string" Enum:["AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO"] (nullable: true)
            },
            "sexo": "string" Enum:["FEMININO", "MASCULINO", "OUTROS"] (nullable: true)
          },
          "id": "string",
          "juridica": {
            "dataAbertura": "string" (nullable: true),
            "dataEncerramento": "string" (nullable: true),
            "nomeFantasia": "string" (nullable: true)
          },
          "nome": "string",
          "outrosNomes": {} (nullable: true),
          "relacionamentos": {} (nullable: true),
          "tipo": "string" Enum:["AUTORIDADE", "ENTE_DESPERSONALIZADO", "FISICA", "JURIDICA", "ORGAO_REPRESENTACAO"]
        },
        "tipo": "string" Enum:["ADVOGADO", "CURADOR", "DEFENSOR", "OUTRO", "PROCURADOR", "TUTOR"],
        "unidadeOrganizacional": {
          "nome": "string",
          "tipo": "string" Enum:["DEFENSORIA", "PROCURADORIA"]
        }
      }
    ],
  },
  "relacionamentos": {} (nullable: true)
}

Exemplo de customização

[
  {
    "id": "123456",
    "numero": "0001020-21.2014.6.15.0007",
    "classeId": 156,
    "assuntoPrincipalId": "1110010",
    "dataAjuizamento": "2019-02-11T09:05:13",
    "dataDistribuicao": "2019-02-11T09:05:13",
    "justicaGratuita": false,
    "nivelSigilo": "PUBLICO",
    "liminar": false,
    "valorCausa": 60540.11,
    "instancia": "PRIMEIRO_GRAU",
    "natureza": "INDEFINIDA",
    "tipoJustica": "INDEFINIDO",
    "orgaoJulgadorId": "110",
    "competenciaId": "12",
    "situacaoMigracao": "NATIVO",
    "assuntos": [
      {
        "id": "1110010",
        "assunto": {
          "nacional": {
            "id": 1961
          },
          "local": null
        }
      }
  ],
  "documentos": [
      {
        "id": "14115671",
        "nome": "0001020-21.2014.6.15.0007_VOL_001-3.pdf",
        "dataJuntada": "2019-02-11T09:05:13.179",
        "dataExclusao": null,
        "pai": null,
        "tipoId": "12",
        "nivelSigilo": "PUBLICO",
        "signatarios": [
          "14217127331"
        ]
      },
      {
        "id": "14115672",
        "nome": "0001020-21.2014.6.15.0007_VOL_002-3.pdf",
        "dataJuntada": "2019-01-13T09:10:11.73",
        "dataExclusao": null,
        "pai": null,
        "tipoId": "101",
        "nivelSigilo": "PUBLICO",
        "signatarios": [
          "14217127331"
        ]
      },
      {
        "id": "24183944",
        "nome": "00 Cumprimento de Sentença - VALDETE MARIA.pdf",
        "dataJuntada": "2019-01-14T17:43:33.149",
        "dataExclusao": null,
        "pai": {
          "id": "24183943",
          "nome": "PET. DE CUMPRIMENTO DE SENTENÇA.html",
          "dataJuntada": "2019-01-14T16:13:23.149",
          "dataExclusao": null,
          "pai": null,
          "tipoId": "106",
          "nivelSigilo": "PUBLICO",
          "signatarios": [
            "30115151517"
          ]
        },
        "tipoId": "106",
        "nivelSigilo": "PUBLICO",
        "signatarios": [
          "30115151517"
        ]
      },
      {
        "id": "24184508",
        "nome": "05 HISTORICO CREDITOS.pdf",
        "dataJuntada": "2019-01-14T16:13:23.149",
        "dataExclusao": null,
        "pai": {
          "id": "24183943",
          "nome": "PET. DE CUMPRIMENTO DE SENTENÇA.html",
          "dataJuntada": "2019-01-14T16:13:23.149",
          "dataExclusao": null,
          "pai": null,
          "tipoId": "106",
          "nivelSigilo": "PUBLICO",
          "signatarios": [
            "30115151517"
          ]
        },
        "tipoId": "53",
        "nivelSigilo": "PUBLICO",
        "signatarios": [
          "30115151517"
        ]
      },
      {
      "id": "25328419",
      "nome": "RPV - 0001020-41.pdf",
      "dataJuntada": "2019-03-26T09:21:18.167",
      "dataExclusao": null,
      "pai": {
        "id": "25318431",
        "nome": "Pre Cadastro RPV - PARTE E ADV.html",
        "dataJuntada": "2019-03-26T09:21:18.167",
        "dataExclusao": null,
        "pai": null,
        "tipoId": "57",
        "nivelSigilo": "PUBLICO",
        "signatarios": [
          "12130245777"
        ]
      },
      "tipoId": "142",
      "nivelSigilo": "PUBLICO",
      "signatarios": [
        "12130245777"
      ]
      },
      {
      "id": "25968751",
      "nome": "Petiçã Expedição RPV - VALDETE MARIA.pdf",
      "dataJuntada": "2019-04-02T11:20:39.911",
      "dataExclusao": null,
      "pai": {
        "id": "25967948",
        "nome": "PETIÇÃO.html",
        "dataJuntada": "2019-04-02T11:20:39.911",
        "dataExclusao": null,
        "pai": null,
        "tipoId": "36",
        "nivelSigilo": "PUBLICO",
        "signatarios": [
          "30115151517"
        ]
      },
      "tipoId": "36",
      "nivelSigilo": "PUBLICO",
      "signatarios": [
        "30115151517"
      ]
      },
  ],
  "movimentos": [
    {
      "id": "19243979",
      "data": "2019-01-23T08:13:21.847",
      "dataExclusao": null,
      "tipo": {
        "nacional": {
          "id": 26
        },
        "local": null
      },
      "descricao": "Distribuído por migração de sistemas",
      "documento": null,
      "magistradoCpf": null,
      "usuario": "14217127331",
      "complementos": [
        {
          "id": "20557917",
          "tipoId": 2,
          "valor": "migração de sistemas",
          "tabeladoId": 8220001
        }
      ]
    },
    {
      "id": "19271326",
      "data": "2019-01-23T18:22:59.763",
      "dataExclusao": null,
      "tipo": {
        "nacional": {
          "id": 60
        },
        "local": null
      },
      "descricao": "Expedição de Outros documentos.",
      "documento": {
        "id": "24163666",
        "nome": "INTIMAÇÃO.html",
        "dataJuntada": "2019-01-23T18:22:57.838",
        "dataExclusao": null,
        "pai": null,
        "tipoId": "60",
        "nivelSigilo": "PUBLICO",
        "signatarios": [
          "14217127331"
        ]
      },
      "magistradoCpf": null,
      "usuario": "14217127331",
      "complementos": [
        {
          "id": "20588861",
          "tipoId": 4,
          "valor": "Outros documentos",
          "tabeladoId": 80
        }
      ]
    },
    {
      "id": "19271327",
      "data": "2019-01-23T18:23:01.511",
      "dataExclusao": null,
      "tipo": {
        "nacional": {
          "id": 60
        },
        "local": null
      },
      "descricao": "Expedição de Outros documentos.",
      "documento": {
        "id": "24163665",
        "nome": "INTIMAÇÃO.html",
        "dataJuntada": "2019-01-23T18:22:56.917",
        "dataExclusao": null,
        "pai": null,
        "tipoId": "60",
        "nivelSigilo": "PUBLICO",
        "signatarios": [
          "14217127331"
        ]
      },
      "magistradoCpf": null,
      "usuario": "14217127331",
      "complementos": [
        {
          "id": "20588862",
          "tipoId": 4,
          "valor": "Outros documentos",
          "tabeladoId": 80
        }
      ]
    },
    {
      "id": "20911331",
      "data": "2019-03-20T17:56:34.557",
      "dataExclusao": null,
      "tipo": {
        "nacional": {
          "id": 11010
        },
        "local": null
      },
      "descricao": "Proferido DESPACHO de mero expediente",
      "documento": {
        "id": "25103177",
        "nome": "DESPACHO.html",
        "dataJuntada": "2019-03-20T17:56:32.367",
        "dataExclusao": null,
        "pai": null,
        "tipoId": "63",
        "nivelSigilo": "PUBLICO",
        "signatarios": [
          "00579497941"
        ]
      },
      "magistradoCpf": "00579497941",
      "usuario": "00579497941",
      "complementos": []
    },
    {
      "id": "23351553",
      "data": "2019-05-20T11:58:37.593",
      "dataExclusao": null,
      "tipo": {
        "nacional": {
          "id": 1051
        },
        "local": null
      },
      "descricao": "Decorrido prazo de INSS em 20/04/2019 23:59:59.",
      "documento": null,
      "magistradoCpf": null,
      "usuario": "sistema",
      "complementos": [
        {
          "id": "24756508",
          "tipoId": 14,
          "valor": "20/04/2019 23:59:59",
          "tabeladoId": 14
        },
        {
          "id": "24757518",
          "tipoId": 1,
          "valor": "INSS",
          "tabeladoId": 1
        }
      ]
    }
  ],
  "partes": [
    {
      "id": "2761506",
      "pessoa": {
        "id": "20519",
        "nome": "INSS - INSTITUTO NACIONAL DO SEGURO SOCIAL",
        "tipo": "AUTORIDADE",
        "documentos": [
          {
            "id": "1232275",
            "tipo": "CNPJ",
            "numero": "01.144.144/0001-02",
            "dataExpedicao": null,
            "orgaoExpedidor": "Receita Federal",
            "orgaoExpedidorUnidadeFederativa": null,
            "nome": "Instituto Nacional do Seguro Social I N S S"
          }
        ],
        "enderecos": null,
        "outrosNomes": null,
        "relacionamentos": null
      },
      "tipoId": "38",
      "situacao": "INATIVO",
      "polo": "PASSIVO",
      "sigilosa": false,
      "endereco": {
        "id": "1846187",
        "endereco": {
          "cep": {
            "numero": "18890-000",
            "bairro": "Olaria",
            "logradouro": "Av.Sao Jose",
            "localidade": {
              "id": 1100205,
              "nome": "Curitiba",
              "unidadeFederativa": "PR"
            }
          },
          "numero": "3132",
          "complemento": "Avenida Presidente Vargas 701",
          "pais": {
            "id": 76,
            "nome": "Brasil",
            "sigla": "BR"
          }
        }
      },
      "assistenciaJudiciaria": null,
      "relacionamentos": [],
      "representantes": []
    },
    {
      "id": "2962577",
      "pessoa": {
        "id": "797470",
        "nome": "VALDETE MARIA DA SILVA",
        "tipo": "FISICA",
        "fisica": {
          "sexo": "FEMININO",
          "dataNascimento": "1961-04-30",
          "dataObito": null,
          "naturalidade": null,
          "nacionalidade": null,
          "genitores": [
            {
              "id": "797470_nome_mae",
              "nome": "ROSA MENDES SILVA",
              "sexo": "FEMININO"
            }
          ]
        },
        "documentos": [
          {
            "id": "1180678",
            "tipo": "TE",
            "numero": "30609840647",
            "dataExpedicao": null,
            "orgaoExpedidor": "Justiça Eleitoral",
            "orgaoExpedidorUnidadeFederativa": null,
            "nome": "VALDETE MARIA DA SILVA"
          },
          {
            "id": "1180679",
            "tipo": "OUTROS",
            "numero": "47104556",
            "dataExpedicao": null,
            "orgaoExpedidor": "PR",
            "orgaoExpedidorUnidadeFederativa": null,
            "nome": "VALDETE MARIA DA SILVA"
          },
          {
            "id": "1180677",
            "tipo": "CPF",
            "numero": "123.246.890-18",
            "dataExpedicao": null,
            "orgaoExpedidor": "PR",
            "orgaoExpedidorUnidadeFederativa": null,
            "nome": "VALDETE MARIA DA SILVA"
          }
        ],
        "enderecos": null,
        "outrosNomes": null,
        "relacionamentos": null
      },
      "tipoId": "37",
      "situacao": "ATIVO",
      "polo": "ATIVO",
      "sigilosa": false,
      "endereco": {
        "id": "1846189",
        "endereco": {
          "cep": {
            "numero": "11111-199",
            "bairro": "zona rural",
            "logradouro": "lote 4, bloco 1, km 102",
            "localidade": {
              "id": 1100019,
              "nome": "Maringa",
              "unidadeFederativa": "PR"
            }
          },
          "numero": "123",
          "complemento": "Avenida São Paulo 1089",
          "pais": {
            "id": 76,
            "nome": "Brasil",
            "sigla": "BR"
          }
        }
      },
      "assistenciaJudiciaria": null,
      "relacionamentos": [],
      "representantes": [
        {
          "id": "1011110",
          "tipo": "ADVOGADO",
          "representante": {
            "id": "30997",
            "nome": "DEBORA FONTES",
            "tipo": "FISICA",
            "fisica": {
              "sexo": "FEMININO",
              "dataNascimento": "1981-01-26",
              "dataObito": null,
              "naturalidade": {
                "id": 1100018,
                "nome": "LONDRINA",
                "unidadeFederativa": "PR"
              },
              "nacionalidade": {
                "id": 76,
                "nome": "Brasil",
                "sigla": "BR"
              },
              "genitores": [
                {
                  "id": "30197_nome_mae",
                  "nome": "SILVIA MARIA MENDES FONTES",
                  "sexo": "FEMININO"
                }
              ]
            },
            "documentos": [],
            "enderecos": null,
            "outrosNomes": null,
            "relacionamentos": null
          },
          "enviarIntimacao": null,
          "unidadeOrganizacional": null
        }
      ]
    },
  ],
  "relacionamentos": [
    {
      "id": "141155_processo_referencia",
      "numeroProcesso": "7013333-3.2018.6.15.0007",
      "tipo": "INCIDENTAL",
      "classeId": 156
    }
  ]
  }
]

ConversorImpl.recuperarProcessoDocumentoConteudoPorDocumentoId

Parâmetros de entrada
Parâmetro	Tipo de Dados	Descrição
documentoId	String	Id do documento no sistema processual

Resposta esperada da API

Será retornado o conteúdo binário do documento registrado no sistema de armazenamento processual.

ConversorImpl.recuperarProcessoDocumentoMetadadosPorDocumentoId

Parâmetros de entrada
Parâmetro	Tipo de Dados	Descrição
documentoId	String	Id do documento no sistema processual

Resposta esperada da API

{
  "dataExclusao": "string" (nullable: true),
  "dataJuntada": "string" (nullable: true),
  "id": "string",
  "nivelSigilo": "string" Enum:["PUBLICO", "SEGREDO_JUSTICA", "SIGILO_ABSOLUTO", "SIGILO_INTENSO", "SIGILO_MEDIO", "SIGILO_MINIMO"],
  "nome": "string",
  "signatarios": {} (nullable: true),
  "tipoId": "string"
}

ConversorImpl.recuperarProcessoDocumentosMetadadosPorProcessoId

Parâmetros de entrada
Parâmetro	Tipo de Dados	Descrição
processoId	String	Id do processo no sistema processual

Resposta esperada da API

{
  "dataExclusao": "string" (nullable: true),
  "dataJuntada": "string" (nullable: true),
  "id": "string",
  "nivelSigilo": "string" Enum:["PUBLICO", "SEGREDO_JUSTICA", "SIGILO_ABSOLUTO", "SIGILO_INTENSO", "SIGILO_MEDIO", "SIGILO_MINIMO"],
  "nome": "string",
  "signatarios": {} (nullable: true),
  "tipoId": "string"
}

ConversorImpl.recuperarProcessoMetadadosPorNumero

Parâmetros de entrada
Parâmetro	Tipo de Dados	Descrição
numeroProcesso	String	Número único do processo

Resposta esperada da API

{
  "assuntoPrincipalId": "string" (nullable: true),
  "assuntos": [
    {
      "assunto": {
        "local": {
          "descricao": "string",
          "id": "string",
          "paiNacionalId": "integer"
        } (nullable: true),
        "nacional": {
          "id": "integer"
        } (nullable: true),
        "definidoLocal": "boolean",
        "definidoNacional": "boolean"
      },
      "id": "string"
    }
  ],
  "classeId": "integer",
  "competenciaId": "string",
  "dataAjuizamento": "string",
  "dataDistribuicao": "string",
  "documentos": {} (nullable: true),
  "id": "string",
  "instancia": "string" Enum:["PRIMEIRO_GRAU", "QUARTO_GRAU", "SEGUNDO_GRAU", "TERCEIRO_GRAU"],
  "justicaGratuita": "boolean",
  "liminar": "boolean",
  "movimentos": {} (nullable: true),
  "natureza": "string" Enum:["CIVEL", "CRIMINAL", "ELEITORAL", "FISCAL", "INDEFINIDA", "MILITAR", "TRABALHISTA"],
  "nivelSigilo": "string" Enum:["PUBLICO", "SEGREDO_JUSTICA", "SIGILO_ABSOLUTO", "SIGILO_INTENSO", "SIGILO_MEDIO"],
  "numero": "string",
  "orgaoJulgadorColegiadoId": "string",
  "orgaoJulgadorId": "string",
  "partes": {} (nullable: true),
  "relacionamentos": {} (nullable: true),
  "situacaoMigracao": "string" Enum:["EMIGRANTE", "IMIGRANTE", "NATIVO"],
  "tipoJustica": "string" Enum:["COMUM", "ESPECIAL", "INDEFINIDO"],
  "valorCausa": "number" (nullable: true)
}

ConversorImpl.recuperarProcessoMovimentosMetadadosPorProcessoId

Parâmetros de entrada
Parâmetro	Tipo de Dados	Descrição
processoId	String	Id do processo no sistema processual

Resposta esperada da API

[
  {
    "complementos": [
      {
        "id": "string",
        "tabeladoId": "integer" (nullable: true),
        "tipoId": "integer",
        "valor": "string"
      }
    ],
    "data": "string",
    "dataExclusao": "string" (nullable: true),
    "descricao": "string",
    "documento": {
      "dataExclusao": "string" (nullable: true),
      "dataJuntada": "string",
      "id": "string",
      "nivelSigilo": "string" Enum:["PUBLICO", "SEGREDO_JUSTICA", "SIGILO_ABSOLUTO", "SIGILO_INTENSO", "SIGILO_MEDIO"],
      "nome": "string",
      "pai": {} (nullable: true),
      "signatarios": {} (nullable: true),
      "tipoId": "string"
    } (nullable: true),
    "id": "string",
    "magistradoCpf": "string" (nullable: true),
    "tipo": {
      "local": {
        "descricao": "string",
        "id": "string",
        "paiNacionalId": "integer"
      } (nullable: true),
      "nacional": {
        "id": "integer"
      } (nullable: true)
    },
    "usuario": "string" (nullable: true)
  }
]

ConversorImpl.recuperarProcessoPartesMetadadosPorProcessoId

Parâmetros de entrada
Parâmetro	Tipo de Dados	Descrição
processoId	String	Id do processo no sistema processual

Resposta esperada da API

[
  {
    "assistenciaJudiciaria": "boolean" (nullable: true),
    "endereco": {
      "endereco": {
        "cep": {
          "bairro": "string" (nullable: true),
          "localidade": {
            "id": "integer" (nullable: true),
            "nome": "string" (nullable: true),
            "unidadeFederativa": "string" Enum:["AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO"] (nullable: true)
          },
          "logradouro": "string" (nullable: true),
          "numero": "string" (nullable: true)
        },
        "complemento": "string" (nullable: true),
        "numero": "string" (nullable: true),
        "pais": {
          "id": "integer" (nullable: true),
          "nome": "string" (nullable: true),
          "sigla": "string" (nullable: true)
        } (nullable: true)
      },
      "id": "string"
    } (nullable: true),
    "id": "string",
    "pessoa": {
      "documentos": [
        {
          "dataExpedicao": "string" (nullable: true),
          "id": "string",
          "nome": "string" (nullable: true),
          "numero": "string",
          "orgaoExpedidor": "string" (nullable: true),
          "orgaoExpedidorUnidadeFederativa": "string" Enum:["AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO"],
          "tipo": "string" Enum:["CC", "CEI", "CI", "CN", "CNH", "CNPJ", "CP", "CPF", "CT", "IF", "NB", "NIT", "OAB", "OUTROS", "PAS", "PIS_PASEP", "RGE", "RIC", "RJC", "RJI", "TE"]
        }
      ],
      "enderecos": {},
      "fisica": {
        "dataNascimento": "string" (nullable: true),
        "dataObito": "string" (nullable: true),
        "genitores": [
          {
            "id": "string",
            "nome": "string",
            "sexo": "string" Enum:["FEMININO", "MASCULINO", "OUTROS"]
          }
        ],
        "nacionalidade": {
          "id": "integer" (nullable: true),
          "nome": "string" (nullable: true),
          "sigla": "string" (nullable: true)
        } (nullable: true),
        "naturalidade": {
          "id": "integer" (nullable: true),
          "nome": "string" (nullable: true),
          "unidadeFederativa": "string" Enum:["AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO"] (nullable: true)
        } (nullable: true),
        "sexo": "string" Enum:["FEMININO", "MASCULINO", "OUTROS"] (nullable: true)
      },
      "id": "string",
      "juridica": {
        "dataAbertura": "string" (nullable: true),
        "dataEncerramento": "string" (nullable: true),
        "nomeFantasia": "string" (nullable: true)
      },
      "nome": "string",
      "outrosNomes": {} (nullable: true),
      "relacionamentos": {} (nullable: true),
      "tipo": "string" Enum:["AUTORIDADE", "ENTE_DESPERSONALIZADO", "FISICA", "JURIDICA", "ORGAO_REPRESENTACAO"]
    },
    "polo": "string" Enum:["ASSISTENTE_DESINTERESSADO_AMICUS_CURAE", "ATIVO", "FISCAL_LEI", "NAO_VINCULADOS", "OUTROS_PARTICIPANTES", "PASSIVO", "TERCEIRO", "TESTEMUNHA_JUIZO", "VITIMA"],
    "relacionamentos": [
      {
        "id": "string",
        "relacionada": {
          "documentos": [
            {
              "dataExpedicao": "string" (nullable: true),
              "id": "string",
              "nome": "string" (nullable: true),
              "numero": "string",
              "orgaoExpedidor": "string" (nullable: true),
              "orgaoExpedidorUnidadeFederativa": "string" Enum:["AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO"] (nullable: true),
              "tipo": "string" Enum:["CC", "CEI", "CI", "CN", "CNH", "CNPJ", "CP", "CPF", "CT", "IF", "NB", "NIT", "OAB", "OUTROS", "PAS", "PIS_PASEP", "RGE", "RIC", "RJC", "RJI", "TE"]
            }
          ],
          "enderecos": {} (nullable: true),
          "fisica": {
            "dataNascimento": "string" (nullable: true),
            "dataObito": "string" (nullable: true),
            "genitores": [
              {
                "id": "string",
                "nome": "string",
                "sexo": "string" Enum:["FEMININO", "MASCULINO", "OUTROS"]
              }
            ],
            "nacionalidade": {
              "id": "integer" (nullable: true),
              "nome": "string" (nullable: true),
              "sigla": "string" (nullable: true)
            } (nullable: true),
            "naturalidade": {
              "id": "integer" (nullable: true),
              "nome": "string" (nullable: true),
              "unidadeFederativa": "string" Enum:["AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO"] (nullable: true)
            } (nullable: true),
            "sexo": "string" Enum:["FEMININO", "MASCULINO", "OUTROS"] (nullable: true)
          },
          "id": "string",
          "juridica": {
            "dataAbertura": "string" (nullable: true),
            "dataEncerramento": "string" (nullable: true),
            "nomeFantasia": "string" (nullable: true)
          },
          "nome": "string",
          "outrosNomes": {} (nullable: true),
          "relacionamentos": {} (nullable: true),
          "tipo": "string" Enum:["AUTORIDADE", "ENTE_DESPERSONALIZADO", "FISICA", "JURIDICA", "ORGAO_REPRESENTACAO"]
        },
        "tipo": "string" Enum:["ASSISTENCIA_LEGAL_ASCENDENTE", "ASSISTENTE", "ASSISTENTE_TECNICO", "CURADOR_PROCESSUAL", "OUTRO", "REPRESENTACAO_LEGAL_ASCENDENTE", "SUBSTITUICAO_REPRESENTACAO_PROCESSUAL", "TESTEMUNHA_FATO", "TUTOR_PROCESSUAL"]
      }
    ],
    "representantes": [
      {
        "enviarIntimacao": "boolean" (nullable: true),
        "id": "string",
        "representante": {
          "documentos": [
            {
              "dataExpedicao": "string" (nullable: true),
              "id": "string",
              "nome": "string" (nullable: true),
              "numero": "string",
              "orgaoExpedidor": "string" (nullable: true),
              "orgaoExpedidorUnidadeFederativa": "string" Enum:["AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO"] (nullable: true),
              "tipo": "string" Enum:["CC", "CEI", "CI", "CN", "CNH", "CNPJ", "CP", "CPF", "CT", "IF", "NB", "NIT", "OAB", "OUTROS", "PAS", "PIS_PASEP", "RGE", "RIC", "RJC", "RJI", "TE"]
            }
          ],
          "enderecos": {} (nullable: true),
          "fisica": {
            "dataNascimento": "string" (nullable: true),
            "dataObito": "string" (nullable: true),
            "genitores": [
              {
                "id": "string",
                "nome": "string",
                "sexo": "string" Enum:["FEMININO", "MASCULINO", "OUTROS"]
              }
            ],
            "nacionalidade": {
              "id": "integer" (nullable: true),
              "nome": "string" (nullable: true),
              "sigla": "string" (nullable: true)
            },
            "naturalidade": {
              "id": "integer" (nullable: true),
              "nome": "string" (nullable: true),
              "unidadeFederativa": "string" Enum:["AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO"] (nullable: true)
            },
            "sexo": "string" Enum:["FEMININO", "MASCULINO", "OUTROS"]
          },
          "id": "string",
          "juridica": {
            "dataAbertura": "string" (nullable: true),
            "dataEncerramento": "string" (nullable: true),
            "nomeFantasia": "string" (nullable: true)
          },
          "nome": "string",
          "outrosNomes": {} (nullable: true),
          "relacionamentos": {} (nullable: true),
          "tipo": "string" Enum:["AUTORIDADE", "ENTE_DESPERSONALIZADO", "FISICA", "JURIDICA", "ORGAO_REPRESENTACAO"]
        },
        "tipo": "string" Enum:["ADVOGADO", "CURADOR", "DEFENSOR", "OUTRO", "PROCURADOR", "TUTOR"],
        "unidadeOrganizacional": {
          "nome": "string",
          "tipo": "string" Enum:["DEFENSORIA", "PROCURADORIA"]
        } (nullable: true)
      }
    ],
    "sigilosa": "boolean",
    "situacao": "string" Enum:["ATIVO", "BAIXADO", "INATIVO", "SUSPENSO"],
    "tipoId": "string"
  }
]

ConversorImpl.verificarExistenciaDeProcessoPorNumero

Parâmetros de entrada
Parâmetro	Tipo de Dados	Descrição
numeroProcesso	String	Número único do processo

Resposta esperada da API

"boolean" (1)

1	Será retornado se o processo existe (ou não) no sistema de armazenamento processual.

ConversorImpl.recuperarAlteracoesDeProcessos

Parâmetros de entrada
Parâmetro	Tipo de Dados	Descrição
quantidade	Integer	Quantidade de resultados desejados

Resposta esperada da API

[
  {
    "categoria": "string" Enum:["DOCUMENTOS", "METADADOS", "MOVIMENTOS", "PARTES"],
    "data": "string",
    "id": "string",
    "tipo": "string" Enum:["ALTERACAO", "EXCLUSAO", "INSERCAO"]
  }
]

ConversorImpl.recuperarAlteracoesDePessoas

Parâmetros de entrada
Parâmetro	Tipo de Dados	Descrição
quantidade	Integer	Quantidade de resultados desejados

Resposta esperada da API

[
  {
    "categoria": "string" Enum:["DOCUMENTOS", "ENDERECOS", "GENITORES", "METADADOS", "OUTROS_NOMES", "RELACIONAMENTOS"],
    "data": "string",
    "id": "string",
    "tipo": "string" Enum:["ALTERACAO", "EXCLUSAO", "INSERCAO"]
  }
]

ConversorImpl.confirmarAlteracoesDeProcessos

Parâmetros de entrada

Sem parâmetros de entrada.

Resposta esperada da API

[
  {
    "categoria": "string" Enum:["DOCUMENTOS", "METADADOS", "MOVIMENTOS", "PARTES"],
    "data": "string",
    "id": "string",
    "tipo": "string" Enum:["ALTERACAO", "EXCLUSAO", "INSERCAO"]
  }
]

ConversorImpl.confirmarAlteracoesDePessoas

Parâmetros de entrada

Sem parâmetros de entrada.

Resposta esperada da API

[
  {
    "categoria": "string" Enum:["DOCUMENTOS", "ENDERECOS", "GENITORES", "METADADOS", "OUTROS_NOMES", "RELACIONAMENTOS"],
    "data": "string",
    "id": "string",
    "tipo": "string" Enum:["ALTERACAO", "EXCLUSAO", "INSERCAO"]
  }
]

Ponto de atenção

As rotas confirmarAlteracoesDePessoas e confirmarAlteracoesDeProcessos são complementares às rotas de recuperarAlteracoesDePessoas e recuperarAlteracoesDeProcessos.
- Após a alteração de metadados no sistema processual, os dados modificados são armazenados em uma tabela com registro temporário, com a formação de uma fila de armazenamento temporário (pessoa_alteracao & processo_alteracao). As rotas recuperarAlteracoesDePessoas e recuperarAlteracoesDeProcessos realizam a busca das informações alteradas e enviam para processamento no Extrator de Dados.
- Por fim, as rotas confirmarAlteracoesDePessoas e confirmarAlteracoesDeProcessos confirmam a alteração realizada e removem o item modificado da fila de armazenamento temporário.

ConversorImpl.monitorar

Parâmetros de entrada

Sem parâmetros de entrada.

Resposta esperada da API

{
  "aplicacao": {
    "ambiente": "string" Enum:["DESENVOLVIMENTO", "HOMOLOGACAO", "PRODUCAO"],
    "commitSha": "string",
    "configuracoes": {},
    "dataCompilacao": "string",
    "nome": "string",
    "pipelineId": "string",
    "sistema": {
      "charset": "string",
      "hostname": "string",
      "locale": {
        "linguagem": "string",
        "nome": "string",
        "pais": "string"
      },
      "memoria": {
        "livre": "integer",
        "maxima": "integer",
        "total": "integer",
        "usada": "integer"
      },
      "processadores": "integer",
      "timeZone": {
        "horarioLocal": "string",
        "horarioLocalPorExtenso": "string",
        "id": "string",
        "nome": "string"
      },
      "tipo": "string" Enum:["JAVA", "PHP", "PYTHON"],
      "versao": "string"
    },
    "versao": "string"
  },
  "internet": {
    "googleComSsl": {
      "erro": "string",
      "situacao": "string" Enum:["FALHA", "IGNORADO", "SUCESSO"]
    },
    "googleSemSsl": {
      "erro": "string",
      "situacao": "string" Enum:["FALHA", "IGNORADO", "SUCESSO"]
    }
  },
  "bancoDados": {
    "leitura": {
      "erro": "string",
      "situacao": "string" Enum:["FALHA", "IGNORADO", "SUCESSO"]
    }
  },
  "storage": {
    "escrita": {
      "erro": "string",
      "situacao": "string" Enum:["FALHA", "IGNORADO", "SUCESSO"]
    },
    "exclusao": {
      "erro": "string",
      "situacao": "string" Enum:["FALHA", "IGNORADO", "SUCESSO"]
    },
    "leitura": {
      "erro": "string",
      "situacao": "string" Enum:["FALHA", "IGNORADO", "SUCESSO"]
    },
    "nome": "string",
    "tipo": "string" Enum:["JCR", "MINIO", "OUTRO", "S3"]
  }
}

dados

Parâmetros de entrada

Sem parâmetros de entrada.

Resposta esperada da API

{
  "ambiente": "string" Enum:["DESENVOLVIMENTO", "HOMOLOGACAO", "PRODUCAO"],
  "commitSha": "string",
  "configuracoes": {},
  "dataCompilacao": "string",
  "nome": "string",
  "pipelineId": "string",
  "sistema": {
    "charset": "string",
    "hostname": "string",
    "locale": {
      "linguagem": "string",
      "nome": "string",
      "pais": "string"
    },
    "memoria": {
      "livre": "integer",
      "maxima": "integer",
      "total": "integer",
      "usada": "integer"
    },
    "processadores": "integer",
    "timeZone": {
      "horarioLocal": "string",
      "horarioLocalPorExtenso": "string",
      "id": "string",
      "nome": "string"
    },
    "tipo": "string" Enum:["JAVA", "PHP", "PYTHON"],
    "versao": "string"
  },
  "versao": "string"
}

sistema

Parâmetros de entrada

Sem parâmetros de entrada.

Resposta esperada da API

{
  "charset": "string",
  "hostname": "string",
  "locale": {
    "linguagem": "string",
    "nome": "string",
    "pais": "string"
  },
  "memoria": {
    "livre": "integer",
    "maxima": "integer",
    "total": "integer",
    "usada": "integer"
  },
  "processadores": "integer",
  "timeZone": {
    "horarioLocal": "string",
    "horarioLocalPorExtenso": "string",
    "id": "string",
    "nome": "string"
  },
  "tipo": "string" Enum:["JAVA", "PHP", "PYTHON"],
  "versao": "string"
}

Voltar ao topo

4. Fase de testes

Após finalizadas as implementações de todos os serviços das API’s ExtratorMetadadosBasicosImpl e ConversorImpl, deve-se iniciar os testes de validação da implementação.

O desenvolvedor deve preparar ids de pessoas (física e jurídica), documentos, endereços e outros nomes para testes que contemplem os diversos cenários dos dados, como os exemplos abaixo:

Pessoa Física

{
  "id": "100000",
  "nome": "Francisca de Oliveira",
  "tipo": "FISICA",
  "fisica": {
    "sexo": "FEMININO",
    "dataNascimento": "1964-12-31",
    "dataObito": "2012-10-04",
    "naturalidade": {
      "id": 4100608,
      "nome": "ALTO PARANÁ",
      "unidadeFederativa": "PR"
    },
    "nacionalidade": {
      "id": 76,
      "nome": "Brasil",
      "sigla": "BR"
    },
    "genitores": [
      {
        "id": "100000_nome_pai",
        "nome": "José de Oliveira",
        "sexo": "MASCULINO"
      },
      {
        "id": "100000_nome_mae",
        "nome": "Maria de Oliveira",
        "sexo": "FEMININO"
      }
    ]
  },
}

Pessoa Física - Outros nomes

{
  "id": "10000",
  "nome": "ZÉ DA ESQUINA",
  "tipo": "ALCUNHA"
}

Documentos Pessoa Física - CPF

 {
  "id": "80000",
  "tipo": "CPF",
  "numero": "000.000.000-00",
  "dataExpedicao": "2001-01-01",
  "orgaoExpedidor": "Secretaria da Receita Federal do Brasil",
  "orgaoExpedidorUnidadeFederativa": "PR",
  "nome": "NOME DA PESSOA IMPRESSO NO DOCUMENTO"
}

Documentos Pessoa Física - Título de Eleitor

{
  "id": "80000",
  "tipo": "TE",
  "numero": "11102233344",
  "dataExpedicao": "2001-01-01",
  "orgaoExpedidor": "Justiça Eleitoral",
  "orgaoExpedidorUnidadeFederativa": "PR",
  "nome": "NOME DA PESSOA IMPRESSO NO DOCUMENTO"
}

Documentos Pessoa Física - OAB

{
  "id": "80000",
  "tipo": "OAB",
  "numero": "12345",
  "dataExpedicao": "2014-12-12",
  "orgaoExpedidor": "OAB-PR",
  "orgaoExpedidorUnidadeFederativa": "PR",
  "nome": "NOME DO ADVOGADO IMPRESSO NO DOCUMENTO"
}

Pessoa Jurídica

{
  "id": "8000",
  "nome": "ORDEM DOS ADVOGADOS DO BRASIL SEÇÃO MATO GROSSO DO SUL",
  "tipo": "JURIDICA",
  "juridica": {
    "dataAbertura": "1979-02-19",
    "dataEncerramento": "2015-11-20",
    "nomeFantasia": "ORDEM DOS ADVOGADOS DO BRASIL SEÇÃO MATO GROSSO DO SUL"
  },
}

Documentos Pessoa Jurídica - CNPJ

{
  "id": "14000",
  "tipo": "CNPJ",
  "numero": "00.000.000/0001-00",
  "dataExpedicao": null,
  "orgaoExpedidor": "Secretaria da Receita Federal do Brasil",
  "orgaoExpedidorUnidadeFederativa": null,
  "nome": "ORDEM DOS ADVOGADOS DO BRASIL SEÇÃO MATO GROSSO DO SUL"
}

Após implantação da aplicação, o desenvolvedor pode acessar a documentação da API no Swagger, disponível em: {baseurl}/docs

Voltar ao topo

5. Cenário Esperado

Cenário após a implantação do conversor:

Cenário esperado

Voltar ao topo

6. Considerações Gerais

Recomenda-se acompanhar as atualizações, melhorias e evoluções na proposta de conversor de dados do PJe, que podem ser acessados nos Guias de Migração abaixo:

Conversor de dados - PJe
- Micro-serviço responsável por converter os dados do PJe para API do Codex.
Extrator de dados - PJe
- Micro-serviço responsável por realizar a extração dos dados e monitoramento de processos através da API do conversor, que irá converter os dados do sistema procesual para a API do Codex.
Iris
- Micro serviço responsável por realizar o Reconhecimento ótico de caracteres - OCR de imagens.
Prisma
- Micro-serviço responsável por converter um binário em uma estrutura json contendo toda a informação desse arquivo

Versão do Documento
Versão	Data	Autor	Descrição
1.0	04-07-2022	Alef Batista - Analista de Documentos	Criação do Manual de Desenvolvimento - Conversor de dados para DataJud.

Voltar ao topo