Endpoint

Recuperar da Lixeira

POST/api/v1/{escritorio}/lixeira/recuperar

Recupera um item da Lixeira (tipo e id como vêm de listar_lixeira): ele volta como era, com os mesmos identificadores, e a recuperação fica nos logs. É tudo ou nada. Fora do alcance ou inexistente: 404. Já recuperado: 409 JA_RECUPERADO. Mais de 30 dias: 409 PRAZO_LIXEIRA. Cliente anonimizado: 409 JA_ANONIMIZADO. Cliente ou processo do item (ou o departamento do subdepartamento) na Lixeira: 409 RECUPERE_ANTES. Etiqueta, campo ou departamento com o nome já usado: 409 NOME_EM_USO. Litisconsorte que já voltou ao processo: 409 CLIENTE_JA_NO_PROCESSO; com valores, num processo que passou a ser relacionado de outro: 409 FINANCEIRO_NA_RAIZ. CPF, CNPJ ou número de processo que passou a estar em outro cadastro: 409 CPF_EM_USO, CNPJ_EM_USO ou NUMERO_EM_USO.

Permissão exigida

Administração: Gerenciar Lixeira (e o alcance por departamento)

Só leitura recusa com 403

Parâmetros de caminho

escritoriotextoobrigatório
Código do escritório, com 5 dígitos. Os escritórios em que o token vale estão em GET /api/v1/eu.

Parâmetros de cabeçalho

Idempotency-Keytexto
Opcional. Uma chave única por operação (por exemplo, um UUID). Se o mesmo pedido for reenviado com a mesma chave em até 24 horas, a resposta da primeira vez é devolvida e nada é criado de novo.

Corpo

tipotextoobrigatório
CLIENTE, PROCESSO, ANEXO, PECA (peça), TRABALHO, PRAZO, ETIQUETA, CAMPO (campo personalizado), PARTE (parte do processo), RESPONSAVEL_PJ (responsável da empresa), LANCAMENTO (despesa ou custa), LITISCONSORTE (cliente removido do processo, com os valores e as parcelas dele) ou DEPARTAMENTO (com os status, os campos e os valores deles).
Valores: CLIENTEPROCESSOANEXOPECATRABALHOPRAZOETIQUETACAMPOPARTERESPONSAVEL_PJLANCAMENTOLITISCONSORTEDEPARTAMENTO
idtextoobrigatório
O id do item em listar_lixeira.

Testar

Exemplo

cURL

curl -X POST "https://developer.jur.ia2s.com.br/api/v1/10345/lixeira/recuperar" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "tipo": "PRAZO",
  "id": "0190a000-0000-7000-8000-000000000001"
}'

Node

// Node 18 ou mais novo, em um arquivo .mjs
const resposta = await fetch("https://developer.jur.ia2s.com.br/api/v1/10345/lixeira/recuperar", {
  method: "POST",
  headers: {
    Authorization: "Bearer SEU_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "tipo": "PRAZO",
    "id": "0190a000-0000-7000-8000-000000000001"
  }),
});
console.log(resposta.status, await resposta.json());

Python

import requests

resposta = requests.post(
    "https://developer.jur.ia2s.com.br/api/v1/10345/lixeira/recuperar",
    headers={"Authorization": "Bearer SEU_TOKEN"},
    json={
        "tipo": "PRAZO",
        "id": "0190a000-0000-7000-8000-000000000001",
    },
)
print(resposta.status_code)
print(resposta.json())

Respostas

200

Sucesso.

{
  "ok": true
}

Campos da resposta

oktrueobrigatório

400

Corpo ou parâmetro inválido.

INVALIDO

{
  "codigo": "INVALIDO",
  "mensagem": "Confira os dados informados.",
  "campos": {
    "departamentoId": "Valor inválido."
  }
}

CHAVE_IDEMPOTENCIA_INVALIDA

{
  "codigo": "CHAVE_IDEMPOTENCIA_INVALIDA",
  "mensagem": "A Idempotency-Key deve ter de 1 a 255 caracteres visíveis, sem espaços."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

401

Sem token, ou token revogado ou expirado, ou pessoa desativada.

TOKEN_INVALIDO

{
  "codigo": "TOKEN_INVALIDO",
  "mensagem": "Token de API inválido, expirado ou revogado."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

403

A pessoa não pode fazer isto, o token é só de leitura, foi bloqueado neste escritório, não tem esta operação, quem o gerou saiu do escritório ou o acesso ao escritório está suspenso.

SEM_PERMISSAO

{
  "codigo": "SEM_PERMISSAO",
  "mensagem": "Sem permissão para esta alteração."
}

TOKEN_SO_LEITURA

{
  "codigo": "TOKEN_SO_LEITURA",
  "mensagem": "Este token é só de leitura."
}

TOKEN_SEM_ESCOPO

{
  "codigo": "TOKEN_SEM_ESCOPO",
  "mensagem": "Este token não tem permissão para esta operação."
}

TOKEN_BLOQUEADO

{
  "codigo": "TOKEN_BLOQUEADO",
  "mensagem": "Este token foi bloqueado pela administração deste escritório."
}

TOKEN_AUTOR_INATIVO

{
  "codigo": "TOKEN_AUTOR_INATIVO",
  "mensagem": "Quem gerou este token não está mais ativo neste escritório."
}

ESCRITORIO_SUSPENSO

{
  "codigo": "ESCRITORIO_SUSPENSO",
  "mensagem": "O acesso a este escritório está suspenso. Fale com a IA2S."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

404

Não existe, está fora do alcance da pessoa, ou o escritório do caminho não é dela.

NAO_ENCONTRADO

{
  "codigo": "NAO_ENCONTRADO",
  "mensagem": "Não encontrado."
}

ESCRITORIO_NAO_ENCONTRADO

{
  "codigo": "ESCRITORIO_NAO_ENCONTRADO",
  "mensagem": "Escritório não encontrado."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

409

Conflito: veja o campo `codigo`.

TENTE_NOVAMENTE

{
  "codigo": "TENTE_NOVAMENTE",
  "mensagem": "Outra pessoa alterou isto ao mesmo tempo. Tente novamente."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

413

Corpo da requisição grande demais.

CORPO_GRANDE

{
  "codigo": "CORPO_GRANDE",
  "mensagem": "O corpo da requisição é grande demais."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

422

A `Idempotency-Key` já foi usada com outro pedido.

CHAVE_IDEMPOTENCIA_REUTILIZADA

{
  "codigo": "CHAVE_IDEMPOTENCIA_REUTILIZADA",
  "mensagem": "Esta Idempotency-Key já foi usada com outro pedido."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

429

Limite de 120 requisições por minuto.

Cabeçalho Retry-After: Segundos até poder tentar de novo.

LIMITE_TOKEN

{
  "codigo": "LIMITE_TOKEN",
  "mensagem": "Muitas requisições com este token. Tente de novo em um minuto."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório

503

O sistema está ocupado. Tente em instantes.

SISTEMA_OCUPADO

{
  "codigo": "SISTEMA_OCUPADO",
  "mensagem": "O sistema está ocupado. Tente em instantes."
}

Campos da resposta

codigotextoobrigatório
Código estável do erro.
mensagemtextoobrigatório
Mensagem em português.
camposobjeto
No 400, a mensagem de cada campo inválido.
clienteobjeto
No 409 CPF_EM_USO/CNPJ_EM_USO, o outro cliente, quando a pessoa dona do token pode vê-lo.
- codigotextoobrigatório
- nometextoobrigatório
processoobjeto
No 409 NUMERO_EM_USO, o outro processo, quando a pessoa dona do token pode vê-lo.
- idtextoobrigatório
- clienteCodigotextoobrigatório
- clienteNometextoobrigatório