[API] Processos
Obter Processo:
URL: {URL_SERVICE}/adv-service/processo/{CODIGO_PROCESSO}
Método: Get
Headers:
Content-Type : application/json
Accept : application/json
Authorization : ACCESS_TOKEN_USUARIO
Consultar Processos - Filtro Geral:
URL: {URL_SERVICE}/adv-service/processo/consulta?filtro-geral={FILTRO} (Filtrando pelo pasta, número processo, marcador, assunto ou envolvidos)
URL: {URL_SERVICE}/adv-service/processo/consulta
Método: Get
Possíveis parâmetros:
quan-registros={QUANTIDADE DE REGISTROS}
pagina={Pagina da busca}
codigo-atendimento={CODIGO_ATENDIMENTO_RELACIONADO}
Headers:
Content-Type : application/json
Accept : application/json
Authorization : ACCESS_TOKEN_USUARIO
Consultar Processos - Filtro Avançado:
URL: {URL_SERVICE}/adv-service/processo/consulta?filtro-geral={FILTRO} (Filtrando pelo pasta, número processo, marcador, assunto ou envolvidos)
URL: {URL_SERVICE}/adv-service/processo/consulta
Método: Post
Possíveis parâmetros:
quan-registros={QUANTIDADE DE REGISTROS}
pagina={Pagina da busca}
codigo-atendimento={CODIGO_ATENDIMENTO_RELACIONADO}
Headers:
Content-Type : application/json
Accept : application/json
Authorization : ACCESS_TOKEN_USUARIO
Conteúdo:
ProcessoConsultaFiltroWs {
nomeAssunto: string;
codigosUnidadeOrganizacional: number[];
codigoProcessoOrgao: number;
codigoSituacao: number;
codigoPessoaEnvolvido: number;
nomeEnvolvido: string;
numeroProcesso: string;
nomePasta: string;
identificador: string;
codigoMarcadores: number[];
codigoUsuariosResponsaveis: number[];
codigoGruposResponsaveis: number[];
dataProcessoInicio: XMLGregorianCalendar;
dataProcessoFim: XMLGregorianCalendar;
tipoDataProcesso: TipoDataProcessoType;
codigoTipoJustica: number;
codigoProcessoPai: number;
codigoEstado: number;
somenteProcessosSemAtendimento: boolean;
somenteProcessosSemProcessoPai: boolean;
somenteIncompleto: boolean;
somenteCompleto: boolean;
codigoOab: number;
flHabilitado: boolean;
filtroGeral: string;atualizadoDesde: XMLGregorianCalendar;
}type TipoDataProcessoType = 'DATA_DO_CADASTRO' | 'DATA_DA_DISTRIBUICAO' | 'DATA_DA_CITACAO' | 'DATA_DO_JULGAMENTO' | 'DATA_DO_ENCERRAMENTO';
Consultar Processos Completos (Mesmo conteúdo retornado ao obter processos) - Filtro Avançado:
URL: {URL_SERVICE}/adv-service/processo/consulta-completa
Método: Post
Possíveis parâmetros:
quan-registros={QUANTIDADE DE REGISTROS}
pagina={Pagina da busca}
codigo-atendimento={CODIGO_ATENDIMENTO_RELACIONADO}
Headers:
Content-Type : application/json
Accept : application/json
Authorization : ACCESS_TOKEN_USUARIO
Conteúdo:
ProcessoConsultaFiltroWs {
nomeAssunto: string;
codigosUnidadeOrganizacional: number[];
codigoProcessoOrgao: number;
codigoSituacao: number;
codigoPessoaEnvolvido: number;
nomeEnvolvido: string;
numeroProcesso: string;
nomePasta: string;
identificador: string;
codigoMarcadores: number[];
codigoUsuariosResponsaveis: number[];
codigoGruposResponsaveis: number[];
dataProcessoInicio: XMLGregorianCalendar;
dataProcessoFim: XMLGregorianCalendar;
tipoDataProcesso: TipoDataProcessoType;
codigoTipoJustica: number;
codigoProcessoPai: number;
codigoEstado: number;
somenteProcessosSemAtendimento: boolean;
somenteProcessosSemProcessoPai: boolean;
somenteIncompleto: boolean;
somenteCompleto: boolean;
codigoOab: number;
flHabilitado: boolean;
filtroGeral: string;atualizadoDesde: XMLGregorianCalendar;
}type TipoDataProcessoType = 'DATA_DO_CADASTRO' | 'DATA_DA_DISTRIBUICAO' | 'DATA_DA_CITACAO' | 'DATA_DO_JULGAMENTO' | 'DATA_DO_ENCERRAMENTO';
Consulta de Processos com Ordenação
É possível obter dos endpoint's de consulta de processos os processos ordenados a partir de determinados campos.
Os campos disponíveis para ordenação são obtidos através da seguinte requisição:
URL: {URL_SERVICE}/adv-service/processo/consulta/ordenacao
Método: Get
Headers:
Authorization : ACCESS_TOKEN_USUARIO
Resposta:
É possível também informar se a ordenação deve ser feita de forma ascendente ou descendente através do parâmetro ordenacao-tipo. Para ordenar os processos de forma ascendente deve ser informado a chave ASC e para ordenar de forma descendente a chave DESC.
Exemplo:
O seguinte exemplo efetua uma consulta de processos ordenados pela situação do processo de forma ascendente. Foi especificado também que a consulta deve trazer 50 processos e os mesmos devem estar completos.
URL: {URL_SERVICE}/adv-service/processo/consulta?ordenacao-chave=ORDENACAO_SITUACAO_PROCESSO&ordenacao-tipo=ASC&quan-registros=50&somenteCompleto=true
Método: Get
Resultado:
{
"totalRegistros": 16304,
"processoConsultaWs": [
{
...
"nomeSituacao": "Arquivado",
...
"flCompleto": true,
...
},
{
...
"nomeSituacao": "Ativo",
...
"flCompleto": true,
...
}
]
}Incluir Processo Judicial:
URL: {URL_SERVICE}/adv-service/processo-judicial
Método: Post
Headers:
Content-Type : application/json
Accept : application/json
Authorization : ACCESS_TOKEN_USUARIO
Conteúdo: ProcessoJudicialWs
Exemplo:
{
"assunto": "Assunto Processo",
"descricao": "Descriçao do processo",
"situacaoProcesso": {
"chave": 1,
"valor": "Ativo"
},
"tipoProcesso": "J",
"tipoJustica": {
"chave": 8,
"valor": "Justiça dos Estados e do Distrito Federal e Territórios"
},
"orgaoJudicial": {
"chave": 82,
"valor": "CJM10 - 10ª Circunscrição Judiciária Militar - Ceará/Fortaleza"
},
"segredoJustica": false,
"processoNumeroWs": [{
"tipoNumeracao": "PADRAO_CNJ",
"numeroDoProcesso": "8978798-49.8491.8.82.9197",
"principal": true
}],
"tipoInstancia": "PRIMEIRA_INSTANCIA",
"responsaveis": [
{
"chave": 123,
"valor": "Advogado SAJ ADV"
}
],
"gruposDeTrabalho": [
{
"chave": 123,
"valor": "Grupo API"
}
]
}
Para criar um processo é necessário fornecer alguns campos onde os valores a serem enviados precisam ser previamente consultados através de outros serviços. É o caso dos campos situacaoProcesso, tipoJustica e orgaoJudicial, responsaveis e gruposDeTrabalho.
Os valores informados nos campos tipoInstancia, tipoNumeracao e tipoProcesso são descritos na página [API] Contratos - Conteúdos Disponíveis para requisições através dos tipos TipoInstanciaProcessoType, TipoNumeracaoType e TipoProcessoType.
Os campos tipoJustica e orgaoJudicial podem ser obtido através da consulta de tipos apresentados na página [API] Justiça e Órgãos.
Os campos responsaveis e gruposDeTrabalho podem ser consultados conforme descrito na página [API] Consultas básicas / Consultas tipo através das urls {URL_SERVICE}/adv-service/tipo?chave-tipo=usuario e {URL_SERVICE}/adv-service/tipo?chave-tipo=grupo
Incluir Processo Extra Judicial:
URL: {URL_SERVICE}/adv-service/processo-extra-judicial
Método: Post
Headers:
Content-Type : application/json
Accept : application/json
Authorization : ACCESS_TOKEN_USUARIO
Conteúdo: ProcessoExtraJudicialWs
Exemplo:
{
"assunto": "Assunto Processo Extrajudicial",
"descricao": "Descriçao do processo extrajudicial",
"situacaoProcesso": {
"chave": 1,
"valor": "Ativo"
},
"tipoProcesso": "E",
"tipoJustica": {
"chave": 10,
"valor": "Justiça Administrativa"
},
"orgaoExtraJudicial": {
"chave": 6013,
"valor": "16 Delegacia de Polícia da Capital - Santa Catarina/Florianópolis"
},
"processoNumeroWs": [{
"tipoNumeracao": "OUTROS",
"numeroDoProcesso": "89787989197",
"principal": true
}],
"tipoInstancia": "PRIMEIRA_INSTANCIA",
"responsaveis": [
{
"chave": 123,
"valor": "Advogado SAJ ADV"
}
],
"gruposDeTrabalho": [
{
"chave": 123,
"valor": "Grupo API"
}
]
}Os tipos assim como no cadastro de processos judiciais, devem ser consultados nas páginas e serviços auxiliares.
Editar Processo Judicial:
URL: {URL_SERVICE}/adv-service/processo-judicial
Método: Put
Headers:
Content-Type : application/json
Accept : application/json
Authorization : ACCESS_TOKEN_USUARIO
Conteúdo: ProcessoJudicialWs
Exemplo:
Para exemplificar a edição de um processo judicial, primeiramente será efetuado uma consulta de processos para buscar todos os dados do processo.
Obtendo processo:
URL: {URL_SERVICE}/adv-service/processo/1234
Método: Get
Headers:
Authorization : ACCESS_TOKEN_USUARIO
Retorno:
{
"andamentoWs": [],
"processoJudicialCapturado": null,
"campoDinamicoDadoWs": [],
"processoNumeroWs": [
{
"codigoProcessoNumero": 1428330,
"tipoNumeracao": "PADRAO_CNJ",
"numeroDoProcesso": "8978798-49.8491.8.82.9197",
"tipoInstancia": "PRIMEIRA_INSTANCIA",
"principal": true
}
],
"codigoProcesso": 1234,
"identificador": "PRO.0016941",
"situacaoProcesso": {
"chave": 1,
"valor": "Ativo"
},
"unidadeOrganizacionalOrigem": {
"chave": 1,
"valor": "Escritório Florianópolis"
},
"unidadeOrganizacionalAtual": {
"chave": 1,
"valor": "Escritório Florianópolis"
},
"responsaveis": [
{
"chave": 132,
"valor": "Responsável"
}
],
"gruposDeTrabalho": [
{
"chave": 159753,
"valor": "Grupo de Trabalho"
}
],
"assunto": "Assunto Processo",
"descricao": "Descriçao do processo",
"tipoProcesso": "J",
"tipoJustica": {
"chave": 8,
"valor": "Justiça dos Estados e do Distrito Federal e Territórios"
},
"tipoInstancia": "PRIMEIRA_INSTANCIA",
"segredoJustica": false,
"unidadeAtualArvore": "Escritório Florianópolis",
"orgaoJudicial": {
"chave": 82,
"valor": "CJM10 - 10ª Circunscrição Judiciária Militar - Ceará/Fortaleza"
},
"segredoJustica": false
...
}
Obtido os dados do processo, os campos que se deseja alterar devem ser substituidos e enviados no conteúdo da requisição de edição.
URL: {URL_SERVICE}/adv-service/processo-judicial
Método: Put
Headers:
Content-Type : application/json
Accept : application/json
Authorization : ACCESS_TOKEN_USUARIO
Conteúdo:
Alterado Responsáveis e Grupos de Trabalho
{
"andamentoWs": [],
"processoJudicialCapturado": null,
"campoDinamicoDadoWs": [],
"processoNumeroWs": [
{
"codigoProcessoNumero": 1428330,
"tipoNumeracao": "PADRAO_CNJ",
"numeroDoProcesso": "8978798-49.8491.8.82.9197",
"tipoInstancia": "PRIMEIRA_INSTANCIA",
"principal": true
}
],
"codigoProcesso": 1234,
"identificador": "PRO.0016941",
"situacaoProcesso": {
"chave": 1,
"valor": "Ativo"
},
"unidadeOrganizacionalOrigem": {
"chave": 1,
"valor": "Escritório Florianópolis"
},
"unidadeOrganizacionalAtual": {
"chave": 1,
"valor": "Escritório Florianópolis"
},
"responsaveis": [
{
"chave": 1324,
"valor": "Outro Responsável"
}
],
"gruposDeTrabalho": [
{
"chave": 1597534,
"valor": "Outro Grupo de Trabalho"
}
],
"assunto": "Assunto Processo",
"descricao": "Descriçao do processo",
"tipoProcesso": "J",
"tipoJustica": {
"chave": 8,
"valor": "Justiça dos Estados e do Distrito Federal e Territórios"
},
"tipoInstancia": "PRIMEIRA_INSTANCIA",
"segredoJustica": false,
"unidadeAtualArvore": "Escritório Florianópolis",
"orgaoJudicial": {
"chave": 82,
"valor": "CJM10 - 10ª Circunscrição Judiciária Militar - Ceará/Fortaleza"
},
"segredoJustica": false
...
}Editar Processo Extra Judicial:
URL: {URL_SERVICE}/adv-service/processo-extra-judicial
Método: Put
Headers:
Content-Type : application/json
Accept : application/json
Authorization : ACCESS_TOKEN_USUARIO
Conteúdo: ProcessoExtraJudicialWs
Exemplo:
Primeiramente será efetuado uma consulta de processos para buscar todos os dados do processo.
Obtendo processo:
URL: {URL_SERVICE}/adv-service/processo/123456
Método: Get
Headers:
Authorization : ACCESS_TOKEN_USUARIO
Retorno:
{
"campoDinamicoDadoWs": [],
"processoNumeroWs": [
{
"codigoProcessoNumero": 1428851,
"tipoNumeracao": "OUTROS",
"numeroDoProcesso": "89787989197",
"tipoInstancia": "PRIMEIRA_INSTANCIA",
"principal": true
}
],
"codigoProcesso": 123,
"identificador": "PRO.0010132",
"situacaoProcesso": {
"chave": 1,
"valor": "Ativo"
},
"responsaveis": [
{
"chave": 789,
"valor": "Responsável"
}
],
"gruposDeTrabalho": [
{
"chave": 456,
"valor": "Grupo"
}
],
"assunto": "Assunto Processo Extrajudicial",
"descricao": "Descriçao do processo extrajudicial",
"tipoProcesso": "E",
"tipoJustica": {
"chave": 10,
"valor": "Justiça Administrativa"
},
...
"tipoInstancia": "PRIMEIRA_INSTANCIA",
...
"completo": false,
"orgaoExtraJudicial": {
"chave": 6013,
"valor": "16 Delegacia de Polícia da Capital - Santa Catarina/Florianópolis"
}
}
Obtido os dados do processo, os campos que se deseja alterar devem ser substituidos e enviados no conteúdo da requisição de edição.
URL: {URL_SERVICE}/adv-service/processo-extra-judicial
Método: Put
Headers:
Content-Type : application/json
Accept : application/json
Authorization : ACCESS_TOKEN_USUARIO
Conteúdo:
Alteração de responsável, assunto e descrição.
{
"campoDinamicoDadoWs": [],
"processoNumeroWs": [
{
"codigoProcessoNumero": 1428851,
"tipoNumeracao": "OUTROS",
"numeroDoProcesso": "89787989197",
"tipoInstancia": "PRIMEIRA_INSTANCIA",
"principal": true
}
],
"codigoProcesso": 123,
"identificador": "PRO.0010132",
"situacaoProcesso": {
"chave": 1,
"valor": "Ativo"
},
"responsaveis": [
{
"chave": 790,
"valor": "Outro Responsável"
}
],
"gruposDeTrabalho": [
{
"chave": 456,
"valor": "Grupo"
}
],
"assunto": "Outro assunto Processo Extrajudicial",
"descricao": "Outro descriçao do processo extrajudicial",
"tipoProcesso": "E",
"tipoJustica": {
"chave": 10,
"valor": "Justiça Administrativa"
},
...
"tipoInstancia": "PRIMEIRA_INSTANCIA",
...
"completo": false,
"orgaoExtraJudicial": {
"chave": 6013,
"valor": "16 Delegacia de Polícia da Capital - Santa Catarina/Florianópolis"
}
}
Exemplo ProcessoWs:
{
"campoDinamicoDadoWs":[
{
"codigoCampoDinamicoDado":3,
"codigoCampoDinamico":3,
"codigoAba":13,
"nomeCampoDinamico":"Teste texto",
"campoDinamicoTipo":"TEXTO_CURTO",
"valorCampoTexto":"teste",
"valorCampoNumero":null,
"valorCampoData":null,
"valorCampoBoolean":false,
"visivel":true,
"obrigatorio":false,
"campoDinamicoItemLista":[
],
"campoDinamicoItemLabel":[
],
"itensSelecionadosLista":[
], "itensSelecionadosLabel":[ ], "campoDinamicoItemListaSelecionado":null, "textoAjuda":null } ], "codigoProcesso":113, "codigoAtendimento":null, "dataCadastroProcesso":null, "nomePasta":"Pasta física", "identificador":"PRO.0000073", "situacaoProcesso":{ "chave":1, "valor":"Ativo" }, "unidadeOrganizacionalOrigem":{ "chave":1, "valor":"Escritório Florianópolis" }, "unidadeOrganizacionalAtual":{ "chave":1, "valor":"Escritório Florianópolis" }, "responsaveis":[ { "chave":1, "valor":"SAJ ADV" } ], "gruposDeTrabalho":[ { "chave":1, "valor":"Administradores" } ], "pastaCliente":"Pasta de cliente", "assunto":"Assunto 5", "marcadorWs":[ { "codigoMarcador":null, "nomeMarcador":"teste" } ], "descricao":"Descrição", "tipoProcesso":"J", "tipoJustica":{ "chave":8, "valor":"Justiça dos Estados e do Distrito Federal e Territórios" }, "estado":null, "cidade":null, "vara":{ "chave":1, "valor":"1°" }, "tipoVara":{ "chave":8, "valor":"Acidentes do Trabalho" }, "complementoVara":"Complemento", "dataDistribuicao":1525143600000, "dataCitacao":1525143600000, "area":{ "chave":5, "valor":"Administrativa" }, "fase":{ "chave":1, "valor":"Conciliação" }, "dataEncerramento":null, "dataJulgamento":null, "estimativa":null, "tipoEstimativa":null, "tipoInstancia":"PRIMEIRA_INSTANCIA", "tipoProcessoRelacionadoWs":null, "codigoProcessoPai":null, "codigoIntimacao":null, "processoEnvolvidoSimplificadoWs":[ { "codigoProcessoEnvolvido":103, "nomePessoaEnvolvido":"advtestes", "codigoPessoaEnvolvido":122, "participacao":"PARTE_ATIVA", "flagPrincipal":true, "flagCliente":true }, { "codigoProcessoEnvolvido":104, "nomePessoaEnvolvido":"SAJ ADV", "codigoPessoaEnvolvido":1, "participacao":"PARTE_PASSIVA", "flagPrincipal":true, "flagCliente":false } ], "tipoProbabilidade":"EXITO", "tipoContingencia":{ "chave":1, "valor":"Contingência Passiva" }, "tipoRisco":{ "chave":3, "valor":"Possível" }, "valorAcao":1.0, "processoNumeroWs":[ { "codigoProcessoNumero":88, "tipoNumeracao":"OUTROS", "numeroDoProcesso":"1111111-11.1111.1.11.1111", "tipoInstancia":"PRIMEIRA_INSTANCIA", "principal":true }, { "codigoProcessoNumero":89, "tipoNumeracao":"PADRAO_CNJ", "numeroDoProcesso":"1111111-11.1111.1.11.1111", "tipoInstancia":"PRIMEIRA_INSTANCIA", "principal":true } ], "processoEnvolvidoWs":[ ], "dataUltimaModificacao":null, "unidadeAtualArvore":"Escritório Florianópolis", "dataRecebimento":1525143600000, "dataArquivamento":1525143600000, "valorProvisionado":1.0, "identificadorProcessoPai":null, "numeroProcessoPai":null, "codigoCapturaProcesso":null, "completo":null, "testeCodigoArrendatarioSpringContextView":null, "testeCodigoUsuarioSpringContextView":null, "testeValorAutenticacaoSpringContextView":null, "testeCodigoArrendatarioSessionView":null, "testeCodigoUsuarioSessionView":null, "testeValorAutenticacaoSessionView":null, "testeTrackView":null, "instanciaCnj":{ "chave":14, "valor":"Turma Estadual de Uniformização" }, "orgaoJudicial":{ "chave":2250, "valor":"TJGO - Abadiânia - Goiás/Abadiânia" }, "classeCnj":{ "chave":11528, "valor":"Ação Penal Eleitoral" }, "assuntoCnj":[ { "chave":11558, "valor":"Conduta Vedada a Agente Público" }, { "chave":10788, "valor":"Abuso do poder econômico" } ], "quantidadeAndamentosCapturados":null, "mergeCaptura":false, "segredoJustica":true, "senhaProcesso":"1", "andamentoWs":[ ], "centralCapturaProcessoWs":null, "processoJudicialCapturado":null}