Skip to main content

Pontos de extremidade de fluxos de trabalho

Parâmetros e pontos de extremidade de fluxos de trabalho

Para saber mais sobre as relações de objetos e como usá-las na API, vá para a seção Relações de objeto .

Para obter mais informações sobre fluxos de trabalho, visite a página de ajuda Fluxos de trabalho .

Carregar um novo fluxo de trabalho

Para carregar um novo fluxo de trabalho, use o ponto de extremidade POST {baseURL}/v3/workflows .

Parâmetros

  • 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"].

Carregar uma nova versão de um fluxo de trabalho existente

Para carregar uma nova versão de um fluxo de trabalho existente, use o ponto de extremidade POST {baseURL}/v3/workflows/{workflowId}/versions .

Parâmetros

  • 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 .

Recuperar todos os fluxos de trabalho

Para obter informações sobre todos os registros de fluxos de trabalho, use o ponto de extremidade GET {baseURL}/v3/workflows/ .

Parâmetros

  • 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 .

Exemplo de solicitação: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows' \ --header 'Authorization: Bearer token-bearer-aqui'

Recuperar um registro de fluxo de trabalho específico

Para obter informações sobre um fluxo de trabalho específico, use o ponto de extremidade GET {baseURL}/v3/workflows/{workflowId} .

Parâmetros

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

Exemplo de solicitação: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer token-bearer-aqui'

Atualizar um fluxo de trabalho existente

Para alterar informações sobre um fluxo de trabalho existente, use o ponto de extremidade PUT {baseURL}/v3/workflows/{workflowId} .

Nota

Para alterar o ID do proprietário (ownerId), o novo proprietário deve estar na mesma assinatura do proprietário atual.

Parâmetros

  • 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 .

Baixar um pacote de fluxo de trabalho

Para baixar um pacote de fluxo de trabalho, use o ponto de extremidade GET {baseURL}/v3/workflows/{workflowId}/package .

Parâmetros

  • 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.

Exemplo de solicitação: cURL

curl -X GET --header 'Accept: application/octet-stream' --header 'Authorization: Bearer token-bearer-aqui' 'http://localhost/webapi/v3/workflows/635a4be7dc6e24bb8ff0/package'

Recuperar informações de perguntas para um fluxo de trabalho

Para obter informações sobre perguntas para um fluxo de trabalho, use o ponto de extremidade GET {baseURL}/v3/workflows/{workflowId}/questions .

Parâmetros

  • 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.

Exemplo de solicitação: cURL

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer token-bearer-aqui' 'http://localhost/webapi/v3/workflows/635a4bc6e24b78d0b8ff0/questions'

Obter informações sobre tarefas para um fluxo de trabalho específico

Para obter informações sobre tarefas para um fluxo de trabalho específico, use o ponto de extremidade GET {baseURL}/v3/workflows/{workflowId}/jobs .

Parâmetros

  • 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.

Exemplo de solicitação: cURL

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer token-bearer-aqui' 'http://localhost/webapi/v3/workflows/635a4be6e24b78d0b8ff0/jobs'

Excluir fluxo de trabalho

Para excluir um fluxo de trabalho específico, use o ponto de extremidade DELETE {baseURL}/v3/workflows/{workflowId} .

Parâmetros

  • 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.

Exemplo de solicitação: cURL

curl -X DELETE --header 'Accept: application/json' --header 'Authorization: Bearer token-bearer-aqui' 'http://localhost/webapi/v3/workflows/635a752fdc6e278d0ba40b'

Create a New Job

To create a new job and add it to the queue, use the POST /v3/workflows/{workflowId}/jobs endpoint.

Parameters

  • workflowId (string): Required. Enter a workflow ID you want to schedule.

  • contract (body): To create a new job, specify the following parameters:

    • workerTag (string): Optional. Specify the assigned worker. If not specified, the value will be "none".

    • credentialId (string): Optional. Specify the credentialId for this workflow.

    • questions (string): Optional. For an analytic app, specify the questions and answers to run the workflow.

    • priority (string): Optional. Specify the priority for running the schedule. Choose from the following options: "Low", "Medium", "High", and "Critical". If not specified, the default value will be ‘Low’.

REQUEST EXAMPLE: cURL

Example of a request to create a job:

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: Bearer BearerTokenGoesHere' -d '{ \ "workerTag": "", \ "credentialId": "", \ "questions": [], \ "priority": "Low" \ }' 'http://localhost/webapi/v3/workflows/651faa8bde3e5381fd0dac29/jobs'{ "workerTag": "tag1",  "credentialId": "652e6f90ea174cd34f6779d2", "questions": [  {   "name": "Drop_Down",   "value": "true"  } ], "priority": "Low"}

Relações de objetos

Se você estiver carregando um fluxo de trabalho, você pode usar objetos criados da seguinte maneira:

Objeto criado: " workflowId " (for example, "id": "7917969784f84bd09442f66996ecb8f3")

Você pode usá-lo como:

Exemplos de solicitações Postman

GET /v3/workflows/{workflowId}

Use GET /v3/workflows/{workflowId} endpoint.

Para saber mais sobre solicitações Postman, visite a página de ajuda Como usar Postman .