A API de cadastros auxiliares do Themis permite consultar os registros de apoio utilizados em diversos processos de integração com o sistema. Por meio dela, é possível obter os identificadores e informações de cadastros como domínios, áreas, ações, ritos, fases, foros, instâncias, posições da parte, classificações de pessoas, cidades, contas e subcontas de despesas.
Esses dados são frequentemente utilizados como referência para o cadastro e atualização de processos, despesas e demais registros via API, garantindo que as integrações utilizem informações válidas e compatíveis com a estrutura do Themis.
Neste artigo, você encontrará a documentação completa da API de Cadastros Auxiliares do Themis, incluindo as rotas disponíveis, parâmetros de consulta e exemplos de retorno.
Importante
Para cadastrar um processo é necessário enviar o ID de referência dos cadastros auxiliares. Para consultar os cadastros auxiliares utilize as URLs abaixo.
Utilize o método GET e lembre de sempre enviar o token de autenticação no Header da requisição.
Todos estas urls retornam listas no formato JSON.
É importante ressaltar que, como a área do processo é vinculada ao domínio, há a possibilidade de filtrar pelo determinado domínio. Assim como no caso anterior, dos registros que dependem da associação à área, é possível requisitar somente os cadastros auxiliares (foro, instância, fases, ritos, ações, posições da parte, divisões do cliente) que estão vinculados a uma determinada área.
Domínios
GET http://<<servidor>>:<<porta>>/themis/api/dominios/json
Exemplo de retorno
[ {"id":12, "nome":"Contratos", "ativo":"1"}, {"id":1, "nome":"Publico - Sistema", "ativo":"1"}]
Áreas
GET http://<<servidor>>:<<porta>>/themis/api/areas/json
GET http://<<servidor>>:<<porta>>/themis/api/areas/peloDominio/{idDominio}/json
Exemplo de retorno:
[ {"id":38, "nome":"Prestação de Serviço", "dominio":{"id":12, "nome":"Contratos", "ativo":"1"}, "ativo":"1"}]
Posições da parte
GET http://<<servidor>>:<<porta>>/themis/api/posicoesDaParte/json
GET http://<<servidor>>:<<porta>>/themis/api/posicoesDaParte/pelaArea/{idArea}/json
Exemplo de retorno:
[ {"id": 1, "posAtiva": "Autor", "posPassiva": "Réu", "ativo": "1", "Areas": [ {"id": 1, "nome": "Cível", "dominio": {"id": 1, "nome": "Público - Sistema", "ativo": "1"}, "ativo": "1" }, {"id": 2, "nome": "Trabalhista", "dominio": {"id": 1, "nome": "Público - Sistema", "ativo": "1"}, "ativo": "1" } ] }]
Ações
GET http://<<servidor>>:<<porta>>/themis/api/acoes/json
GET http://<<servidor>>:<<porta>>/themis/api/acoes/pelaArea/{idArea}/json
Exemplo de retorno:
[ {"id": 2, "nome": "Reclamação Trabalhista", "ativo": "1", "areas": [ {"id": 1, "nome": "Cível", "dominio": {"id": 1, "nome": "Público - Sistema", "ativo": "1" }, "ativo": "1" }, {"id": 2, "nome": "Trabalhista", "dominio": {"id": 1, "nome": "Público - Sistema", "ativo": "1" }, "ativo": "1" }]
Ritos
GET http://<<servidor>>:<<porta>>/themis/api/ritos/json
GET http://<<servidor>>:<<porta>>/themis/api/ritos/pelaArea/{idArea}/json
Exemplo de retorno:
[ {"id": 1, "nome": "Ordinário", "ativo": "1", "areas": [ {"id": 1, "nome": "Cível", "dominio": {"id": 1, "nome": "Público - Sistema", "ativo": "1" }, "ativo": "1" }, {"id": 2, "nome": "Trabalhista", "dominio": {"id": 1, "nome": "Público - Sistema", "ativo": "1" }, "ativo": "1" }]
Fases
GET http://<<servidor>>:<<porta>>/themis/api/fases/json
GET http://<<servidor>>:<<porta>>/themis/api/fases/pelaArea/{idArea}/json
Exemplo de retorno:
[ {"id": 2, "nome": "Extrajudicial", "ativo": "1", "areas": [ {"id": 1, "nome": "Cível", "dominio": {"id": 1, "nome": "Público - Sistema", "ativo": "1" }, "ativo": "1" }, {"id": 2, "nome": "Trabalhista", "dominio": {"id": 1, "nome": "Público - Sistema", "ativo": "1" }, "ativo": "1" }]
Instâncias
GET http://<<servidor>>:<<porta>>/themis/api/instancias/json
Exemplo de retorno:
[ {"id": 1, "nome": "1ª Instância", "ordem": 1, "ativo": "1" }, {"id": 2, "nome": "2ª Instância", "ordem": 2, "ativo": "1" }, {"id": 3, "nome": "Superior", "ordem": 3, "ativo": "1" }, {"id": 4, "nome": "Supremo", "ordem": 4, "ativo": "1" }]
Foros
GET http://<<servidor>>:<<porta>>/themis/api/foros/json
GET http://<<servidor>>:<<porta>>/themis/api/foros/pelaArea/{idArea}/json
Exemplo de retorno:
[ {"id": 2, "nome": "Foro Central da Comarca de São Paulo", "regiao": {"id": 66, "nome": "Favela" }, "areas": [ {"id": 1, "nome": "Cível", "dominio": {"id": 1, "nome": "Público - Sistema", "ativo": "1" }, "ativo": "1" }, {"id": 2, "nome": "Trabalhista", "dominio": {"id": 1, "nome": "Público - Sistema", "ativo": "1" }, "ativo": "1" }]
Classificações de pessoas
GET http://<<servidor>>:<<porta>>/themis/api/classesPessoas/json
Exemplo de retorno:
[ {"id": 8, "nome": "Testemunha" }, {"id": -24, "nome": "Solicitante" }]
Cidade
path: /cidades/{idsCidades}/json
método: GET
Descrição: Lista de todas as cidades
Exemplo retorno:
[
{
"id": 115,
"text": "ABAETE - MG"
},
{
"id": 3233,
"text": "Açailandia - MA"
},
{
"id": 3234,
"text": "Acu - RN"
}
]
Contas de despesa
path: /api/despesas/contas/json
método: GET
Descrição: Lista de todas as contas.
Exemplo retorno:
[
{
"id": 1,
"nome": "Receita"
},
{
"id": 2,
"nome": "Administrativo"
}
]
path: /api/despesas/contas/{idConta}/json
método: GET
Descrição: Informações de uma única conta de acordo com seu id.
Exemplo retorno:
{
"id": 1,
"nome": "Receita"
}
Subcontas de Despesa
path: /api/despesas/subcontas/json
método: GET
Descrição: Lista de todas subcontas.
Exemplo retorno:
[
{
"id": 1,
"nome": "Honorários advocatícios"
},
{
"id": 2,
"nome": "Honorários internacionais"
}
]
path: /api/despesas/subcontas/{idSubconta}/json
método: GET
Descrição: Informações de uma única subconta de acordo com seu id.
Exemplo retorno:
{
"id": 1,
"nome": "Honorários advocatícios"
}
Ficou com alguma dúvida? Entre em contato com nosso time de suporte pelo e-mail suporte@aurum.com.br ou, se preferir, utilize o ícone de chat disponível diretamente no Themis. Estamos à disposição para ajudar.
Estes artigos podem interessar a você: