UiPath Documentation
uipath-cli
latest
false
Guía del usuario de UiPath CLI
Importante :
Este contenido se ha traducido mediante traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

automatizaciones de uip ah, flujos de ideas, casos empresariales, fases, cuestionarios, procesos

Sintaxis y opciones para el ciclo de vida de la idea a la entrega de Automation Hub: enviar y leer ideas de automatización, transiciones de fase, análisis de coste-beneficio, el catálogo de evaluación y la vista del proceso clasificado por beneficios.

Una automatización (Automation Hub llama al registro subyacente "proceso") es el registro central en Automation Hub: una idea enviada que se mueve a través de fases configurables (Idea, Evaluación, Análisis, Diseño de solución, Desarrollo, Pruebas, En vivo, …) a través de un flujo de ideas. Cada fase tiene un análisis de coste-beneficio (caso empresarial) y una evaluación (un conjunto de preguntas del catálogo de cuestionarios ) captura las respuestas que alimentan un envío. La vista del proceso son las automatizaciones más sus cifras de ejecución y beneficios, clasificadas. Consulte uip ah para conceptos compartidos (proyección/--all-fields, listas paginadas frente a no paginadas, descubrimiento de ID) que se aplican a cada verbo aquí.

automatizaciones de UIP ah​

Trabajar con ideas de automatización: el registro principal de Automation Hub.

Sinopsis​

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>
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 automatizaciones de uip ah​

Enumera las ideas de automatización en el tenant.

Opciones​
LargoValorDescripción
--search <text>StringBúsqueda de texto libre, como en la pantalla Explorar.
--sort-by <field>StringCampo por el que ordenar, por ejemplo process_updated_epoch.
--sort-order <direction>asc|descOrdenar dirección.
--category-id <id...>RepetibleSolo automatizaciones en estas categorías.
--application-id <id...>RepetibleSolo automatizaciones que utilizan estas aplicaciones.
--business-unit <name>StringSolo automatizaciones en esta unidad de negocio.
--phase-id <id...>RepetibleSolo automatizaciones en estas fases.
--status-id <id...>RepetibleSolo automatizaciones en estos estados de fase.
--tags <tag...>RepetibleSolo automatizaciones que lleven estas etiquetas.
--owner-id <id>EnteroSolo automatizaciones propiedad de este ID de usuario.
--submitter-id <id>EnteroSolo automatizaciones enviadas por este ID de usuario.
--updated-by-id <id>EnteroSolo las automatizaciones actualizadas por última vez por este ID de usuario.
--submission-type <type>StringSolo este tipo de envío.
--start-date <date> / --end-date <date>YYYY-MM-DDCreado en o después de esta fecha.
--plain-textMarcaConvierte campos de texto enriquecido en texto sin formato.
--high-level-assessmentMarcaIncluye datos de evaluación de alto nivel.
--advanced-informationMarcaIncluye respuestas de preguntas detalladas y personalizadas.
--limit <n> / --offset <n>EnteroPaginación. Predeterminado --limit 20.
--all-fieldsMarcaDevuelve la carga útil sin procesar en lugar de los campos proyectados.
Ejemplo​
uip ah automations list --limit 10 --sort-by process_updated_epoch --sort-order desc
uip ah automations list --limit 10 --sort-by process_updated_epoch --sort-order desc
Forma de datos (--json de salida)​
{
  "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 }
}
{
  "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 se deriva de la matriz process_tags del registro real (o su __display gemelo) en una matriz de string simple. PhaseKey es el valor que toma uip ah phases set --phase.

uip ah automatizaciones obtener​

Obtenga una idea de automatización por id.

Argumentos​
NombreObligatorioPropósito
<automation-id>SíID de automatización.
Opciones​
LargoDescripción
--plain-textConvierte campos de texto enriquecido en texto sin formato.
--all-fieldsDevuelve la carga útil sin procesar.
Ejemplo​
uip ah automations get 20 --plain-text
uip ah automations get 20 --plain-text
Forma de datos (--json de salida)​
{ "Code": "AhAutomationsGet", "Data": { "Id": 20, "Name": "Invoice intake", "Phase": "Analysis" } }
{ "Code": "AhAutomationsGet", "Data": { "Id": 20, "Name": "Invoice intake", "Phase": "Analysis" } }

obtención de esquema de automatizaciones uip ah​

Obtener un esquema de evaluación: el documento create/update consumen. Con un ID de automatización, devuelve el formulario rellenado de esa automatización; sin uno, devuelve una plantilla en blanco para --source-type.

Argumentos​
NombreObligatorioPropósito
[automation-id]NoID de automatización existente, para leer su esquema rellenado. Omitir para una plantilla en blanco.
Opciones​
LargoValorDescripción
--source-type <type>COE|ED|CD|PM|TMObligatorio para una plantilla en blanco (no se proporciona ID de automatización).
--idea-flow-id <id>EnteroID de flujo de ideas, para un flujo personalizado.
--category-id <id>EnteroID de categoría, para elegir la evaluación activa.
--destination <path>RutaEscribe el esquema JSON en este archivo en lugar del sobre de salida.

Se requiere un ID de automatización o --source-type: pasar ninguno falla en el lado del cliente antes de cualquier solicitud.

Ejemplo​
uip ah automations schema get --source-type COE --destination ./idea.json
uip ah automations schema get --source-type COE --destination ./idea.json
Forma de datos (--json de salida)​
{ "Code": "AhAutomationsSchemaGet", "Data": { "SourceType": "COE", "Destination": "./idea.json" } }
{ "Code": "AhAutomationsSchemaGet", "Data": { "SourceType": "COE", "Destination": "./idea.json" } }

Cuando se omite --destination, Data.Schema lleva el documento de esquema en línea en lugar de Destination.

creación de automatizaciones uip ah​

Envíe una nueva idea de automatización. --source-type elige el formulario de envío de forma fija (ED→/automationidea, COE→/coe-automationidea, PM→/processmining-idea); --from-schema envía un documento schema get rellenado a través de /idea-from-schema en su lugar: necesario para los tipos de origen CD/TM, y para cualquier tenant con flujos de ideas personalizados a través de --idea-flow-id.

Opciones​
LargoValorObligatorioDescripción
--source-type <type>COE|ED|CD|PM|TMcondicionalmenteObligatorio a menos que se proporcione --idea-flow-id en su lugar.
--file <json-file>RutaSíCuerpo de la solicitud: el JSON de forma fija o el documento user_inputs relleno con --from-schema.
--from-schemaMarcaNoEnviar a través del punto final del esquema utilizando el documento de automations schema get.
--idea-flow-id <id>EnteroNoFlujo de ideas de destino para --from-schema: reemplaza --source-type para tenants con flujos personalizados. Requiere --from-schema. Conflicto con --source-type.

--idea-flow-id sin --from-schema falla en el lado del cliente (los puntos finales de forma fija no tienen noción de un flujo de ideas). Un --file cuyo JSON ya lleva una clave user_inputs se desenvuelve automáticamente; un archivo que es solo el mapa de respuestas se utiliza tal cual.

Ejemplo​
uip ah automations create --source-type ED --file ./idea.json
uip ah automations create --source-type ED --file ./idea.json
Forma de datos (--json de salida)​
{ "Code": "AhAutomationsCreate", "Data": { "Id": 42, "SourceType": "ED", "Name": "..." } }
{ "Code": "AhAutomationsCreate", "Data": { "Id": 42, "SourceType": "ED", "Name": "..." } }

actualización de automatizaciones de uip ah​

Actualizar las respuestas de evaluación de una automatización desde un archivo: el mismo documento automations schema get <automation-id> escribe.

Argumentos​
NombreObligatorioPropósito
<automation-id>SíID de automatización.
Opciones​
LargoValorObligatorioDescripción
--file <json-file>RutaSíJSON con las user_inputs respuestas a aplicar.
Ejemplo​
uip ah automations update 20 --file ./20.json
uip ah automations update 20 --file ./20.json
Forma de datos (--json de salida)​
{ "Code": "AhAutomationsUpdate", "Data": { "Id": 20, "Status": "Updated" } }
{ "Code": "AhAutomationsUpdate", "Data": { "Id": 20, "Status": "Updated" } }

Flujos de ideas de UIP Ah​

Descubre los flujos de ideas configurados y los pares de fase/estado que permiten.

lista de flujos de ideas de uip ah​

Opciones​
LargoDescripción
--limit <n> / --offset <n>Paginación, aplicada en el lado del cliente (punto final no paginado).
--all-fieldsDevuelve la carga útil sin procesar.
Ejemplo​
uip ah idea-flows list
uip ah idea-flows list
Forma de datos (--json de salida)​
{
  "Code": "AhIdeaFlowsList",
  "Data": [
    { "Id": 1, "Name": "Business Process", "Phases": { "IDEA": "NEW_IDEA, AWAITING_REVIEW", "LIVE": "IN_PRODUCTION" } }
  ]
}
{
  "Code": "AhIdeaFlowsList",
  "Data": [
    { "Id": 1, "Name": "Business Process", "Phases": { "IDEA": "NEW_IDEA, AWAITING_REVIEW", "LIVE": "IN_PRODUCTION" } }
  ]
}

Phases contrae la forma de una columna por fase de la respuesta sin procesar (,,,,,,,,)IDEA ASSESSMENTQUALIFICATIONANALYSISSOLUTION_DESIGNDEVELOPMENTTESTINGTECHNICAL_REVIEWLIVEen un solo objeto, que solo incluye las fases que el flujo realmente utiliza.

UIP ah Casos-de-negocios​

Leer el análisis de coste-beneficio de una automatización (el propio término de Automation Hub es CBA) y establecer su base de referencia del plan de proyecto.

uip ah casos de negocio get​

Argumentos​
NombreObligatorioPropósito
<automation-id>SíID de automatización.
Opciones​
LargoDescripción
--all-fieldsDevuelve la carga útil sin procesar.
Ejemplo​
uip ah business-cases get 20
uip ah business-cases get 20
Forma de datos (--json de salida)​
{ "Code": "AhBusinessCasesGet", "Data": { "AutomationId": 20, "BaselineIsSet": 0, "Sections": [{ "Title": "Project Plan" }] } }
{ "Code": "AhBusinessCasesGet", "Data": { "AutomationId": 20, "BaselineIsSet": 0, "Sections": [{ "Title": "Project Plan" }] } }

UIP Ah Casos-de-Negocios Set-Baseline​

Congela la base de referencia del plan de proyecto para una automatización a partir de un archivo de fechas de fase. Cambia BaselineIsSet a 1.

Argumentos​
NombreObligatorioPropósito
<automation-id>SíID de automatización.
Opciones​
LargoValorObligatorioDescripción
--file <json-file>RutaSí{ "phases": [{ "phase": "Analysis", "start_date": "09/01/2026", "end_date": "09/15/2026" }] }. Los nombres de las fases provienen de la sección Base de referencia de business-cases get (Análisis, Diseño de la solución, Desarrollo, Pruebas, Fecha de lanzamiento); las fechas son MM/DD/YYYY; cada fase, excepto la fecha de lanzamiento, necesita un end_date.

Una matriz de fases vacía se ajusta automáticamente en { "phases": [...] }; cualquier otra cosa que no sea { "phases": [...] } se rechaza en el lado del cliente antes de enviar la solicitud.

Ejemplo​
uip ah business-cases set-baseline 20 --file ./baseline.json
uip ah business-cases set-baseline 20 --file ./baseline.json
Forma de datos (--json de salida)​
{ "Code": "AhBusinessCasesSetBaseline", "Data": { "AutomationId": 20, "Status": "BaselineSet" } }
{ "Code": "AhBusinessCasesSetBaseline", "Data": { "AutomationId": 20, "Status": "BaselineSet" } }

fases de uip ah​

Mover una automatización a través del proceso.

conjunto de fases de uip ah​

Argumentos​
NombreObligatorioPropósito
<automation-id>SíID de automatización.
Opciones​
LargoValorDescripción
--phase <variable>StringVariable de fase de destino, por ejemplo TECHNICAL_REVIEW. Preferido al formulario heredado; emparejar con --status.
--status <variable>StringVariable de estado de destino, por ejemplo AWAITING_REVIEW. Necesario junto con --phase.
--phase-status-id <id>EnteroID de estado de fase numérico heredado: alternativa a --phase/--status, no combinable con ellos.
--submitter-id <id>EnteroID de usuario del remitente. Solo se aplica con --phase-status-id; rechazado con --phase/--status.

Se requiere exactamente un estilo: --phase con --status, o --phase-status-id solo. Encuentra pares de fase/estado válidos con uip ah idea-flows list.

Ejemplos​
uip ah phases set 20 --phase TECHNICAL_REVIEW --status AWAITING_REVIEW
uip ah phases set 20 --phase TECHNICAL_REVIEW --status AWAITING_REVIEW
uip ah phases set 20 --phase-status-id 118
uip ah phases set 20 --phase-status-id 118
Forma de datos (--json de salida)​
{ "Code": "AhPhasesSet", "Data": { "AutomationId": 20, "Phase": "TECHNICAL_REVIEW", "Status": "AWAITING_REVIEW" } }
{ "Code": "AhPhasesSet", "Data": { "AutomationId": 20, "Phase": "TECHNICAL_REVIEW", "Status": "AWAITING_REVIEW" } }

Con --phase-status-id, Data lleva PhaseStatusId en lugar de Phase/Status.

cuestionarios uip ah​

Lee el catálogo de preguntas de evaluación.

lista de cuestionarios uip ah​

Opciones​
LargoValorObligatorioDescripción
--assessment <name>high-level|detailed|citizen-developmentSíEvaluación para leer.
--section <key>StringNoSolo esta sección, por ejemplo q1-overview.
--active-only / --no-active-onlyMarcaNoSolo preguntas activas (el valor predeterminado del servidor) / incluir también las inactivas.
--mandatory-onlyMarcaNoSolo preguntas obligatorias.
--limit <n> / --offset <n>EnteroNoPaginación, aplicada en el lado del cliente (punto final no paginado).
--all-fieldsMarcaNoDevuelve la carga útil sin procesar.
Ejemplo​
uip ah questionnaires list --assessment high-level
uip ah questionnaires list --assessment high-level
Forma de datos (--json de salida)​
{
  "Code": "AhQuestionnairesList",
  "Data": [
    {
      "Section": "Overview", "SectionKey": "q1-overview", "SectionId": 1, "QuestionCount": 6,
      "Questions": [{ "Id": 101, "Key": "q1", "Title": "...", "IsMandatory": 1, "IsActive": 1 }]
    }
  ]
}
{
  "Code": "AhQuestionnairesList",
  "Data": [
    {
      "Section": "Overview", "SectionKey": "q1-overview", "SectionId": 1, "QuestionCount": 6,
      "Questions": [{ "Id": 101, "Key": "q1", "Title": "...", "IsMandatory": 1, "IsActive": 1 }]
    }
  ]
}

Procesos de UIP Ah​

Leer el proceso de automatización: automatizaciones con sus cifras de fase y beneficios. Separado de automations list: el punto final añade columnas de beneficios por fase y deletrea su dirección de ordenación order internamente (mismo marcador --sort-order).

lista de procesos de uip ah​

Opciones​
LargoValorDescripción
--search <text>StringBúsqueda de texto libre.
--sort-by <field>StringCampo por el que ordenar.
--sort-order <direction>asc|descOrdenar dirección.
--category-id <id...>RepetibleSolo estas categorías.
--application-id <id...>RepetibleSolo automatizaciones que utilizan estas aplicaciones.
--business-unit <name> / --department <name>StringFiltros de ámbito.
--phase-id <id...> / --status-id <id...>RepetibleSolo estas fases/estados de fase.
--tags <tag...>RepetibleSolo automatizaciones que lleven estas etiquetas.
--priority <priority...>RepetibleSolo estas prioridades.
--submission-type <type>StringSolo este tipo de envío.
--plain-textMarcaConvierte campos de texto enriquecido en texto sin formato.
--limit <n> / --offset <n>EnteroPaginación. Predeterminado --limit 20.
--all-fieldsMarcaDevuelve la carga útil sin procesar.
Ejemplo​
uip ah pipelines list --sort-by process_estimated_benefit_score --sort-order desc --limit 10
uip ah pipelines list --sort-by process_estimated_benefit_score --sort-order desc --limit 10
Forma de datos (--json de salida)​
{
  "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 }
}
{
  "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 }
}

Ver también​

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado