export/process
Use este recurso para exportar uma revisão específica de um processo no formato BPMN 2.0.
Observação: Documentação da API migrada para IBM Central de API
. Encontre as atualizações e a documentação mais recentes para Blueworks Live APIs no API Hub.
. Encontre as atualizações e a documentação mais recentes para Blueworks Live APIs no API Hub.Resumo do método
| Método de HTTP | Caminho | Descrição |
|---|---|---|
| GET | /scr/api/export/process/{process_id}/{revision_id} | Exporta uma revisão específica de um processo no formato BPMN 2.0. |
GET /scr/api/export/process/{process_id}/{revision_id}
- Descrição
- Use esse método para exportar uma revisão específica de um processo no formato BPMN 2.0.
- Informações de recurso
Requisitos Descrição Formato de resposta CEP Requer autenticação Sim. O usuário que solicita a exportação do processo deve ser um editor para esse processo. Suporta credenciais do cliente OAuth 2 Sim usando um ID de Serviço do Usuário contendo Categoria de Relatório de Artefato Taxa limitada Não
- Parâmetros
Nome Local Descrição Necessário Tipo exportToSingleFile Consultar Esse parâmetro permite que os usuários exportem os processos como um único arquivo XML compatível com o BPMN 2.0, incluindo os detalhes do Diagram Interchange (DI). Ele fornece compatibilidade de troca de modelo com ferramentas BPMN de terceiros. O padrão é false.Não Booleano includeDiagramInterchange Consultar Se o Diagram Interchange (DI) do BPMN2 será incluído ou não na exportação. O DI abrange informações visuais como posicionamento de nó e limites, portas de linha e rótulos. O padrão é false.Não Booleano process_id Caminho O ID do processo exportado. True Sequência revision_id Caminho O ID da revisão exportada. True Sequência X-On-Behalf-Of Cabeçalho O contexto do usuário. O valor deve ser um nome do usuário na conta. O usuário deve ter permissão para executar a ação na conta e no espaço pai especificado, se houver. Necessário se forem utilizadas credenciais de ID de serviço OAuth. Não é necessário ao usar a credencial de ID de serviço do usuário OAuth. Sequência
- Resposta
- Os dados do processo no formato BPMN 2.0 incluindo todos os processos vinculados ao processo solicitado.
- Exemplo de entrada
- O exemplo a seguir mostra como exportar uma revisão com o valor revision_id
1300a1e o valor process_id de130024.- Usando credenciais do cliente OAuth 2:
curl -i -H "Authorization: Bearer access_token" "https://your_server_url/scr/api/export/process/130024/1300a1"
- Usando credenciais do cliente OAuth 2:
- Exemplo de saída
- Dados do arquivo
- Propriedades de resposta
- Nenhum
- Mensagens de resposta
Código de HTTP Razão 200 A solicitação foi concluída com sucesso.
401 O usuário não está autorizado a fazer a solicitação.
403 O usuário não tem acesso ao processo. O processo requer pelo menos acesso ao editor.