Pular para o conteúdo principal

Criar Solicitação

É possível abrir solicitações do CUBE através da nossa API.

Para a abertura de novas solicitações, existem as seguintes limitações:

cuidado
  • No momento da abertura, é realizada uma consulta no Google para identificar a latitude e longitude da solicitação. É possível que os dados de geolocalização não sejam precisos.
  • Solicitações abertas pela API são sempre gravadas com o meio de comunicação INTEGRACAO, independentemente do idMeioComunicacao enviado.
  • A solicitação é criada com o status ABERTA.

Endpoints​

MétodoURL
POSThttps://{{url}}/cube/api/v3/solicitacoes

Exemplo de Corpo JSON​

{
"descricao": "Descrição da solicitação com um limite de 15.000 caracteres.",
"idTiposolicitacao": 738,
"solicitante": {
"id": 299
},
"endereco": {
"logradouro": "Rua Bela cintra",
"numero": 1149,
"cep": "01415000",
"bairro": "Consolação",
"cidade": "São Paulo",
"uf": "SP"
},
"urlsAnexo": ["https://meuwebsite.com/arquivos/document.pdf"]
}
ChaveDescrição
descricao*Texto - Até 15.000 caracteres.
idTiposolicitacao*Numérico - ID do Tipo Solicitação do CUBE.
solicitante.idNumérico - ID da pessoa cadastrada no CUBE.
urlsAnexoLista de strings - URLs dos anexos a serem exibidos.
idFormularioNumérico - ID do formulário dinâmico do tipo solicitação (campo idFormulario de Resumo do tipo solicitação). Enviar junto com idRegistroFormulario.
idRegistroFormularioNumérico - ID do registro do formulário, gravado antes em Criar registro de formulário.
endereco*Depende da configuração do Tipo Solicitação.
idAtendimentoNumérico - ID do atendimento ao qual a solicitação será vinculada (ver Iniciar Atendimento). Quando solicitante não é enviado, usa a pessoa vinculada ao atendimento. Em desenvolvimento - ainda não disponível em produção.
dica

Os campos marcados com * são obrigatórios.

Solicitação com formulário dinâmico​

Quando o tipo solicitação tem formulário dinâmico, preencha o formulário antes de abrir a solicitação:

  1. Consulte o idFormulario do tipo em Resumo do tipo solicitação.
  2. Consulte os campos em Consultar modelo de registro.
  3. Grave o registro em Criar registro de formulário, que devolve o idRegistro.
  4. Abra a solicitação enviando idFormulario e idRegistroFormulario (o idRegistro do passo anterior).

A solicitação fica vinculada ao registro, e o formulário preenchido aparece nos detalhes da solicitação no CUBE.

Respostas​

Exemplo de corpo da resposta​

{
"status": "ok",
"idSolicitacao": 1234567,
"idAtendimento": 456,
"protocolo": "1234567",
"dataLimite": "2026-11-06T14:12:05.000Z"
}
ChaveDescrição
statusok quando a solicitação foi criada
idSolicitacaoID da solicitação criada
idAtendimentoID do atendimento vinculado, quando idAtendimento foi enviado. Em desenvolvimento.
avisoerro.vincular.atendimento quando a solicitação foi criada mas o vínculo com o atendimento falhou. Em desenvolvimento.
protocoloProtocolo da solicitação. Em desenvolvimento.
dataLimitePrazo para conclusão da solicitação, quando já definido no momento da criação. Em desenvolvimento.

Status da resposta​

StatusDescrição
200OK - Solicitação cadastrada com sucesso.
400Erro ao criar a solicitação (erro.criar.solicitacao), atendimento informado não encontrado (id.atendimento.invalido) ou tipo que não aceita novas solicitações, por exemplo inativo (tipo.solicitacao.indisponivel, Em desenvolvimento - ainda não disponível em produção.)
404Usuário não possui a permissão vinculada ao usuário.

Permissões necessárias​

PermissãoDescrição
resolucao:solicitacoes:abrir:novaPermite a abertura de solicitações via API.