categorias do uip ah, tags, colaboradores, funções, usuários

Sintaxe e opções para a taxonomia da categoria do Automation Hub, tags de texto livre, colaboradores por automação, catálogo de funções atribuíveis e contas de usuário.

As categorias são uma taxonomia hierárquica em que as automações são colocadas; tags são rótulos de texto livre. Colaboradores são as pessoas que trabalham em uma automação, cada um com uma ou mais funções — o catálogo de funções atribuíveis do Automation Hub também é o modo como uip ah users create concede acesso a todo o tenant. Consulte uip ah para obter conceitos compartilhados (projeção/--all-fields, listas paginadas versus não paginadas) que se aplicam a todos os verbos aqui.

categorias do uipath ah

Leia a hierarquia de categorias e coloque automações nela.

Resumo

uip ah categories get [--all-fields]
uip ah categories update --file <json-file> [-y, --yes]
uip ah categories set <automation-id> --category-id <id>

categorias uip ah obter

Obtenha a hierarquia de categorias como uma árvore, com seus nomes de níveis. get, não list: o ponto de extremidade retorna um documento aninhado, não uma coleção paginada — não há --limit/--offset.

Opções

Long	Description
--all-fields	Retorne a carga bruta em vez de Levels/Categories.

Exemplo

uip ah categories get

Formato dos dados (--output json)

{
  "Code": "AhCategoriesGet",
  "Data": { "Levels": [{ "Id": 1, "Name": "Business Unit" }], "Categories": [{ "Id": 4, "Name": "Finance" }] }
}

atualização de categorias do uip ah

Substitua toda a árvore de categoria de um arquivo. O Automation Hub não possui criação/exclusão por categoria — a árvore é sincronizada como um documento.

Opções

Long	Valor	Required	Description
--file <json-file>	Path	sim	JSON com a árvore de categoria completa para sincronizar, na forma categories get retorna.
-y, --yes	Bandeira	sim	Confirme se isso substitui toda a árvore de categoria de tenant. Necessário — a CLI nunca solicita.

Um arquivo vazio ou claramente malformado é rejeitado do lado do cliente antes que a solicitação seja enviada.

Exemplo

uip ah categories update --file ./categories.json --yes

Formato dos dados (--output json)

{ "Code": "AhCategoriesUpdate", "Data": { "Status": "Synced" } }

conjuntos de categorias uip ah

Atribua uma automação a uma categoria.

Argumentos

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

Opções

Long	Valor	Required	Description
--category-id <id>	Número inteiro	sim	ID da categoria a atribuir.

Exemplo

uip ah categories set 20 --category-id 4

Formato dos dados (--output json)

{ "Code": "AhCategoriesSet", "Data": { "AutomationId": 20, "CategoryId": 4 } }

tags uip ah

Defina as tags em uma automação.

conjunto de tags uip ah

Substituir as tags de uma automação pelo conjunto fornecido — isso substitui toda a lista de tags em vez de mesclar (correspondendo à semântica de substituição de uip config set).

Argumentos

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

Opções

Long	Valor	Required	Description
--tags <tag...>	repetível	sim	O conjunto de tags completo para esta automação.

Exemplo

uip ah tags set 20 --tags finance "quick win"

Formato dos dados (--output json)

{ "Code": "AhTagsSet", "Data": { "AutomationId": 20, "Tags": ["finance", "quick win"] } }

Colaboradores da uip ah

Gerencie quem colabora em uma automação. Seu próprio grupo de recursos, em vez de um verbo automations em, portanto, os verbos CRUD padrão permanecem disponíveis para ele.

Resumo

uip ah collaborators list --automation-id <id> [--limit <n>] [--offset <n>] [--all-fields]
uip ah collaborators create <automation-id> --user-id <id...> --role-id <id...>
uip ah collaborators delete <automation-id> --user-id <id...> --role-id <id...> [-y, --yes]

lista de colaboradores do uip ah

Opções

Long	Valor	Required	Description
--automation-id <id>	Número inteiro	sim	Automação a ser lida (um parâmetro de consulta nesse ponto de extremidade, não um posicional).
--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 collaborators list --automation-id 20

Formato dos dados (--output json)

{
  "Code": "AhCollaboratorsList",
  "Data": [
    { "Id": 1, "Email": "[e-mail]", "FirstName": "Jane", "LastName": "Doe", "JobTitle": "Analyst", "Department": "Finance", "BusinessUnit": "EMEA", "IsActive": 1 }
  ]
}

colaboradores do uip ah criar

Adicione colaboradores a uma automação.

Argumentos

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

Opções

Long	Valor	Required	Description
--user-id <id...>	repetível	sim	IDs de usuário a adicionar.
--role-id <id...>	repetível	sim	IDs de função para conceder cada usuário adicionado (aplicado a todos eles — uma divisão de função por usuário precisa de uma chamada por usuário). Apenas funções ativas do tipo process são aceitas; o ponto de extremidade rejeita qualquer outro tipo.

Pelo menos um --role-id é necessário — o ponto de extremidade rejeita uma entrada de colaborador sem função.

Exemplo

uip ah collaborators create 20 --user-id 3 --role-id 3

Formato dos dados (--output json)

{ "Code": "AhCollaboratorsCreate", "Data": { "AutomationId": 20, "UserIds": [3] } }

colaboradores uip ah excluir

Remova funções de colaborador de usuários em uma automação. O ponto de extremidade exclui atribuições de função em vez do registro do colaborador, então --role-id é necessário — remove todas as funções que um usuário possui e ele deixa de ser um colaborador.

Argumentos

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

Opções

Long	Valor	Required	Description
--user-id <id...>	repetível	sim	IDs de usuários dos quais remover funções.
--role-id <id...>	repetível	sim	IDs de função a serem removidos de cada usuário.
-y, --yes	Bandeira	sim	Confirme esta operação irreversível. Necessário — a CLI nunca solicita.

Exemplo

uip ah collaborators delete 20 --user-id 3 --role-id 3 --yes

Formato dos dados (--output json)

{ "Code": "AhCollaboratorsDelete", "Data": { "AutomationId": 20, "UserIds": [3], "RoleIds": [3] } }

funções uip ah

Descubra as funções do Automation Hub que podem ser atribuídas. Somente leitura.

lista de funções 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 roles list

Formato dos dados (--output json)

{
  "Code": "AhRolesList",
  "Data": [
    { "Id": 2, "Name": "System Admin", "Slug": "ah-system-admin", "Type": "service", "Description": "...", "IsActive": 1, "IsDefault": 0 }
  ]
}

Slug é o valor que uip ah users create --role aceita; Id/Type são o que collaborators create --role-id filtra (apenas as funções Type: "process" são aceitas lá).

Usuários uip ah

Gerencie os usuários do Automation Hub e suas funções.

Resumo

uip ah users list [--search <text>] [--sort-by <field>] [--sort-order asc|desc] [--department <name>] [--business-unit <name>] [--location <name>] [--job-title <title>] [--invite-status <status>] [--role <slug>] [--limit <n>] [--offset <n>] [--all-fields]
uip ah users create --email <email> [write options...] --role-id <id...>
uip ah users update --email <email> [write options...]

lista de usuários uip ah

Opções

Long	Valor	Description
--search <text>	String	Pesquisa de texto livre.
--sort-by <field>	String	O campo para classificar, por exemplo user_email).
--sort-order <direction>	asc|desc	Classificar direção.
--department <name> / --business-unit <name> / --location <name> / --job-title <title>	String	Filtros de escopo.
--invite-status <status>	String	Somente este status de convite.
--role <slug>	String	Apenas usuários com este campo de dados dinâmico de função.
--limit <n> / --offset <n>	Número inteiro	Paginação. --limit 20Padrão.
--all-fields	Bandeira	Retornar a carga bruta.

Exemplo

uip ah users list --department Finance --limit 20

Formato dos dados (--output json)

{
  "Code": "AhUsersList",
  "Data": [
    { "Id": 3, "Email": "[e-mail]", "FirstName": "Jane", "LastName": "Doe", "JobTitle": "Analyst", "Department": "Finance", "BusinessUnit": "EMEA", "Location": "Boston", "IsAdmin": 0, "IsActive": 1, "InviteStatus": 2, "AutomationCount": 3 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}

usuários uip ah criar

Adicione um usuário existente do Automation Cloud ao Automation Hub. Isso importa um usuário que já está na organização — não pode convidar um novo e falha com um erro de instrução explícito se o endereço for desconhecido para a Automation Cloud.

Opções

Long	Valor	Required	Description
--email <email>	email	sim	Endereço de email do usuário.
--first-name <name> / --last-name <name>	String	condicionalmente	Exigido pelo serviço na gravação (veja abaixo).
--job-title <title> / --department <name> / --business-unit <name> / --location <name>	String	condicionalmente	Exigido pelo serviço na gravação.
--invite-status <status>	Número inteiro	não	Código de status de convite numérico do Automation Hub. Padrão 2 ao criar.
--active	Bandeira	não	Marcar usuário como ativo. Padrão em criar. Entre em conflito com --inactive.
--inactive	Bandeira	não	Marcar o usuário como inativo. Entre em conflito com --active.
--role-id <id...>	repetível	não	IDs de função a ser atribuído (uip ah roles list para os IDs).

O Automation Hub requer nove campos para carregar um valor em cada gravação (email, first-name, last-name, business-unit, department, location, job-title, invite-status, active/inactive) — em create, nenhum tem um fallback armazenado, portanto, qualquer campo omitido falha na nomeação do lado do cliente exatamente quais sinalizadores passar.

Exemplo

uip ah users create --email [e-mail] --first-name Jane --last-name Doe \
  --job-title Analyst --department Finance --business-unit EMEA --location Boston --role-id 3

Formato dos dados (--output json)

{ "Code": "AhUsersCreate", "Data": { "Email": "[e-mail]", "Status": "Created" } }

atualização de usuários uip ah

Atualize um usuário, encontrado por --email. O Automation Hub substitui todo o registro do usuário na gravação, de modo que os campos que você não transmitir são carregados do registro armazenado. Exceto pelo fato de o serviço ainda rejeitar a gravação se qualquer um dos nove campos obrigatórios estiver vazio tanto no sinalizador quanto no registro armazenado .

Opções

Mesmos sinalizadores que create, mas apenas --email é necessário — o resto preenche lacunas do registro existente.

Exemplo

uip ah users update --email [e-mail] --job-title 'Senior Analyst'

Formato dos dados (--output json)

{ "Code": "AhUsersUpdate", "Data": { "Email": "[e-mail]", "Status": "Updated" } }

Relacionado

• uip ah — visão geral, conceitos, audit-logs, auth-info.
• Automações, fluxos de ideias, casos de negócios, fases, questionários, pipelines
• Aplicativos, componentes, documentos, mídia, listagens de loja, avaliações de loja

Veja também

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