Pular para o conteúdo principal

Manifestações e fluxos

Demandas (casos), mensagens, notas, atribuição, etapas, quadros, workflows e tipos de solicitação.

📄️Atualizar configurações de solicitações

Altera o fuso horário (`timezone`) das solicitações da organização; um fuso desconhecido retorna `422`. Requer a permissão `requests.settings.manage` e exige acesso a todas as empresas (`403` caso contrário), com concorrência otimista por `expected_version` (versão divergente retorna `409`). Idempotente por `request_nonce`: o mesmo corpo repetido em até 7 dias devolve o resultado guardado (`replayed: true`); outro corpo com o mesmo valor retorna `409`.

📄️Criar workflow

Cria um workflow local a partir de um modelo da biblioteca ou da cópia de uma versão existente (`source`); o workflow nasce desativado, com um primeiro rascunho, e só pode ser ativado após publicado. Requer a permissão `requests.workflows.manage` e exige acesso a todas as empresas (`403` caso contrário); chave já usada ou limite de 200 workflows retornam `409`. Idempotente por `request_nonce`: o mesmo corpo repetido em até 7 dias devolve o resultado guardado (`replayed: true`); outro corpo com o mesmo valor retorna `409`.

📄️Criar tipo de solicitação

Cria um tipo de solicitação em uma categoria, copiando outro tipo ou em branco sobre um workflow publicado (`source`); nasce com um primeiro rascunho. Requer a permissão `requests.types.manage` e exige acesso a todas as empresas (`403` caso contrário); chave já usada, workflow sem versão publicada ou limite de 300 tipos retornam `409`. Idempotente por `request_nonce`: o mesmo corpo repetido em até 7 dias devolve o resultado guardado (`replayed: true`); outro corpo com o mesmo valor retorna `409`.

📄️Abrir rascunho do workflow

Abre um rascunho a partir da versão publicada atual, informada em `based_on_version_id`; `workflow_id` no caminho é o código público do workflow. Requer a permissão `requests.workflows.manage` e exige acesso a todas as empresas (`403` caso contrário); já existir rascunho ou a versão base não ser a publicada atual retorna `409`. Idempotente por `request_nonce`: o mesmo corpo repetido em até 7 dias devolve o resultado guardado (`replayed: true`); outro corpo com o mesmo valor retorna `409`.

📄️Salvar rascunho do workflow

Substitui a definição do rascunho; a estrutura é validada ao salvar (`422` se inválida) e a chave e o número da versão são mantidos. Requer a permissão `requests.workflows.manage` e exige acesso a todas as empresas (`403` caso contrário), com concorrência otimista por `expected_version` (versão divergente retorna `409`). Idempotente por `request_nonce`: o mesmo corpo repetido em até 7 dias devolve o resultado guardado (`replayed: true`); outro corpo com o mesmo valor retorna `409`.

📄️Publicar rascunho do workflow

Valida e publica o rascunho como nova versão atual; os tipos de solicitação que usavam a versão anterior ganham nova revisão publicada, e demandas existentes mantêm sua versão. Requer a permissão `requests.workflows.publish` e exige acesso a todas as empresas (`403` caso contrário) e não aceita chave de API (`403`). Pendências retornam `422`; `expected_version` divergente ou rascunho desatualizado retornam `409`. Idempotente por `request_nonce`: o mesmo corpo repetido em até 7 dias devolve o resultado guardado (`replayed: true`); outro corpo com o mesmo valor retorna `409`.

📄️Descartar rascunho do workflow

Descarta o rascunho de um workflow; o primeiro rascunho de um workflow nunca publicado não pode ser descartado (`409`). Requer a permissão `requests.workflows.manage` e exige acesso a todas as empresas (`403` caso contrário), com concorrência otimista por `expected_version` (versão divergente retorna `409`). Idempotente por `request_nonce`: o mesmo corpo repetido em até 7 dias devolve o resultado guardado (`replayed: true`); outro corpo com o mesmo valor retorna `409`.

📄️Ativar ou desativar workflow

Ativa ou desativa um workflow (`enabled`), com `reason_code` opcional; ativar sem versão publicada retorna `409`, a resposta traz `affected_request_types` e `workflow_id` no caminho é o código público do workflow. Requer a permissão `requests.workflows.activate` e exige acesso a todas as empresas (`403` caso contrário), com concorrência otimista por `expected_version` (versão divergente retorna `409`). Idempotente por `request_nonce`: o mesmo corpo repetido em até 7 dias devolve o resultado guardado (`replayed: true`); outro corpo com o mesmo valor retorna `409`.

📄️Reordenar workflows

Define a ordem completa dos workflows: `ids` deve conter exatamente os workflows atuais, sem repetição (`422` caso contrário). Requer a permissão `requests.workflows.order` e exige acesso a todas as empresas (`403` caso contrário). Usa `expected_catalog_revision` para concorrência (revisão divergente retorna `409`). Idempotente por `request_nonce`: o mesmo corpo repetido em até 7 dias devolve o resultado guardado (`replayed: true`); outro corpo com o mesmo valor retorna `409`.

📄️Ativar ou desativar categoria

Ativa ou desativa uma categoria (`enabled`), com `reason_code` opcional; a resposta indica `unchanged` se nada mudou. Requer a permissão `requests.workflows.activate` e exige acesso a todas as empresas (`403` caso contrário), com concorrência otimista por `expected_version` (versão divergente retorna `409`). Idempotente por `request_nonce`: o mesmo corpo repetido em até 7 dias devolve o resultado guardado (`replayed: true`); outro corpo com o mesmo valor retorna `409`.

📄️Reordenar categorias

Define a ordem completa das categorias: `ids` deve conter exatamente as categorias atuais, sem repetição (`422` caso contrário). Requer a permissão `requests.workflows.order` e exige acesso a todas as empresas (`403` caso contrário). Usa `expected_catalog_revision` para concorrência (revisão divergente retorna `409`). Idempotente por `request_nonce`: o mesmo corpo repetido em até 7 dias devolve o resultado guardado (`replayed: true`); outro corpo com o mesmo valor retorna `409`.

📄️Abrir rascunho do tipo de solicitação

Abre um rascunho a partir da revisão publicada atual, informada em `based_on_revision_id`; `request_type_id` no caminho é o código público do tipo de solicitação. Requer a permissão `requests.types.manage` e exige acesso a todas as empresas (`403` caso contrário); já existir rascunho ou a revisão base não ser a atual retorna `409`. Idempotente por `request_nonce`: o mesmo corpo repetido em até 7 dias devolve o resultado guardado (`replayed: true`); outro corpo com o mesmo valor retorna `409`.

📄️Salvar rascunho do tipo de solicitação

Substitui a definição do rascunho e, opcionalmente, a categoria de destino (`category_id`, aplicada ao publicar); o workflow citado precisa ter versão publicada (`422` caso contrário). Requer a permissão `requests.types.manage` e exige acesso a todas as empresas (`403` caso contrário), com concorrência otimista por `expected_version` (versão divergente retorna `409`). Idempotente por `request_nonce`: o mesmo corpo repetido em até 7 dias devolve o resultado guardado (`replayed: true`); outro corpo com o mesmo valor retorna `409`.

📄️Publicar rascunho do tipo de solicitação

Valida e publica o rascunho como revisão atual do tipo, aplicando nome, canal, proteção e categoria nova, se houver. Requer a permissão `requests.workflows.publish` e exige acesso a todas as empresas (`403` caso contrário) e não aceita chave de API (`403`). Pendências ou grupo de limite incompatível retornam `422`; `expected_version` divergente ou rascunho desatualizado retornam `409`. Idempotente por `request_nonce`: o mesmo corpo repetido em até 7 dias devolve o resultado guardado (`replayed: true`); outro corpo com o mesmo valor retorna `409`.

📄️Descartar rascunho do tipo de solicitação

Descarta o rascunho de um tipo de solicitação; o primeiro rascunho de um tipo nunca publicado não pode ser descartado (`409`). Requer a permissão `requests.types.manage` e exige acesso a todas as empresas (`403` caso contrário), com concorrência otimista por `expected_version` (versão divergente retorna `409`). Idempotente por `request_nonce`: o mesmo corpo repetido em até 7 dias devolve o resultado guardado (`replayed: true`); outro corpo com o mesmo valor retorna `409`.

📄️Ativar ou desativar tipo de solicitação

Ativa ou desativa um tipo de solicitação (`enabled`), com `reason_code` opcional; ativar sem revisão publicada retorna `409`, e `request_type_id` no caminho é o código público do tipo de solicitação. Requer a permissão `requests.workflows.activate` e exige acesso a todas as empresas (`403` caso contrário), com concorrência otimista por `expected_version` (versão divergente retorna `409`). Idempotente por `request_nonce`: o mesmo corpo repetido em até 7 dias devolve o resultado guardado (`replayed: true`); outro corpo com o mesmo valor retorna `409`.

📄️Reordenar tipos de solicitação

Define a ordem completa dos tipos de uma categoria (`category_id`): `ids` deve conter exatamente os tipos atuais, sem repetição (`422` caso contrário). Requer a permissão `requests.workflows.order` e exige acesso a todas as empresas (`403` caso contrário). Usa `expected_catalog_revision` para concorrência (`409` se divergente). Idempotente por `request_nonce`: o mesmo corpo repetido em até 7 dias devolve o resultado guardado (`replayed: true`); outro corpo com o mesmo valor retorna `409`.

📄️Designar custodiante da fila restrita

Designa um membro ativo da organização (`identity_id`) como custodiante da fila restrita, com `reason_code`; se já for, a resposta indica `unchanged`. Requer as permissões `requests.settings.manage` e `requests.restricted.manage` e acesso a todas as empresas; não aceita chave de API (`403`). Pessoa que não é membro ativo retorna `422`. Idempotente por `request_nonce`: o mesmo corpo repetido em até 7 dias devolve o resultado guardado (`replayed: true`); outro corpo com o mesmo valor retorna `409`.

📄️Criar demanda

Abre uma demanda de um tipo de solicitação, validando `values` contra o formulário da revisão informada em `revision_id`; se a revisão publicada mudou, retorna `409` `requests_form_version_changed`. Aceita `upload_context_id` para levar arquivos enviados antes da abertura e `assignee_id` para já atribuir um responsável, o que exige `requests.demands.assign` (salvo para si mesmo) e um membro elegível (senão `422` `requests_assignee_ineligible`). Idempotente por `request_nonce`: repetir o mesmo pedido devolve o resultado original e reutilizar o nonce com outro conteúdo retorna `409` (`requests_nonce_conflict`). Requer a permissão `requests.demands.create`.

📄️Enviar mensagem na demanda

Publica uma mensagem pública ou uma nota interna (`visibility`), com até 4000 caracteres, opcionalmente corrigindo uma mensagem anterior (`corrects_id`). Mensagem pública exige `requests.messages.send` e uma demanda visível ao solicitante; nota interna exige `requests.messages.internal_write`, além de `requests.demands.read`. Não usa `expected_version`; idempotente por `request_nonce`: repetir o mesmo pedido devolve o resultado original e reutilizar o nonce com outro conteúdo retorna `409` (`requests_nonce_conflict`).

📄️Executar transição da demanda

Move a demanda pela transição `transition_key` da versão de workflow fixada nela, com motivo, campos da etapa, entregas e pendências em `inputs`. Valida os campos e exige papel e permissão da transição; ação indisponível retorna `409` `requests_transition_invalid` e pendências obrigatórias retornam `409` `requests_requirements_pending`. Idempotente por `request_nonce` (mesmo nonce com outro conteúdo retorna `409`) e com concorrência otimista por `expected_version` (versão divergente retorna `409`). Requer a permissão `requests.demands.read` além da permissão da própria transição.

📄️Adicionar atividade à demanda

Cria uma atividade avulsa na demanda, com rótulo, motivo, obrigatoriedade, responsável e prazo opcionais; o responsável é notificado. Aceita até 100 atividades por demanda (`409` `requests_limit_exceeded`) e não vale para demanda encerrada. Idempotente por `request_nonce` (mesmo nonce com outro conteúdo retorna `409`) e com concorrência otimista por `expected_version` (versão divergente retorna `409`). Requer a permissão `requests.demands.transition`.

📄️Definir acesso a caso protegido

Concede ou revoga (`grant`) o acesso nominal de uma pessoa a uma demanda da fila restrita, com `reason_code`. Quando a organização definiu autoridades de casos protegidos, só quem pode conceder neste caso tem acesso; caso contrário, exige `requests.restricted.manage`. Apenas pessoas, nunca chave de API; quem não pode conceder recebe `404` e pessoa impedida retorna `409` `requests_impeded`. Idempotente por `request_nonce`: repetir o mesmo pedido devolve o resultado original e reutilizar o nonce com outro conteúdo retorna `409` (`requests_nonce_conflict`).

📄️Criar lembrete na demanda

Agenda um lembrete para quem criou, para o responsável ou para ambos (`audience`), opcionalmente ligado a uma atividade aberta. `remind_local` é um horário no fuso da organização, sem offset, entre agora e 2 anos, e cada demanda aceita até 20 lembretes pendentes por demanda (`409` `requests_limit_exceeded`). Idempotente por `request_nonce` (mesmo nonce com outro conteúdo retorna `409`) e com concorrência otimista por `expected_version` (versão divergente retorna `409`). Requer a permissão `requests.demands.transition`.

📄️Criar vínculo da demanda

Vincula a demanda a outro registro (`kind` e `target_id`). Tipo de vínculo desconhecido ou registro que não pode ser associado retorna `422` `requests_relation_unavailable`; aceita até 20 vínculos ativos (`409` `requests_limit_exceeded`) e não vale para demanda encerrada. Idempotente por `request_nonce` (mesmo nonce com outro conteúdo retorna `409`) e com concorrência otimista por `expected_version` (versão divergente retorna `409`). Requer a permissão `requests.demands.triage`.

📄️Abrir contexto de envio de arquivos

Abre um contexto para enviar arquivos antes de criar a demanda, para o tipo de solicitação, a revisão e o sujeito informados; ele expira em 24 horas e aceita arquivos de até 10 MiB. Revisão desatualizada retorna `409` `requests_form_version_changed` e sujeito não aceito retorna `422`. Idempotente por `request_nonce`: repetir o mesmo pedido devolve o resultado original e reutilizar o nonce com outro conteúdo retorna `409` (`requests_nonce_conflict`). Requer as permissões `requests.demands.create` e `requests.attachments.manage`.

📄️Enviar anexo à demanda

Envia um arquivo em `multipart/form-data` (`file`, `request_nonce` e, opcionalmente, `visibility`, `target_kind` e `target_id`) ligado à demanda, a uma mensagem ou a uma entrega. Aceita PDF, JPEG ou PNG de até 10 MiB e até 100 anexos por demanda; anexo público exige demanda visível ao solicitante e interno exige `requests.messages.internal_write`. Demanda encerrada retorna `409` e o `demand_id` no caminho é o código público da demanda. Requer a permissão `requests.attachments.manage`.

📄️Baixar anexo da demanda

Baixa o conteúdo do anexo (`attachment_id`, UUID), com autorização verificada no momento do download e resposta `Content-Disposition: attachment` sem cache. Anexo interno exige `requests.messages.internal_read`; arquivo em verificação de segurança retorna `409` `requests_attachment_quarantined`. O `demand_id` no caminho é o código público de 4 caracteres da demanda; demanda inexistente ou fora do seu alcance responde `404`. Requer a permissão `requests.attachments.read`.