automações uiip ah, fluxos de ideias, casos de negócios, fases, questionários, pipelines

Sintaxe e opções para o ciclo de vida da ideia à entrega do Automation Hub — envio e leitura de ideias de automação, transições de fase, análises de custo-benefício, o catálogo de avaliações e a visualização do pipeline classificado com benefício.

Uma automação (o Automation Hub chama o registro subjacente de um "processo") é o registro principal no Automation Hub — uma ideia enviada que passa por fases configuráveis (Ideia, Avaliação, Análise, Design da solução, Desenvolvimento, Teste, Ativa, …) por meio de um fluxo de ideias. Cada fase tem uma análise de custo-benefício (caso de negócios), e uma avaliação (um conjunto de perguntas do catálogo de questionários ) captura as respostas que alimentam um envio. A visualização do pipeline é de automações mais seus números de execução e benefício, classificados. Consulte uip ah para obter conceitos compartilhados (projeção/--all-fields, listas paginadas versus não paginadas, descoberta de ID) que se aplicam a todos os verbos aqui.

automações uipath ah

Trabalhar com ideias de automação — o registro principal do Automation Hub.

Resumo

uip ah automations list [--search <text>] [--sort-by <field>] [--sort-order asc|desc] [--category-id <id...>] [--application-id <id...>] [--business-unit <name>] [--phase-id <id...>] [--status-id <id...>] [--tags <tag...>] [--owner-id <id>] [--submitter-id <id>] [--updated-by-id <id>] [--submission-type <type>] [--start-date <date>] [--end-date <date>] [--plain-text] [--high-level-assessment] [--advanced-information] [--limit <n>] [--offset <n>] [--all-fields]
uip ah automations get <automation-id> [--plain-text] [--all-fields]
uip ah automations schema get [automation-id] [--source-type <type>] [--idea-flow-id <id>] [--category-id <id>] [--destination <path>]
uip ah automations create --source-type <type> --file <json-file> [--from-schema] [--idea-flow-id <id>]
uip ah automations update <automation-id> --file <json-file>

lista de automações uip ah

Listar ideias de automação no tenant.

Opções

Long	Valor	Description
--search <text>	String	Pesquisa de texto livre, como na tela Explorar.
--sort-by <field>	String	O campo para classificar, por exemplo process_updated_epoch).
--sort-order <direction>	asc|desc	Classificar direção.
--category-id <id...>	repetível	Apenas automações nestas categorias.
--application-id <id...>	repetível	Apenas automações que usam esses aplicativos.
--business-unit <name>	String	Apenas automações nesta unidade de negócios.
--phase-id <id...>	repetível	Apenas automações nestas fases.
--status-id <id...>	repetível	Apenas automações nesses status de fase.
--tags <tag...>	repetível	Apenas automações que carregam essas tags.
--owner-id <id>	Número inteiro	Apenas automações pertencentes a este ID de usuário.
--submitter-id <id>	Número inteiro	Apenas automações enviadas por este ID de usuário.
--updated-by-id <id>	Número inteiro	Apenas automações foram atualizadas pela última vez por esse ID de usuário.
--submission-type <type>	String	Somente este tipo de envio.
--start-date <date> / --end-date <date>	YYYY-MM-DD	Criado nessa data ou depois/antes dessa data.
--plain-text	Bandeira	Converter campos de rich text em texto simples.
--high-level-assessment	Bandeira	Inclua dados de avaliação de alto nível.
--advanced-information	Bandeira	Inclua respostas detalhadas e personalizadas a perguntas.
--limit <n> / --offset <n>	Número inteiro	Paginação. --limit 20Padrão.
--all-fields	Bandeira	Retorna a carga bruta em vez dos campos projetados.

Exemplo

uip ah automations list --limit 10 --sort-by process_updated_epoch --sort-order desc

Formato dos dados (--output json)

{
  "Code": "AhAutomationsList",
  "Data": [
    {
      "Id": 20, "Name": "Invoice intake", "Slug": "invoice-intake", "Phase": "Analysis",
      "PhaseStatus": "In Progress", "SubmissionType": "ED", "BusinessUnit": "EMEA",
      "Department": "Finance", "AutomationScore": 78, "Priority": 1, "IsPublished": 0,
      "CreatedEpoch": 1735689600000, "UpdatedEpoch": 1738368000000,
      "PhaseKey": "ANALYSIS", "Tags": ["finance"]
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 10, "Offset": 0 }
}

Tags é derivados da array process_tags do registro real (ou seu duplo __display) em uma array de strings simples. PhaseKey é o valor que uip ah phases set --phase assume.

automações uipath ah obter

Obter uma ideia de automação por id.

Argumentos

Name	Required	Finalidade
<automation-id>	sim	ID da automação.

Opções

Long	Description
--plain-text	Converter campos de rich text em texto simples.
--all-fields	Retornar a carga bruta.

Exemplo

uip ah automations get 20 --plain-text

Formato dos dados (--output json)

{ "Code": "AhAutomationsGet", "Data": { "Id": 20, "Name": "Invoice intake", "Phase": "Analysis" } }

obter esquema de automações uip ah

Obter um esquema de avaliação — o documento create/update consomem. Com um ID de automação, ele retorna o formulário preenchido dessa automação; sem um, ele retorna um modelo em branco para --source-type.

Argumentos

Name	Required	Finalidade
[automation-id]	não	ID da automação existente, para ler seu esquema preenchido. Omita para um modelo em branco.

Opções

Long	Valor	Description
--source-type <type>	COE|ED|CD|PM|TM	Obrigatório para um modelo em branco (sem ID de automação fornecido).
--idea-flow-id <id>	Número inteiro	ID do fluxo de ideias, para um fluxo personalizado.
--category-id <id>	Número inteiro	ID da categoria para escolher a avaliação ativa.
--destination <path>	Path	Grave o JSON do esquema para este arquivo em vez do envelope de saída.

Um ID de automação ou --source-type é necessário — passar nenhum dos dois falha no lado do cliente antes de qualquer solicitação.

Exemplo

uip ah automations schema get --source-type COE --destination ./idea.json

Formato dos dados (--output json)

{ "Code": "AhAutomationsSchemaGet", "Data": { "SourceType": "COE", "Destination": "./idea.json" } }

Quando --destination é omitido, Data.Schema carrega o documento de esquema embutido em vez de Destination.

criação de automações uiip ah

Envie uma nova ideia de automação. --source-type escolhe o formulário de envio de forma fixa (ED→/automationidea, COE→/coe-automationidea, PM→/processmining-idea); --from-schema envia um documento schema get preenchido por meio de /idea-from-schema — necessário para tipos de origem CD/TM e para qualquer tenant com fluxos de ideias personalizados por meio de --idea-flow-id.

Opções

Long	Valor	Required	Description
--source-type <type>	COE|ED|CD|PM|TM	condicionalmente	Obrigatório, a menos que --idea-flow-id seja fornecido.
--file <json-file>	Path	sim	Corpo da solicitação — o JSON de forma fixa ou o documento user_inputs preenchido com --from-schema.
--from-schema	Bandeira	não	Envie por meio do ponto de extremidade do esquema usando o documento de automations schema get.
--idea-flow-id <id>	Número inteiro	não	Fluxo de ideia de destino para --from-schema — substitui --source-type para tenants com fluxos personalizados. Requer --from-schema. Entre em conflito com --source-type.

--idea-flow-id sem --from-schema falha no lado do cliente (os pontos de extremidade de forma fixa não têm ideia de um fluxo de ideia). Um --file cujo JSON já carrega uma chave user_inputs será desencapsulado automaticamente; um arquivo que é apenas o mapa de respostas é usado como está.

Exemplo

uip ah automations create --source-type ED --file ./idea.json

Formato dos dados (--output json)

{ "Code": "AhAutomationsCreate", "Data": { "Id": 42, "SourceType": "ED", "Name": "..." } }

Atualização de automações uip ah

Atualizar as respostas de avaliação de uma automação a partir de um arquivo — o mesmo documento que automations schema get <automation-id> grava.

Argumentos

Name	Required	Finalidade
<automation-id>	sim	ID da automação.

Opções

Long	Valor	Required	Description
--file <json-file>	Path	sim	JSON com as user_inputs respostas a serem aplicadas.

Exemplo

uip ah automations update 20 --file ./20.json

Formato dos dados (--output json)

{ "Code": "AhAutomationsUpdate", "Data": { "Id": 20, "Status": "Updated" } }

fluxos de ideias do uip ah

Descubra os fluxos de ideias configurados e os pares de fase/status que eles permitem.

lista de fluxos de ideias uip ah

Opções

Long	Description
--limit <n> / --offset <n>	Paginação, aplicada do lado do cliente (ponto de extremidade não paginado).
--all-fields	Retornar a carga bruta.

Exemplo

uip ah idea-flows list

Formato dos dados (--output json)

{
  "Code": "AhIdeaFlowsList",
  "Data": [
    { "Id": 1, "Name": "Business Process", "Phases": { "IDEA": "NEW_IDEA, AWAITING_REVIEW", "LIVE": "IN_PRODUCTION" } }
  ]
}

Phases recolhe a forma de uma coluna por fase da resposta bruta (IDEA, ASSESSMENT, QUALIFICATION, ANALYSIS, SOLUTION_DESIGN, DEVELOPMENT, TESTING, TECHNICAL_REVIEW, LIVE) em um único objeto, incluindo apenas as fases que o fluxo realmente usa.

casos de negócios uip ah

Leia a análise de custo-benefício de uma automação (o termo do Automation Hub é CBA) e defina sua linha de base do plano de projeto.

casos de negócios uip ah get

Argumentos

Name	Required	Finalidade
<automation-id>	sim	ID da automação.

Opções

Long	Description
--all-fields	Retornar a carga bruta.

Exemplo

uip ah business-cases get 20

Formato dos dados (--output json)

{ "Code": "AhBusinessCasesGet", "Data": { "AutomationId": 20, "BaselineIsSet": 0, "Sections": [{ "Title": "Project Plan" }] } }

casos de negócios uip ah set-line

Congele a linha de base do plano de projeto para uma automação de um arquivo de datas de fase. Focaliza BaselineIsSet em 1.

Argumentos

Name	Required	Finalidade
<automation-id>	sim	ID da automação.

Opções

Long	Valor	Required	Description
--file <json-file>	Path	sim	{ "phases": [{ "phase": "Analysis", "start_date": "09/01/2026", "end_date": "09/15/2026" }] }. Os nomes das fases vêm da seção Linha de base de business-cases get (Análise, Design da solução, Desenvolvimento, Teste, Data de lançamento); as datas são MM/DD/YYYY; cada fase, exceto a Data de lançamento, precisa de um end_date.

Uma matriz de fases vazia é encapsulada automaticamente em { "phases": [...] }; qualquer outra coisa que já não esteja { "phases": [...] } será rejeitada do lado do cliente antes que a solicitação seja enviada.

Exemplo

uip ah business-cases set-baseline 20 --file ./baseline.json

Formato dos dados (--output json)

{ "Code": "AhBusinessCasesSetBaseline", "Data": { "AutomationId": 20, "Status": "BaselineSet" } }

Fases do uiip ah

Mova uma automação pelo pipeline.

fases uip ah definidas

Argumentos

Name	Required	Finalidade
<automation-id>	sim	ID da automação.

Opções

Long	Valor	Description
--phase <variable>	String	Variável de fase de destino, por exemplo TECHNICAL_REVIEW). Preferido sobre o formulário legado; emparelhar com --status.
--status <variable>	String	Variável de status de destino, por exemplo AWAITING_REVIEW). Necessário junto com --phase.
--phase-status-id <id>	Número inteiro	ID numérico do status da fase legado — alternativo para --phase/--status, não combinável com eles.
--submitter-id <id>	Número inteiro	ID do usuário remetente. Aplica-se apenas com --phase-status-id; rejeitado com --phase/--status.

É necessário exatamente um estilo: --phase com --status ou --phase-status-id individualmente. Encontre pares válidos de fase/status com uip ah idea-flows list.

Exemplos

uip ah phases set 20 --phase TECHNICAL_REVIEW --status AWAITING_REVIEW

uip ah phases set 20 --phase-status-id 118

Formato dos dados (--output json)

{ "Code": "AhPhasesSet", "Data": { "AutomationId": 20, "Phase": "TECHNICAL_REVIEW", "Status": "AWAITING_REVIEW" } }

Com --phase-status-id, Data carrega PhaseStatusId em vez de Phase/Status.

questionários uip ah

Leia o catálogo de perguntas de avaliação.

lista de questionários uip ah

Opções

Long	Valor	Required	Description
--assessment <name>	high-level|detailed|citizen-development	sim	Avaliação lida.
--section <key>	String	não	Apenas esta seção, por exemplo q1-overview).
--active-only / --no-active-only	Bandeira	não	Apenas perguntas ativas (o padrão do servidor)/inclui perguntas inativas também.
--mandatory-only	Bandeira	não	Apenas perguntas obrigatórias.
--limit <n> / --offset <n>	Número inteiro	não	Paginação, aplicada do lado do cliente (ponto de extremidade não paginado).
--all-fields	Bandeira	não	Retornar a carga bruta.

Exemplo

uip ah questionnaires list --assessment high-level

Formato dos dados (--output json)

{
  "Code": "AhQuestionnairesList",
  "Data": [
    {
      "Section": "Overview", "SectionKey": "q1-overview", "SectionId": 1, "QuestionCount": 6,
      "Questions": [{ "Id": 101, "Key": "q1", "Title": "...", "IsMandatory": 1, "IsActive": 1 }]
    }
  ]
}

pipelines uip ah

Leia o Pipeline de automação — automações com seus números de fase e benefício. Mantido separado de automations list: o ponto de extremidade adiciona colunas de benefício por fase e escreve sua direção de classificação order internamente (mesmo sinalizador --sort-order).

lista de pipelines uip ah

Opções

Long	Valor	Description
--search <text>	String	Pesquisa de texto livre.
--sort-by <field>	String	Campo para classificar.
--sort-order <direction>	asc|desc	Classificar direção.
--category-id <id...>	repetível	Apenas estas categorias.
--application-id <id...>	repetível	Apenas automações que usam esses aplicativos.
--business-unit <name> / --department <name>	String	Filtros de escopo.
--phase-id <id...> / --status-id <id...>	repetível	Apenas estas fases / status de fase.
--tags <tag...>	repetível	Apenas automações que carregam essas tags.
--priority <priority...>	repetível	Apenas essas prioridades.
--submission-type <type>	String	Somente este tipo de envio.
--plain-text	Bandeira	Converter campos de rich text em texto simples.
--limit <n> / --offset <n>	Número inteiro	Paginação. --limit 20Padrão.
--all-fields	Bandeira	Retornar a carga bruta.

Exemplo

uip ah pipelines list --sort-by process_estimated_benefit_score --sort-order desc --limit 10

Formato dos dados (--output json)

{
  "Code": "AhPipelinesList",
  "Data": [
    {
      "Id": 20, "Name": "Invoice intake", "Phase": "Analysis", "PhaseStatus": "In Progress",
      "PhaseOrder": 3, "Priority": 1, "AutomationScore": 78, "EstimatedBenefitFtes": 1.5,
      "EstimatedBenefitPerYear": 42000, "EaseOfImplementation": "Medium",
      "BusinessUnit": "EMEA", "Department": "Finance", "UpdatedEpoch": 1738368000000
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 10, "Offset": 0 }
}

Relacionado

• uip ah — visão geral, conceitos, audit-logs, auth-info.
• Aplicativos, componentes, documentos, mídia, listagens de loja, avaliações de loja
• Categorias, tags, colaboradores, funções, usuários

Veja também

• Ferramentas ( plugins )
• Opções globais
• Códigos de saída