Pontos de extremidade de fluxos de trabalho

file (arquivo): obrigatório. Escolha o arquivo que deseja carregar no sistema. O tipo de mídia deve ser um arquivo YXZP.

name (cadeia de caracteres): obrigatório. Insira um nome de fluxo de trabalho.

ownerId (cadeia de caracteres): obrigatório. Insira o ID do proprietário.

workerTag (cadeia de caracteres): opcional. Especifique a tag do trabalhador definida nos trabalhos para ajudar a atribuir tarefas a determinados nós de trabalho. Para obter mais informações, visite a página de ajuda Trabalhador.

districtTags (cadeia de caracteres): opcional. Envie como uma matriz formatada em JSON, por exemplo, ["id1", "id2"]. Use distritos para agrupar fluxos de trabalho públicos compartilhados por meio de tags para que os usuários possam encontrá-los facilmente. Para obter mais informações, visite a página de ajuda Distritos.

comments (cadeia de caracteres): opcional. Insira seus comentários.

isPublic (booleano): obrigatório. Selecione "true" para fazer com que o fluxo de trabalho fique publicamente disponível. Selecione "false" para fazer com que o fluxo de trabalho seja privado e publicamente indisponível.

isReadyForMigration (booleano): obrigatório. Defina se o fluxo de trabalho está pronto para ser migrado. Para obter mais informações sobre a migração de um ambiente do Server para outro, consulte a página de ajuda Habilitar fluxos de trabalho para migração.

sourceAppId (cadeia de caracteres): opcional. Define o ID de aplicativo de origem de um fluxo de trabalho. Pode ser usado como a referência para "sourceId" para o ponto de extremidade POST admin/v1/workflows. Fornecer um sourceAppId (ID de aplicativo de origem) preexistente resultará em uma solicitação inválida.

othersMayDownload (booleano): obrigatório. Especifique se outros usuários podem baixar este fluxo de trabalho.

othersCanExecute (booleano): obrigatório. Especifique se outros usuários podem executar este fluxo de trabalho.

executionMode (cadeia de caracteres): obrigatório. Os valores aceitos são "Safe" (seguro), "SemiSafe" (semiseguro) e "Standard" (padrão). Para obter mais informações sobre o modo de execução, consulte a página de ajuda Modos de execução seguro e semisseguro: ferramentas, eventos e conectores de dados bloqueados.

hasPrivateDataExemption (booleano): opcional. Forneça uma isenção para permitir que um fluxo de trabalho com dados privados seja executado. Selecione "true" para permitir uma isenção ou "false" para negar uma isenção. Para mais informações, visite a página Opções de fluxo de trabalho na interface do administrador.

workflowCredentialType (cadeia de caracteres): obrigatório. Os valores aceitos são "Default" (padrão), "Required" (obrigatório), and "Specific" (específico).

credentialId (cadeia de caracteres): opcional. Especifique o ID da credencial para este fluxo de trabalho.

collectionIds (cadeia de caracteres): opcional. Insira os IDs das coleções a que este fluxo de trabalho deve ser adicionado. Envie como uma matriz formatada em JSON, por exemplo: ["id1", "id2"].

workflowId (cadeia de caracteres): obrigatório. Insira o ID do fluxo de trabalho para o qual você deseja carregar uma nova versão.

file (arquivo): obrigatório. Escolha o arquivo que deseja carregar no sistema como uma nova versão.

name (cadeia de caracteres): obrigatório. Insira o nome do fluxo de trabalho.

ownerId (cadeia de caracteres): obrigatório. Insira o ID do proprietário.

othersMayDownload (booleano): obrigatório. O padrão é definido como "true".

othersCanExecute (booleano): obrigatório. O padrão é definido como "true".

executionMode (cadeia de caracteres): obrigatório. Os valores aceitos são "Safe" (seguro), "SemiSafe" (semiseguro) e "Standard" (padrão). Para obter mais informações sobre o modo de execução, consulte a página de ajuda Modos de execução seguro e semisseguro: ferramentas, eventos e conectores de dados bloqueados.

hasPrivateDataExemption (booleano): opcional. Forneça uma isenção para permitir que um fluxo de trabalho com dados privados seja executado. Selecione "true" para permitir uma isenção ou "false" para negar uma isenção. Para mais informações, visite a página Opções de fluxo de trabalho na interface do administrador.

comments (cadeia de caracteres): opcional. Insira seus comentários.

makePublished (booleano): obrigatório. O padrão é definido como "true". O parâmetro makePublished é uma maneira de controlar se a nova versão de um fluxo de trabalho que você enviar para o Server deve ser a versão publicada ou não. Você pode definir o valor como "false" quando enviar o fluxo de trabalho para o Server e somente você poderá executá-lo.

workflowCredentialType (cadeia de caracteres): obrigatório. Digite o tipo de credencial a ser usado para este fluxo de trabalho. Os valores aceitos são "Default" (padrão), "Required" (obrigatório), and "Specific" (específico).

credentialId (cadeia de caracteres): opcional. Especifique o ID da credential para este fluxo de trabalho. Para obter mais informações sobre pontos de extremidade de credenciais, vá para Pontos de extremidade de credenciais.

view (cadeia de caracteres): opcional. Selecione como deseja exibir as informações dos fluxos de trabalho. Pode ser deixado sem um valor. Você pode selecionar entre os seguintes valores: "Default" (padrão) e "Full" (completo). Se esse parâmetro for definido como "Default", um objeto de visualização reduzido será retornado. Quando não especificado, o valor "Default" é usado.

name (cadeia de caracteres): opcional. Insira o nome do fluxo de trabalho caso deseje filtrar os fluxos pelo nome.

ownerId (cadeia de caracteres): opcional. Insira o ID do proprietário caso deseje filtrar os fluxos de trabalho por seu proprietário.

createdAfter (cadeia de caracteres): opcional. Insira a data e a hora após a qual o fluxo de trabalho foi criado. Insira a data e a hora no formato ISO8601.

createdBefore (cadeia de caracteres): opcional. Insira a data e a hora antes da qual o fluxo de trabalho foi criado. Insira a data e a hora no formato ISO8601.

workflowId (cadeia de caracteres): obrigatório. Insira o ID do fluxo de trabalho para obter informações sobre este fluxo de trabalho.

workflowId (cadeia de caracteres): obrigatório. Insira o ID do fluxo de trabalho que deseja atualizar.

updateWorkflowContract (corpo): obrigatório. Insira as informações do fluxo de trabalho que deseja atualizar.

name (cadeia de caracteres): obrigatório. Insira o nome do fluxo de trabalho.

versionId (cadeia de caracteres): obrigatório. Insira o ID da versão.

makePublished (booleano): opcional. Quando não especificado, o valor permanece o mesmo de antes. O parâmetro makePublished é uma maneira de controlar se a nova versão de um fluxo de trabalho que você enviar para o Server deve ser a versão publicada ou não. Você pode definir o valor como "false" quando enviar o fluxo de trabalho para o Server e somente você poderá executá-lo.

ownerId (cadeia de caracteres): obrigatório. Insira o ID do proprietário.

workerTag (cadeia de caracteres): obrigatório. Quando não houver nenhuma tag de trabalhador, use "".

districtTags (cadeia de caracteres): obrigatório. Insira as tags de distrito. Use distritos para agrupar fluxos de trabalho públicos compartilhados por meio de tags para que os usuários possam encontrá-los facilmente. Para obter mais informações, visite a página de ajuda Distritos.

comments (cadeia de caracteres): obrigatório. Insira seus comentários.

isPublic (booleano): opcional. Quando não especificado, o valor permanece o mesmo de antes.

isReadyForMigration (booleano): opcional. Quando não especificado, o valor permanece o mesmo de antes.

othersMayDownload (booleano): opcional. Quando não especificado, o valor permanece o mesmo de antes. Quando definido como "false" para um fluxo de trabalho público, o fluxo não poderá ser utilizado.

othersCanExecute (booleano): opcional. Quando não especificado, o valor permanece o mesmo de antes. Quando definido como "false" para um fluxo de trabalho público, o fluxo não poderá ser utilizado.

executionMode (cadeia de caracteres): opcional. Os valores aceitos são "Safe" (seguro), "SemiSafe" (semiseguro) e "Standard" (padrão). Para obter mais informações sobre o modo de execução, consulte a página de ajuda Modos de execução seguro e semisseguro: ferramentas, eventos e conectores de dados bloqueados.

hasPrivateDataExemption (booleano): opcional. Forneça uma isenção para permitir que um fluxo de trabalho com dados privados seja executado. Selecione "true" para permitir uma isenção ou "false" para negar uma isenção. Quando não especificado, o valor permanece o mesmo de antes. Para mais informações, visite a página Opções de fluxo de trabalho na interface do administrador.

workflowId (cadeia de caracteres): obrigatório. Insira o ID do fluxo de trabalho para o qual deseja baixar o pacote.

versionId (cadeia de caracteres): opcional. Insira o ID da versão específica de um fluxo de trabalho. Se nenhuma versão for fornecida, a versão publicada será baixada.

workflowId (cadeia de caracteres): obrigatório. Insira o ID fluxo de trabalho para o qual deseja recuperar as informações.

versionId (cadeia de caracteres): opcional. Insira o ID da versão específica de um fluxo de trabalho. Se nenhuma versão for fornecida, a versão publicada será usada.

workflowId (cadeia de caracteres): obrigatório. Insira o ID fluxo de trabalho para o qual deseja recuperar as informações.

sortField (cadeia de caracteres): opcional.

direction (cadeia de caracteres): opcional.

offset (cadeia de caracteres): opcional.

limit (cadeia de caracteres): opcional.

workflowId (cadeia de caracteres): obrigatório. Insira o ID do fluxo de trabalho a ser excluído.

force (booleano): opcional. Quando não selecionado, o valor padrão é "false". Se um fluxo de trabalho estiver agendado, definir o parâmetro como "true" excluirá todos os agendamentos antes de excluí-lo.