Skip to main content

Pontos de extremidade de fluxos de trabalho

Pontos de extremidade de fluxos de trabalho e parâmetros

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. Selecione 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. Este é o nome do fluxo de trabalho a ser exibido na IU do Server.

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

Exemplo de solicitação: cURL
curl -X 'POST' \
  'http://localhost/webapi/v3/workflows' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@Workflow2.yxzp;type=application/yxzp' \
  -F 'name=Workflow2' \
  -F 'ownerId=66ebd0896e52ae73b4951072' \
  -F 'isPublic=true' \
  -F 'isReadyForMigration=true' \
  -F 'othersMayDownload=true' \
  -F 'othersCanExecute=false' \
  -F 'executionMode=Standard' \
  -F 'workflowCredentialType=Default'
Exemplo de resposta

  • 200: OK

    "string"

  • 400: BadRequest (Solicitação incorreta)

  • 401: Unauthorized (Não autorizado)

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. Selecione o arquivo que deseja carregar no sistema como uma nova versão. O tipo de mídia deve ser um arquivo YXZP.

  • name (cadeia de caracteres): obrigatório. Insira o nome do fluxo de trabalho. Este é o nome do fluxo de trabalho a ser exibido na IU do Server.

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

Exemplo de solicitação: cURL
curl -X 'POST' \
  'http://localhost/webapi/v3/workflows/66ebd18d6e52ae73b4951085/versions' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@Workflow3.yxzp;type=application/yxzp' \
  -F 'name=Workflow1_3' \
  -F 'ownerId=66ebd0896e52ae73b4951072' \
  -F 'othersMayDownload=true' \
  -F 'othersCanExecute=true' \
  -F 'executionMode=Standard' \
  -F 'makePublished=true' \
  -F 'workflowCredentialType=Default'
Exemplo de resposta

  • 200: OK

    {
  "id": "string",
  "sourceAppId": "string",
  "dateCreated": "2024-09-19T07:33:01.072Z",
  "runCount": 0,
  "versions": [
    {
      "versionId": "string",
      "versionNumber": 0,
      "dateCreated": "2024-09-19T07:33:01.072Z",
      "uploadSource": "Designer",
      "uploadDate": "2024-09-19T07:33:01.072Z",
      "packageWorkflowType": "App",
      "published": true,
      "comments": "string",
      "runDisabled": true,
      "executionMode": "Safe",
      "workflowCredentialType": "Default",
      "credentialId": "string",
      "hasPrivateDataExemption": true,
      "othersMayDownload": true,
      "othersCanViewHistory": true,
      "details": {
        "isAmp": true,
        "fileName": "string",
        "author": "string",
        "copyright": "string",
        "description": "string",
        "name": "string",
        "noOutputFilesMessage": "string",
        "outputMessage": "string",
        "url": "string",
        "urlText": "string"
      }
    }
  ],
  "name": "string",
  "ownerId": "string",
  "workerTag": "string",
  "districtTags": [
    "string"
  ],
  "comments": "string",
  "isPublic": true,
  "isReadyForMigration": true,
  "publishedVersionId": "string",
  "othersMayDownload": true,
  "othersCanViewHistory": true,
  "othersCanExecute": true,
  "executionMode": "Safe",
  "hasPrivateDataExemption": true
}

  • 401: BadRequest (Solicitação incorreta)

  • 401: Unauthorized (Não autorizado)

  • 404: Indicates that the workflowId in the path is invalid. (Indica que o "workflowId" no caminho é inválido.)

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. Este é o nome do fluxo de trabalho exibido na IU do Server.

  • 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 -X 'GET' \
  'http://localhost/webapi/v3/workflows' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Exemplo de resposta

  • 200: OK

      {
    "id": "string",
    "sourceAppId": "string",
    "name": "string",
    "ownerId": "string",
    "dateCreated": "2024-08-15T11:14:56.965Z",
    "publishedVersionNumber": 0,
    "isAmp": true,
    "executionMode": "Safe"
  }
]

  • 400: BadRequest (Solicitação incorreta)

  • 401: Unauthorized (Não autorizado)

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

Nota

Os não-administradores podem usar o ponto de extremidade GET v3/workflows/{workflowId} para fluxos de trabalho aos quais têm acesso. Anteriormente, esse ponto de extremidade era limitado apenas aos administradores.

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 -X 'GET' \
  'http://localhost/webapi/v3/workflows/670ce5cef10214f22a6637a3' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Exemplo de resposta

  • 200: OK

    {
  "id": "string",
  "sourceAppId": "string",
  "dateCreated": "2024-09-05T10:42:53.360Z",
  "runCount": 0,
  "versions": [
    {
      "versionId": "string",
      "versionNumber": 0,
      "dateCreated": "2024-09-05T10:42:53.360Z",
      "uploadSource": "Designer",
      "uploadDate": "2024-09-05T10:42:53.360Z",
      "packageWorkflowType": "App",
      "published": true,
      "comments": "string",
      "runDisabled": true,
      "executionMode": "Safe",
      "workflowCredentialType": "Default",
      "credentialId": "string",
      "hasPrivateDataExemption": true,
      "othersMayDownload": true,
      "othersCanViewHistory": true,
      "details": {
        "isAmp": true,
        "fileName": "string",
        "author": "string",
        "copyright": "string",
        "description": "string",
        "name": "string",
        "noOutputFilesMessage": "string",
        "outputMessage": "string",
        "url": "string",
        "urlText": "string"
      }
    }
  ],
  "name": "string",
  "ownerId": "string",
  "workerTag": "string",
  "districtTags": [
    "string"
  ],
  "comments": "string",
  "isPublic": true,
  "isReadyForMigration": true,
  "publishedVersionId": "string",
  "othersMayDownload": true,
  "othersCanViewHistory": true,
  "othersCanExecute": true,
  "executionMode": "Safe",
  "hasPrivateDataExemption": true
}

  • 401: Unauthorized (Não autorizado)

  • 404: NotFound (Não encontrado)

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

Somente administradores podem usar esse ponto de extremidade de API.

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. Este é o nome do fluxo de trabalho a ser exibido na IU do Server.

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

    • workflowCredentialType (cadeia de caracteres): opcional. 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.

  • Exemplo de valor de "updateWorkflowContract":

    {
  "name": "string",
  "versionId": "string",
  "makePublished": true,
  "ownerId": "string",
  "workerTag": "string",
  "districtTags": [
    "string"
  ],
  "comments": "string",
  "isPublic": true,
  "isReadyForMigration": true,
  "othersMayDownload": true,
  "othersCanExecute": true,
  "executionMode": "Safe",
  "hasPrivateDataExemption": true,
  "workflowCredentialType": "Default",
  "credentialId": "string"
}
Exemplo de solicitação: cURL
curl -X 'PUT' \
  'http://localhost/webapi/v3/workflows/66ebd18d6e52ae73b4951085' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Workflow_3_4",
  "versionId": "66ebd18d3d6200007e000d89",
  "makePublished": true,
  "ownerId": "66ebd0896e52ae73b4951072",
  "workerTag": "",
  "districtTags": [],
  "comments": "nothing",
  "isPublic": true,
  "isReadyForMigration": true,
  "othersMayDownload": true,
  "othersCanExecute": true,
  "executionMode": "Safe",
  "hasPrivateDataExemption": true,
  "workflowCredentialType": "Default",
  "credentialId": ""
}'
Exemplo de resposta

  • 200: OK

    {
  "id": "string",
  "sourceAppId": "string",
  "dateCreated": "2024-08-15T11:20:45.231Z",
  "runCount": 0,
  "versions": [
    {
      "versionId": "string",
      "versionNumber": 0,
      "dateCreated": "2024-08-15T11:20:45.231Z",
      "uploadSource": "Designer",
      "uploadDate": "2024-08-15T11:20:45.231Z",
      "packageWorkflowType": "App",
      "published": true,
      "comments": "string",
      "runDisabled": true,
      "executionMode": "Safe",
      "workflowCredentialType": "Default",
      "credentialId": "string",
      "hasPrivateDataExemption": true,
      "othersMayDownload": true,
      "othersCanViewHistory": true,
      "details": {
        "isAmp": true,
        "fileName": "string",
        "author": "string",
        "copyright": "string",
        "description": "string",
        "name": "string",
        "noOutputFilesMessage": "string",
        "outputMessage": "string",
        "url": "string",
        "urlText": "string"
      }
    }
  ],
  "name": "string",
  "ownerId": "string",
  "workerTag": "string",
  "districtTags": [
    "string"
  ],
  "comments": "string",
  "isPublic": true,
  "isReadyForMigration": true,
  "publishedVersionId": "string",
  "othersMayDownload": true,
  "othersCanViewHistory": true,
  "othersCanExecute": true,
  "executionMode": "Safe",
  "hasPrivateDataExemption": true
}

  • 400: BadRequest (Solicitação incorreta)

  • 401: Unauthorized (Não autorizado)

  • 404: NotFound (Não encontrado)

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.

    Nota

    Se o versionID tiver dois dígitos, ele pode atingir o limite de tamanho e você pode receber um erro "414 - URI Too Long". Neste caso, analise a cadeia de caracteres JSON versionID e corte-a apenas para a versão mais recente. Isso manterá o comprimento do campo sob controle.

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'

Exemplo de resposta

  • 200: The download stream of the YXZP file. (O fluxo do download do arquivo YXZP.)

  • 400: Invalid VersionId (VersionId inválido)

  • 401: Unauthorized (Não autorizado)

  • 403: The authenticated user does not have permission to download the workflow, or the workflow is not allowed to be downloaded directly. (O usuário autenticado não tem permissão para baixar o fluxo de trabalho, ou o fluxo de trabalho não pode ser baixado diretamente.)

  • 404: NotFound (Não encontrado)

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

Para obter informações sobre perguntas para um fluxo de trabalho ou um aplicativo analítico, 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' \
  'http://localhost/webapi/v3/workflows/670ce5cef10214f22a6637a3/questions' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Exemplo de resposta

  • 200: OK

    [
  {
    "name": "string",
    "questionType": "string",
    "description": "string",
    "value": "string",
    "multiple": true,
    "items": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
]

  • 400: BadRequest (Solicitação incorreta)

  • 401: Unauthorized (Não autorizado)

  • 403: The authenticated user does not have access to the workflow or questions. (O usuário autenticado não tem acesso ao fluxo de trabalho ou a perguntas.)

  • 404: NotFound (Não encontrado)

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.

Nota

Um trabalho pode ser retornado como concluído, mesmo que o status da consulta seja "Erro". Isso indica que ocorreu um erro durante a execução, mas o fluxo de trabalho foi executado.

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. Insira o nome do campo pelo qual deseja classificar os resultados.

  • direction (cadeia de caracteres): opcional. Especifique aqui a ordem de classificação. Os valores aceites são "asc" (ascendente) e "desc" (descendente). Se nenhuma ordem for especificada, o padrão será ascendente.

  • offset (cadeia de caracteres): opcional. Refere-se ao registro com que você pretende que os resultados comecem.

  • limit (cadeia de caracteres): opcional. Refere-se ao último registro com que você pretende que os resultados terminem.

  • status (cadeia de caracteres): opcional. O status geral da execução do trabalho. Um trabalho concluído também pode ter falhado. Os valores aceitos são: "Concluído", "Erro", "Em execução" e "Em fila".

  • resultCode (cadeia de caracteres): opcional. O código do resultado da execução de um fluxo de trabalho. Isso indica um fluxo de trabalho malsucedido, porém um trabalho bem-sucedido. Os valores aceitos são: "Sucesso", "Aviso" e "Erro".

Exemplo de solicitação: cURL

curl -X 'GET' \
  'http://localhost/webapi/v3/workflows/670ce5cef10214f22a6637a3/jobs' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Exemplo de resposta

  • 200: OK

    [
  {
    "id": "string",
    "createDate": "2024-08-15T11:29:53.357Z",
    "status": "Created",
    "priority": "string",
    "workerTag": "string",
    "runWithE2": true
  }
]

  • 400: BadRequest (Solicitação incorreta)

  • 401: Unauthorized (Não autorizado)

  • 404: NotFound (Não encontrado)

Excluir um fluxo de trabalho

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

Nota

Somente administradores podem usar esse ponto de extremidade de API.

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' \
  'http://localhost/webapi/v3/workflows/670ce95bf10214f22a665bc4' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Exemplo de resposta

  • 200: OK

  • 400: BadRequest (Solicitação incorreta)

  • 401: Unauthorized (Não autorizado)

  • 404: NotFound (Não encontrado)

Criar um novo trabalho

Para criar um novo trabalho e adicioná-lo à fila de execução, use o ponto de extremidade POST /v3/workflows/{workflowId}/jobs.

Parâmetros

  • workflowId (cadeia de caracteres): obrigatório. Insira um ID de fluxo de trabalho que você deseja agendar.

  • contract (corpo): para criar um novo trabalho, especifique os seguintes parâmetros:

    • workerTag (cadeia de caracteres): opcional. Especifique o trabalhador atribuído. Se não for especificado, o valor será "none" (nenhum).

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

    • questions (cadeia de caracteres): opcional. Para um aplicativo analítico, especifique as perguntas e respostas para executar o fluxo de trabalho.

      • name (cadeia de caracteres): opcional.

      • value (cadeia de caracteres): opcional.

    • priority (cadeia de caracteres): opcional. Especifique a prioridade para a execução do agendamento. Escolha entre os seguintes valores: "Low" (baixa), "Medium" (média), "High" (alta) e "Critical" (crítica). Se não for especificado, o valor padrão será "Low" (baixa).

Exemplo de valor de "contract":

{
  "workerTag": "string",
  "credentialId": "string",
  "questions": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "priority": "Default"
}

Exemplo de solicitação: cURL

Exemplo de uma solicitação para criar um trabalho:

curl -X 'POST' \
  'http://localhost/webapi/v3/workflows/670ce5cef10214f22a6637a3/jobs' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: application/json' \
  -d '{
  "workerTag": "",
  "credentialId": "",
  "priority": "Low"
}'

Exemplo de resposta

  • 200: OK

    {
  "id": "string",
  "appId": "string",
  "createDateTime": "2024-09-05T11:13:04.586Z",
  "status": "string",
  "disposition": "string",
  "outputs": [
    {
      "id": "string",
      "availableFormats": [
        "string"
      ],
      "fileName": "string"
    }
  ],
  "messages": [
    {
      "status": 0,
      "text": "string",
      "toolId": 0
    }
  ],
  "priority": "Default",
  "workerTag": "string",
  "runWithE2": true
}

  • 400: BadRequest (Solicitação incorreta)

  • 401: Unauthorized (Não autorizado)

  • 403: The authenticated user does not have access to execute the workflow. (O usuário autenticado não tem acesso para executar o fluxo de trabalho.)

  • 404: NotFound (Não encontrado)

Transferir fluxos de trabalho e agendamentos para um proprietário específico

Para transferir um fluxo de trabalho específico para um proprietário específico, juntamente com agendamentos, se desejar, use o ponto de extremidade PUT {baseURL}/v3/workflows/{workflowId}/transfer.

Nota

  • Somente administradores podem usar esse ponto de extremidade de API.

  • Se qualquer um dos fluxos de trabalho exigir conexões do DCM, conexões do Server ou credenciais run-as específicas para ser executado, esses itens precisam ser atualizados antes que o fluxo de trabalho possa ser executado.

  • Se os usuários não estiverem no mesmo estúdio e quando um fluxo de trabalho for transferido para o novo estúdio, todos os outros usuários no estúdio do novo proprietário também receberão acesso ao fluxo de trabalho, e todos os usuários do antigo estúdio perderão o acesso.

  • Os fluxos de trabalho só podem ser transferidos para um usuário com a função de criador ou de administrador.

  • Se estiver transferindo agendamentos, o novo proprietário deve ter acesso ao fluxo de trabalho agendado, caso contrário, não será possível transferir esse fluxo de trabalho a ele.

  • Se estiver transferindo agendamentos, o novo proprietário deve ter permissão para agendar fluxos de trabalho.

  • Se o usuário for excluído, ele retorna uma lista de IDs de agendamento que serão falharão ou serão desabilitados após a transferência.

Parâmetros

  • workflowId (cadeia de caracteres): obrigatório. Especifique o ID do fluxo de trabalho a transferir.

  • contract (corpo): obrigatório. Especifique as seguintes informações:

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

    • transferSchedules (booleano): obrigatório. Especifique se os agendamentos devem ser transferidos para um novo proprietário com o fluxo de trabalho. Somente os agendamentos do proprietário do fluxo de trabalho atual serão transferidos para o novo proprietário.

Exemplo de valor de "contract":

{
  "ownerId": "string",
  "transferSchedules": true
}

Exemplo de solicitação: cURL

curl -X 'PUT' \
  'http://localhost/webapi/v3/workflows/670ce5cef10214f22a6637a3/transfer' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere' \
  -H 'Content-Type: application/json' \
  -d '{
  "ownerId": "670ceafbf10214f22a666c76",
  "transferSchedules": true
}'

Exemplo de resposta

  • 200: OK

  • 400: BadRequest (Solicitação incorreta)

    "string"

  • 401: Unauthorized (Não autorizado)

  • 403: Forbidden (Proibido)

    "string"

  • 404: NotFound (Não encontrado)

    "string"

  • 500: InternalServerError (Erro interno do servidor)

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.

Nesta secção: