aplicativos uiip ah, componentes, documentos, mídia, listagens de lojas, avaliações de lojas

Sintaxe e opções para o inventário de aplicativos do Automation Hub, componentes reutilizáveis, documentos/mídias anexados e o marketplace da Automation Store (listagens e avaliações publicadas).

O inventário de aplicativos é o que as automações são marcadas (os filtros --application-id em outro lugar fazem referência a ele). Componentes são blocos de construção reutilizáveis, com escopo opcional de uma automação. Documentos e mídia são arquivos anexados a uma automação — um PDD, uma captura de tela, um vídeo de demonstração. A Automation Store é o marketplace interno do Automation Hub: listagens de loja são automações publicadas, e avaliações de loja são as avaliações deixadas nelas. 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.

aplicativos uiip ah

Gerenciar o inventário de aplicativos no qual as automações são marcadas.

Resumo

uip ah applications list [--search <text>] [--category-id <id...>] [--limit <n>] [--offset <n>] [--all-fields]
uip ah applications update --file <json-file>
uip ah applications delete <application-id> [-y, --yes]

lista de aplicativos uip ah

Opções

Long	Valor	Description
--search <text>	String	Pesquisa de texto livre.
--category-id <id...>	repetível	Apenas aplicativos nestas categorias.
--limit <n> / --offset <n>	Número inteiro	Paginação. --limit 20Padrão.
--all-fields	Bandeira	Retornar a carga bruta.

Exemplo

uip ah applications list

Formato dos dados (--output json)

{
  "Code": "AhApplicationsList",
  "Data": [
    { "Id": 1, "Name": "SAP", "Version": "S/4HANA", "Language": null, "Code": "SAP", "IsActive": 1, "AddedByEndUser": 0, "CategoryIds": [4], "CreatedEpoch": 1735689600000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}

atualização de aplicativos uip ah

Atualize aplicativos existentes no inventário a partir de um arquivo. Isso edita entradas que já existem — não pode adicionar uma, porque o serviço requer um application_id em cada elemento.

Opções

Long	Valor	Required	Description
--file <json-file>	Path	sim	Array JSON de aplicativos a serem atualizados. Cada elemento precisa de application_id e categoryIds — tire a forma de applications list --all-fields.

Exemplo

uip ah applications update --file ./applications.json

Formato dos dados (--output json)

{ "Code": "AhApplicationsUpdate", "Data": { "Status": "Updated" } }

exclusão de aplicativos uip ah

Argumentos

Name	Required	Finalidade
<application-id>	sim	ID do aplicativo

Opções

Long	Description
-y, --yes	Confirme esta operação irreversível. Necessário — a CLI nunca solicita.

Exemplo

uip ah applications delete 7 --yes

Formato dos dados (--output json)

{ "Code": "AhApplicationsDelete", "Data": { "Id": 7, "Status": "Deleted" } }

componentes do uip ah

Leia componentes reutilizáveis, em todo o tenant ou por automação. Somente leitura — não há criação/atualização/exclusão nessa superfície.

lista de componentes do uip ah

Opções

Long	Valor	Description
--automation-id <id>	Número inteiro	Escopo para os componentes anexados a esta automação — um ponto de extremidade separado que não aceita outros filtros.
--type <type>	String	Apenas este tipo de componente. Não é possível combinar com --automation-id.
--category-id <id...>	repetível	Apenas estas categorias. Não é possível combinar com --automation-id.
--application-id <id...>	repetível	Apenas componentes usando esses aplicativos. Não é possível combinar com --automation-id.
--limit <n> / --offset <n>	Número inteiro	Paginação. --limit 20Padrão.
--all-fields	Bandeira	Retornar a carga bruta.

--type/--category-id/--application-id combinado com --automation-id falha no lado do cliente — a lista por automação é um endpoint diferente que não aceita filtros.

Exemplos

uip ah components list

uip ah components list --automation-id 20

Formato dos dados (--output json)

{
  "Code": "AhComponentsList",
  "Data": [
    { "Id": 3, "Name": "Invoice parser", "Slug": "invoice-parser", "Description": "...", "TypeId": 1, "ReviewCount": 4, "ReviewAverage": 4.5, "DownloadCount": 12, "StatusId": 1, "PhaseId": 3, "UpdatedEpoch": 1738368000000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}

documentos do uip ah

Gerenciar os documentos anexados a uma automação.

lista de documentos uip ah

Argumentos

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

Opções

Long	Description
--limit <n> / --offset <n>	Paginação. --limit 20Padrão.
--all-fields	Retornar a carga bruta.

Exemplo

uip ah documents list 20

Formato dos dados (--output json)

{
  "Code": "AhDocumentsList",
  "Data": [
    { "Id": 11, "AutomationId": 20, "Title": "PDD", "Description": "...", "TypeId": 1, "FileId": 42, "FileType": "docx", "EmbedLink": null, "IsActive": 1, "CreatedEpoch": 1735689600000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}

FileId é o que documents download leva.

criação de documentos uip ah

Anexar um documento a uma automação — carregue os bytes do arquivo com --file ou vincule a ele com --embed-link (exatamente um dos dois).

Argumentos

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

Opções

Long	Valor	Required	Description
--title <text>	String	sim	Título do documento.
--description <text>	String	sim	Descrição do documento.
--document-type-id <id>	Número inteiro	sim	ID do tipo de documento.
--file <path>	Path	condicionalmente	Arquivo de documento local a ser carregado. Exatamente um dos --file/--embed-link é necessário. Nenhuma lista de permissões de mimetype do lado do servidor — extensões não reconhecidas são carregadas como application/octet-stream.
--embed-link <url>	url	condicionalmente	Vincule para um documento já hospedado. Exatamente um dos --file/--embed-link é necessário.
--submitter <email>	email	não	E-mail do usuário do Automation Hub que está enviando. O padrão é o chamador.

Exemplos

uip ah documents create 20 --title "Process definition" --description "PDD v2" --document-type-id 1 --file ./pdd.docx

uip ah documents create 20 --title "Process definition" --description "PDD v2" --document-type-id 1 --embed-link https://acme.sharepoint.com/pdd.docx

Formato dos dados (--output json)

{ "Code": "AhDocumentsCreate", "Data": { "AutomationId": 20, "Id": 11, "Title": "Process definition", "FileId": 42, "File": "pdd.docx" } }

Com --embed-link, Data carrega EmbedLink em vez de FileId/File.

download de documentos do uip ah

Argumentos

Name	Required	Finalidade
<file-id>	sim	ID do arquivo — o FileId de documents list <automation-id>.

Opções

Long	Valor	Required	Description
--destination <path>	Path	sim	Caminho local no qual gravar o arquivo.

Exemplo

uip ah documents download 42 --destination ./pdd.pdf

Formato dos dados (--output json)

{ "Code": "AhDocumentsDownload", "Data": { "FileId": 42, "Destination": "./pdd.pdf", "Bytes": 20481, "ContentType": "application/pdf" } }

mídia uipath ah

Anexe mídia (capturas de tela, vídeo) a uma automação. Separado de documents — seu próprio ponto de extremidade de upload, e não há listar ou excluir.

criação de mídia uip ah

Argumentos

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

Opções

Long	Valor	Required	Description
--file <path>	Path	sim	Arquivo de mídia local a ser carregado — apenas jpg, jpeg, png, gif ou mp4; qualquer outra extensão será rejeitada no lado do cliente.
--submitter <email>	email	não	E-mail do usuário do Automation Hub que está enviando. O padrão é o chamador.

Exemplo

uip ah media create 20 --file ./screen.png

Formato dos dados (--output json)

{ "Code": "AhMediaCreate", "Data": { "Id": 7, "MediaFileId": 501, "AutomationId": 20, "File": "screen.png" } }

listagens de armazenamento do uip ah

Leia as automações publicadas no Automation Store. Somente leitura.

lista de listagens de armazenamento do uip ah

Opções

Long	Valor	Description
--search <text>	String	Pesquisa de texto livre.
--category-id <id...>	repetível	Apenas estas categorias.
--application-id <id...>	repetível	Apenas listagens usando estes aplicativos.
--business-unit <name>	String	Apenas esta unidade de negócios.
--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 store-listings list

Formato dos dados (--output json)

{
  "Code": "AhStoreListingsList",
  "Data": [
    { "Id": 20, "Name": "Invoice intake", "Slug": "invoice-intake", "ReviewCount": 4, "ReviewScore": 4.2, "DownloadCount": 4, "VoteCount": 9, "IsPublished": 1, "BusinessUnit": "EMEA", "UpdatedEpoch": 1738368000000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}

avaliações de armazenamento do uip ah

Leia as avaliações do Automation Store sobre uma automação. Seu próprio grupo de recursos em vez de um verbo store-listings em. Somente leitura.

lista de avaliações de armazenamento do uip ah

Argumentos

Name	Required	Finalidade
<automation-id>	sim	ID da automação — deve ser publicado no repositório.

Opções

Long	Description
--limit <n> / --offset <n>	Paginação. --limit 20Padrão.
--all-fields	Retornar a carga bruta.

Exemplo

uip ah store-reviews list 20

Formato dos dados (--output json)

{
  "Code": "AhStoreReviewsList",
  "Data": [
    { "Id": 5, "AutomationId": 20, "Score": 5, "Title": "Great automation", "Description": "...", "UserId": 3, "CreatedEpoch": 1735689600000 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}

Relacionado

• uip ah — visão geral, conceitos, audit-logs, auth-info.
• Automações, fluxos de ideias, casos de negócios, fases, questionários, pipelines
• Categorias, tags, colaboradores, funções, usuários

Veja também

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