Manifestações e fluxos
Demandas (casos), mensagens, notas, atribuição, etapas, quadros, workflows e tipos de solicitação.
Consultar capacidades do módulo
Informa se o módulo de solicitações está ativo, o estado de preparação do catálogo (`setup_state`), a revisão do catálogo, o escopo de empresas e quais ações de configuração a pessoa ou chave pode executar. Responde mesmo com o módulo desligado ou o catálogo em preparação. Qualquer membro autenticado da organização pode chamar.
Consultar configurações de solicitações
Retorna as configurações de solicitações da organização, como o fuso horário. Requer a permissão `requests.workflows.read`. Pode ser lida mesmo com o catálogo em preparação ou com falha, para que a administração veja um estado recuperável.
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`.
Listar modelos da biblioteca
Lista os modelos de workflow e de categoria da biblioteca de fábrica. Requer a permissão `requests.templates.read`. Listagem paginada no envelope `{items, page}` com `limit`/`cursor`, `sort`, `q` e `filter`. Retorna `503` enquanto o catálogo da organização está sendo preparado.
Consultar modelo da biblioteca
Retorna o conteúdo de uma revisão de um modelo da biblioteca, identificado por `kind` (`workflow` ou `category`), `key` e `revision`. Requer a permissão `requests.templates.read`. Modelo ou revisão inexistente retorna `404`.
Listar categorias
Lista as categorias de tipos de solicitação da organização, por padrão na ordem de exibição. Requer a permissão `requests.workflows.read`. Listagem paginada no envelope `{items, page}` com `limit`/`cursor`, `sort`, `q` e `filter`. Retorna `503` enquanto o catálogo da organização está sendo preparado.
Criar categoria
Cria uma categoria com `key`, `name`, `description` e workflow padrão opcional. Requer a permissão `requests.types.manage` e exige acesso a todas as empresas (`403` caso contrário); chave já usada retorna `409` e o limite de 100 categorias 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`.
Listar workflows
Lista os workflows da organização, por padrão na ordem de exibição. Requer a permissão `requests.workflows.read`. Listagem paginada no envelope `{items, page}` com `limit`/`cursor`, `sort`, `q` e `filter`. Retorna `503` enquanto o catálogo da organização está sendo preparado.
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`.
Consultar workflow
Retorna o resumo do workflow e sua versão publicada atual, se houver. `workflow_id` no caminho é o código público do workflow. Requer a permissão `requests.workflows.read`. Workflow inexistente retorna `404`.
Listar versões do workflow
Lista as versões de um workflow (publicadas, rascunho e descartadas), por padrão da mais recente para a mais antiga. `workflow_id` no caminho é o código público do workflow. Requer a permissão `requests.workflows.read`. Listagem paginada no envelope `{items, page}` com `limit`/`cursor`, `sort`, `q` e `filter`.
Consultar versão do workflow
Retorna uma versão de workflow com sua definição completa; `version_id` é o UUID da versão. Requer a permissão `requests.workflows.read`. Versão inexistente retorna `404`.
Listar tipos de solicitação
Lista os tipos de solicitação da organização. Requer a permissão `requests.workflows.read`. Listagem paginada no envelope `{items, page}` com `limit`/`cursor`, `sort`, `q` e `filter`. Retorna `503` enquanto o catálogo da organização está sendo preparado.
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`.
Consultar tipo de solicitação
Retorna o resumo do tipo de solicitação e sua revisão publicada atual, se houver. `request_type_id` no caminho é o código público do tipo de solicitação. Requer a permissão `requests.workflows.read`. Tipo inexistente retorna `404`.
Consultar revisão do tipo de solicitação
Retorna uma revisão de tipo de solicitação com sua definição completa; `revision_id` é o UUID da revisão. Requer a permissão `requests.workflows.read`. Revisão inexistente retorna `404`.
Listar histórico de configuração
Lista as alterações de configuração de solicitações (criações, publicações, ativações, reordenações, custódia), da mais recente para a mais antiga. Requer a permissão `requests.workflows.read`. Listagem paginada no envelope `{items, page}` com `limit`/`cursor`, `sort`, `q` e `filter`. Retorna `503` enquanto o catálogo da organização está sendo preparado.
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`.
Consultar rascunho do workflow
Retorna um rascunho de workflow com sua definição; `draft_id` é o UUID da versão em rascunho. Requer a permissão `requests.workflows.read`. Se a versão não estiver em rascunho, retorna `404`.
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`.
Validar rascunho do workflow
Verifica as regras de publicação do rascunho, incluindo os tipos de solicitação afetados, sem alterar nada. Retorna `valid`, até 100 `problems` e `affected_request_types`. Requer a permissão `requests.workflows.read`.
Pré-visualizar rascunho do workflow
Simula o que um papel (`actor`: solicitante, operador, aprovador, executor ou sistema) pode fazer a partir de uma etapa (`stage_key`, inicial por padrão), com transições, campos obrigatórios e condições. Nada é criado ou enviado. Requer a permissão `requests.workflows.read`. Etapa inexistente retorna `422`.
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`.
Atualizar categoria
Altera nome, descrição ou workflow padrão de uma categoria; `category_id` é o UUID. 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 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`.
Consultar rascunho do tipo de solicitação
Retorna um rascunho de tipo de solicitação com sua definição; `draft_id` é o UUID da revisão em rascunho. Requer a permissão `requests.workflows.read`. Se a revisão não estiver em rascunho, retorna `404`.
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`.
Validar rascunho do tipo de solicitação
Verifica as regras de publicação do rascunho contra a versão publicada do workflow, sem alterar nada. Retorna `valid` e até 100 `problems`. Requer a permissão `requests.workflows.read`.
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`.
Listar custodiantes da fila restrita
Lista as pessoas com custódia ativa da fila restrita, com motivo e data da designação. Requer a permissão `requests.settings.manage`. Exige acesso a todas as empresas (`403` caso contrário).
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`.
Revogar custodiante da fila restrita
Revoga a custódia da fila restrita, com `reason_code`; `custodian_id` é o UUID da designação. Requer as permissões `requests.settings.manage` e `requests.restricted.manage` e acesso a todas as empresas; não aceita chave de API (`403`). Revogar o último custodiante 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`.
Listar demandas
Lista as demandas visíveis para quem chama, respeitando o escopo de empresas e o acesso nominal a casos da fila restrita. Cada item traz as etiquetas e a foto do responsável. Listagem paginada no envelope `{items, page}` com `limit`, `cursor`, ordenação e filtros permitidos. Requer a permissão `requests.demands.read`.
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`.
Listar lembretes de demandas
Lista os lembretes (pendentes, enviados ou ignorados) das demandas que você pode ver. Listagem paginada no envelope `{items, page}` com `limit`, `cursor`, ordenação e filtros permitidos. Requer a permissão `requests.demands.read`.
Listar vínculos entre demandas
Lista os vínculos ativos das demandas que você pode ver, com o tipo do vínculo, o registro de destino e seu rótulo. Listagem paginada no envelope `{items, page}` com `limit`, `cursor`, ordenação e filtros permitidos. Requer a permissão `requests.demands.read`.
Consultar contadores de demandas
Retorna, para cada fase (`pending`, `in_progress`, `waiting`, `scheduled`, `closed`), o total de demandas no seu escopo, quantas estão sem responsável, quantas são urgentes e quantas aguardam reatribuição. Requer a permissão `requests.demands.read`.
Listar meu trabalho
Lista as atividades em aberto atribuídas a você e as demandas abertas sob sua responsabilidade, indicando atividades bloqueadas por dependências. Listagem paginada no envelope `{items, page}` com `limit`, `cursor`, ordenação e filtros permitidos. Requer a permissão `requests.demands.read`.
Listar quadros de demandas
Lista os quadros disponíveis: cada versão publicada de workflow que é a atual ou que ainda tem demandas, com o total de demandas abertas. Requer a permissão `requests.demands.read`.
Consultar quadro de demandas
Retorna as colunas do quadro de uma versão publicada de workflow (`version_id`, UUID): cada etapa com rótulo, fase, cor, ícone, total de demandas e quantas estão sem responsável. Versão inexistente ou não publicada retorna `404`. Requer a permissão `requests.demands.read`.
Consultar calendário de demandas
Retorna as datas administrativas das demandas visíveis entre `from` e `to`: agendamentos, prazos de atividades, prazos de resposta e datas de efetivação de entregas. O intervalo deve ser válido e ter no máximo 92 dias, senão retorna `422`. Requer a permissão `requests.demands.read`.
Listar tipos de solicitação para abertura
Lista os tipos de solicitação que podem ser abertos agora (tipo, categoria e workflow ativos, com revisão publicada), com a revisão vigente e os tipos de sujeito aceitos. Requer a permissão `requests.demands.create`.
Consultar formulário de abertura
Retorna o formulário da revisão publicada de um tipo de solicitação (`request_type_id`, UUID), com instruções, tipos de sujeito, elegibilidade e a data de hoje da organização. Use o `revision_id` retornado ao criar a demanda. Tipo indisponível retorna `409` `requests_workflow_unavailable`. Requer a permissão `requests.demands.create`.
Consultar demanda
Retorna o detalhe completo da demanda, incluindo atividades, lembretes, vínculos, etiquetas e pessoas envolvidas. Quando a demanda é uma manifestação do canal de denúncias, a leitura é registrada na trilha de auditoria e pode exigir segundo fator. 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.demands.read`.
Listar transições disponíveis
Lista as transições que você pode executar agora a partir da etapa atual, conforme seus papéis e permissões, com campos obrigatórios, consequências e impedimentos. Chaves de API só veem transições que as permitem. 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.demands.read`.
Listar mensagens da demanda
Lista a conversa da demanda em ordem. Mensagens públicas exigem `requests.demands.read`; notas internas só aparecem para quem tem `requests.messages.internal_read`. O `demand_id` no caminho é o código público de 4 caracteres da demanda; demanda inexistente ou fora do seu alcance responde `404`.
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`).
Listar histórico da demanda
Retorna a linha do tempo de eventos da demanda, com autor e detalhes. Eventos de notas internas e motivos de mudanças de proteção só aparecem para quem tem `requests.messages.internal_read`. 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.history.read`.
Listar candidatos a responsável
Lista os membros ativos que podem assumir a demanda (até 500), indicando o responsável atual. 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.demands.assign`.
Listar candidatos a responsável na abertura
Lista quem pode assumir uma demanda deste tipo antes de ela existir, para o tipo de sujeito `kind` e, opcionalmente, a empresa `company_id`. É apenas uma conveniência: a abertura verifica de novo o membro escolhido. Requer as permissões `requests.demands.assign` e `requests.demands.create`.
Listar membros para sujeito da demanda
Lista membros ativos da organização que podem ser indicados como sujeito do tipo `member`, com você em primeiro lugar e busca opcional por nome ou e-mail em `q` (até 200 resultados). A abertura verifica de novo o membro escolhido. Requer a permissão `requests.demands.create`.
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.
Cancelar demanda
Cancela uma demanda em aberto pela transição de cancelamento do workflow, com motivo obrigatório. Demanda já encerrada retorna `409` `requests_transition_invalid`. 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.cancel`.
Marcar demanda como duplicada
Encerra a demanda como duplicada de outra (`principal_id`), com motivo obrigatório. Demanda já encerrada retorna `409` `requests_transition_invalid`. 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.cancel`.
Reabrir demanda
Reabre uma demanda encerrada em um novo ciclo, voltando à etapa anterior ao encerramento, com motivo obrigatório. Demanda não encerrada ou ligada a registro que impede reabertura retorna `409` `requests_transition_invalid`. 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.reopen`.
Decidir pedido de reabertura
Aceita ou recusa (`decision`) um pedido de reabertura feito pelo solicitante, com motivo. Aceitar reabre a demanda; recusar mantém o resultado e envia o motivo como mensagem pública (pedido já decidido retorna `409`). 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.reopen`.
Atribuir responsável pela demanda
Define ou remove (`assignee_id` nulo) o responsável pela demanda, com motivo opcional; a pessoa atribuída é notificada. Membro não elegível retorna `422` `requests_assignee_ineligible` e demanda encerrada retorna `422`. 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.assign`.
Definir prioridade da demanda
Registra a triagem da demanda definindo `priority` (`normal`, `high` ou `urgent`); prioridade urgente exige `priority_reason`. Demanda encerrada retorna `422`. 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`.
Corrigir campos da demanda
Corrige valores de campos da demanda com um `reason_code`, validando-os contra o formulário fixado. Corrigir dados do pedido invalida as decisões do ciclo atual; campos que definem o período de limite não podem mudar após a abertura. 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`.
Marcar mensagens como lidas
Avança seu marcador de leitura da conversa até a sequência `seq`, considerando apenas as mensagens que você pode ver. Disponível só para pessoas: chave de API retorna `403` `requests_api_key_not_allowed`. 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.demands.read`.
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`.
Executar comando em atividade
Aplica um comando a uma atividade da demanda: `start`, `wait`, `resume`, `complete`, `cancel`, `assign` ou `schedule`. Atividade obrigatória só é cancelada com motivo; comando inválido para o estado atual retorna `409`. 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`.
Registrar entrega da demanda
Registra o estado de um item de entrega (`delivered`, `rejected`, `transferred`, `waived` ou `canceled`) fora de uma transição, com motivo, evidência e data de efetivação opcionais. Demanda encerrada retorna `409` `requests_transition_invalid`. 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.execute`.
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`.
Cancelar lembrete da demanda
Cancela um lembrete da demanda (`reminder_id`, UUID). Lembrete inexistente retorna `404`. 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`.
Remover vínculo da demanda
Remove um vínculo ativo da demanda (`relation_id`, UUID); o registro fica no histórico. Vínculo inexistente retorna `404`. 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 arquivo ao contexto de envio
Envia um arquivo em `multipart/form-data` (campo `file` e `request_nonce`) para um contexto de envio aberto por você. Aceita PDF, JPEG ou PNG de até 10 MiB, verificados pelo conteúdo, e até 10 arquivos por contexto (`409` `requests_limit_exceeded`). Repetir o mesmo `request_nonce` não guarda uma segunda cópia. Requer a permissão `requests.attachments.manage`.
Descartar arquivos do contexto de envio
Aplica um comando ao contexto de envio: `discard` remove um arquivo (`attachment_id`) ainda não usado e `abandon` encerra o contexto inteiro. Arquivo indisponível retorna `409` `requests_upload_context_invalid`. 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.attachments.manage`.
Listar anexos da demanda
Lista os anexos da demanda, incluindo removidos e descartados. Anexos internos só aparecem para quem tem `requests.messages.internal_read`. 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.demands.read`.
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`.
Remover anexo da demanda
Remove um anexo da demanda com motivo obrigatório; a referência permanece no histórico. Anexo interno exige `requests.messages.internal_write`. 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.attachments.manage`.