automation-hub
2.2510
true
Guia da API do Automation Hub
- OpenAPI
- Introdução à API do Automation Hub
- Referências de API
- Gerar seu token do Automation Hub
- Autenticação para a API do Automation Hub
- Adicione usuários em massa ao Automation Hub usando OpenAPI
- Edição de usuários em massa no Automation Hub usando OpenAPI
- Recuperar ideia de automação na fase Ideia com status Esperando Revisão
- Recuperar a análise de custo-benefício para uma ideia específica
- Atualizar a fase e o status da ideia de automação
- Recuperar uma conta de usuário
- Atualizar detalhes de conta para funcionários a partir do Automation Hub
- Desativar contas de usuários que não fazem parte da empresa
- Entrada para o pipeline de automação
- Entrada para o tipo de envio
- Entrada para a fase
- Entrada para o status
- Entrada para a atualização de fase e status
- Entrada para a unidade de negócios
- Entrada para aplicativos
- Entrada para a categoria
- Entrada para a análise de custo-benefício
- Entrada para a Avaliação Geral
- Entrada para a Avaliação Detalhada
- Entrada para o data de criação da ideia de automação
- Entrada para usuários
- Entrada para o status do usuário
- Tabela de status do usuário
- Entrada para colaboradores
- Dicionário de saída
- Análise de dados da Open API do Automation Hub com Power Query
Importante :
A tradução automática foi aplicada parcialmente neste conteúdo.
A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.
Dicionário de saída
Dicionário de campos de saída para respostas da API do Automation Hub no Automation Suite 2.2510, cobrindo Pipeline, Ideias, Estoque de aplicativos, Hierarquia, Usuários e Funções.
GET Automation Pipeline
| Name | Description |
| process_id | ID do processo |
| process_slug | Campo de dados dinâmico da ideia |
| process_name | Nome da ideia |
| process_description | Descrição da ideia |
| orchestrator_automation_uuid | ID da ideia |
| user_department | Departamento do Remetente |
| user_business_unit | Unidade de negócios do remetente |
| process_goal | Objetivo do processo |
| process_phase_id | ID da fase |
| process_phase_status_id | ID do status da fase |
| process_overall_gauge_score | Pontuação geral da ideia |
| process_automation_score | Potencial da ideia |
| process_estimated_benefit_score | Benefício estimado (horas) |
| software_vendor_id | Fornecedor de Software de RPA |
| software_cost_id | Custo do software |
| cost_description | Descrição do Custo |
| process_type_id | Tipo da ideia |
| Proprietário | Proprietário do Processo |
| process_ease_of_implementation_score | Facilidade de Implementação |
| process_submitter_user_id | ID do usuário remetente |
| process_submission_type | Tipo de envio da ideia |
| process_num_collaborators | Número de Colaboradores |
| process_num_votes | Número de Votos |
| process_created_epoch | Valor epoch de quando o processo foi criado |
| process_updated_epoch | Valor epoch de quando o processo foi atualizado |
| check_collaborators | (campo interno) |
| number_of_robots | Número de Robôs |
| relevance | (campo interno) |
| category_id | ID da área da ideia |
| category_other_text | ID da área da ideia |
| category_name | Nome da área da ideia |
| category_level_id | Hora de criação da área da ideia |
| category_is_other | Valor epoch da criação da área da ideia |
| subcategorias | Tempo de atualização da área da ideia |
| software_vendor | Fornecedor de Software de RPA |
| running_cost | Est. de Custos de Execução |
| process_phase | Fase de Ideia |
| phase_id | ID da fase da ideia |
| phase_key | Chave da fase da ideia |
| phase_name | Nome da fase da ideia |
| phase_is_active | A fase está ativa |
| phase_order | Ordem da fase |
| process_phase_status | Status da ideia |
| phase_status_id | ID do status da ideia |
| phase_id | ID da fase da ideia |
| phase_status_key | Chave do status da ideia |
| phase_status_name | Nome do status da ideia |
| phase_status_is_active | O status da ideia está ativo |
| phase_status_order | Ordem do status da ideia |
| Moeda | Moeda |
| currency_id | ID da moeda |
| currency_name | Nome da moeda |
| currency_abbreviation | Abreviação da moeda |
| currency_symbol | Símbolo de moeda |
| currency_is_active | A moeda está ativa |
| currency_sort_order | Ordem da classificação da moeda |
| process_submitter | Remetente da ideia |
| user_id | ID do usuário remetente da ideia |
| user_email | E-mail do remetente da ideia |
| user_first_name | Nome do remetente da ideia |
| user_last_name | Sobrenome do remetente da ideia |
| readable_submission_time | Hora de envio da ideia |
| Proprietário | Proprietário do processo da ideia |
| user_id | ID de usuário do proprietário do processo de ideia |
| user_email | E-mail do proprietário do processo da ideia |
| user_first_name | Nome do proprietário do processo da ideia |
| user_last_name | Sobrenome do proprietário do processo da ideia |
| pdd_link | Link de PDD |
| idea_phase_approver | A pessoa que atualizou a fase da ideia |
| launch_assessment_approver | A pessoa que iniciou a avaliação da ideia |
| qualification_phase_approver |
Ideias de Automação
GET Automation Ideas
| Name | Description |
| process_id | ID do processo |
| process_slug | Campo de dados dinâmico da ideia |
| process_submitter_user_id | O ID do banco de dados do remetente da ideia |
| process_name | Nome da ideia |
| process_description | Descrição da ideia |
| process_rules_id | Resposta à pergunta: Até que ponto sua tarefa é baseada em regras |
| process_input_type_id | Resposta à pergunta: Como você descreveria os dados de entrada para sua tarefa/processo? |
| process_stability_id | Resposta à pergunta: Você está ciente de alguma mudança esperada nos próximos 6 meses na maneira como executa atualmente a atividade ou processo? |
| process_input_structure_id | Resposta à pergunta: Como você descreveria a estrutura de seus dados de entrada? |
| process_documentation_availability_ids | Resposta à pergunta: Você tem alguma documentação referente a este processo/atividade? |
| Proprietário | O ID do banco de dados do proprietário do processo |
| process_created_epoch | Valor epoch de quando o processo foi criado |
| process_created_at | Carimbo de data/hora de quando o processo foi criado |
| process_updated_epoch | Valor epoch de quando o processo foi atualizado |
| process_updated_at | Carimbo de data/hora de quando o processo foi atualizado |
| process_updated_user_id | O ID do banco de dados do usuário que atualizou o processo pela última vez |
| process_phase_id | ID da fase |
| process_phase_status_id | ID do status da fase |
| process_challenges_encountered | Desafios Encontrados |
| process_challenges_expected | Desafios Esperados |
| process_task_stability_id | Mudanças Esperadas no Processo nos Próximos 6 Meses |
| process_application_stability_id | Mudanças Esperadas nos Aplicativos nos Próximos 6 Meses |
| process_frequency_id | Frequência da Tarefa/Processo |
| process_volume | Média de volume da atividade |
| process_average_handling_time | Tempo médio de processamento por transação |
| process_peak_id | Picos no Processo |
| process_length_id | Número Médio de Etapas |
| process_decision_complexity_id | Variabilidade do Processo |
| process_digital_input_percent | % de Entrada de Dados Digitais |
| process_scanned_input_use_id | Entrada de Dados Escaneados |
| process_structured_input_id | % de entrada de dados digitais estruturados* |
| process_lessons_learned | Lições Aprendidas |
| process_benefits_expected | Benefícios Esperados |
| process_benefits_actual | Benefícios Reais |
| process_suitability_score | Adequação da ideia |
| process_readiness_score | Prontidão da ideia |
| process_overall_gauge_score | Pontuação geral da ideia |
| process_uuid | ID exclusivo do processo |
| process_num_followers | Número de seguidores do processo |
| process_num_votes | Número de votos positivos |
| process_num_media | Número de mídias carregadas |
| process_num_documents | Número de documentos carregados |
| process_num_collaborators | Número de Colaboradores |
| process_num_components | Número de componentes anexados |
| process_has_owner | Indica se o Proprietário do Processo foi anexado ou não à ideia |
| process_num_comments | Número de Comentários |
| process_num_applications | Número de Aplicativos usados |
| process_automation_score | Potencial da ideia |
| process_ease_of_implementation_score | Facilidade de Implementação |
| process_estimated_benefit_score | Benefício (horas economizadas por ano) |
| process_benefit_expressed_in_currency_per_year | Benefício (moeda/ano) |
| process_east_of_baseline_score | |
| process_num_similar_automations | Número de ideias semelhantes |
| process_is_potential_duplicate | Duplicatas potenciais para a ideia |
| process_submitted_at | Carimbo de data/hora de quando o processo foi enviado |
| process_submitted_epoch | Valor epoch de quando o processo foi submetido |
| process_history_version | |
| project_manager_user_id | O ID do gerente de projeto anexado à ideia |
| process_goal | ID do objetivo da ideia |
| process_archived_reason | Motivo para arquivar a ideia |
| process_rejected_reason | Motivo para rejeitar a ideia |
| process_pain_points | Pontos problemáticos |
| process_negative_impact | Impacto negativo |
| process_submission_type | Tipo de envio (ideia orientada por Centro de Excelência/Funcionário) |
| process_volumes_per_year | Volumetria do processo — volumes/ano |
| process_AHT_employee_per_transaction | Funcionário AHT por Transação (minutos) |
| process_ease_of_implementation_level | Um dos 3 níveis de facilidade de implementação — Fácil/Médio/Difícil |
| process_cost_per_year | Custo operacional/ano antes da ideia para humanos |
| process_automation_id | ID da ideia |
| process_business_unit | Unidade de negócios da ideia |
| process_department | Departamento da ideia |
| orchestrator_automation_uuid | ID da ideia |
| process_headcount | Número de Funcionários que Realizam a Tarefa |
| user_is_following | Existe um usuário que segue a ideia |
| user_has_voted | Existe um usuário que votou na ideia |
| process_phase | Fase do status |
| phase_id | ID da fase |
| phase_key | Chave da fase |
| phase_name | Nome da fase |
| phase_is_active | A fase está ativa |
| phase_order | Ordem da fase |
| process_phase_status | Status do processo |
| phase_status_id | ID do status |
| phase_id | ID da fase |
| phase_status_key | Chave do status |
| phase_status_name | Nome do status |
| phase_status_is_active | O estado está ativo |
| phase_status_order | Ordem do status |
| category_id | ID da categoria |
| category_other_text | Texto da categoria se ela foi renomeada |
| category_name | Nome da categoria da interface |
| category_level_id | ID do nível para a categoria — valores de 1 a 5 |
| category_is_other | Indica se a categoria é outra |
| subcategorias | Matriz para subcategorias |
| process_rules_comment | Comentário sobre a pergunta das regras |
| process_input_type_comment | Comentário sobre a pergunta de Input_Type |
| process_input_quality_comment | Comentário sobre a pergunta de Input_Quality |
| process_stability_comment | Comentário sobre a pergunta de estabilidade |
| process_document_availability_comment | Comentário sobre a pergunta de Document_Availability |
| process_submitter | Remetente da ideia |
| user_id | ID do remetente da ideia |
| user_email | E-mail do remetente da ideia |
| user_first_name | Nome do remetente |
| user_last_name | Sobrenome do remetente |
| readable_submission_time | Hora de envio da ideia |
| process_owner | Proprietário do processo da ideia |
| user_id | ID do proprietário do processo da ideia |
| user_email | E-mail do proprietário do processo da ideia |
| user_first_name | Nome do remetente |
| user_last_name | Sobrenome do remetente |
| advanced_information | Informações avançadas |
| Moeda | Moeda |
| currency_id | ID da moeda |
| currency_name | Nome da moeda |
| currency_abbreviation | Abreviação da moeda |
| currency_symbol | Símbolo de moeda |
| currency_is_active | Indica se a moeda está ativa |
| currency_sort_order | Indica a ordem de classificação da moeda na tabela de moedas |
POST Automation Ideas
| Name | Description |
| process_phase_status_id | ID do status da fase |
| process_name | Nome da ideia |
| process_description | Descrição da ideia |
| process_has_owner | Proprietário do processo definido |
| Proprietário | ID do usuário proprietário do processo |
| process_rules_id | Resposta à pergunta: Até que ponto sua tarefa é baseada em regras |
| process_input_type_id | Resposta à pergunta: Como você descreveria os dados de entrada para sua tarefa/processo? |
| process_input_structure_id | Resposta à pergunta: Você está ciente de alguma mudança esperada nos próximos 6 meses na maneira como executa atualmente a atividade ou processo? |
| process_stability_id | Resposta à pergunta: Como você descreveria a estrutura de seus dados de entrada? |
| process_documentation_availability_ids | Resposta à pergunta: Você tem alguma documentação referente a este processo/atividade? |
| process_suitability_score | Adequação da ideia |
| process_readiness_score | Prontidão da ideia |
| process_overall_gauge_score | Pontuação geral da ideia |
| process_slug | Campo de dados dinâmico da ideia |
| process_submitted_at | Carimbo de data/hora de quando a ideia foi enviada |
| process_submitted_epoch | Valor epoch de quando a ideia foi apresentada |
| process_updated_user_id | ID de usuário do último usuário que atualizou a ideia |
| process_updated_epoch | Valor epoch da última atualização da ideia |
| process_updated_at | Carimbo de data/hora da última atualização da ideia |
| process_id | O ID do processo |
| process_submitter_user_id | O ID do banco de dados do remetente da ideia |
| process_created_epoch | Valor epoch de quando o processo foi criado |
| process_created_at | Carimbo de data/hora de quando o processo foi criado |
| process_phase_id | ID da fase |
| process_challenges_encountered | Desafios Encontrados |
| process_challenges_expected | Desafios Esperados |
| process_task_stability_id | Mudanças Esperadas no Processo nos Próximos 6 Meses |
| process_application_stability_id | Mudanças Esperadas nos Aplicativos nos Próximos 6 Meses |
| process_frequency_id | Frequência da Tarefa/Processo |
| process_volume | Média de volume da atividade |
| process_average_handling_time | Tempo médio de processamento por transação |
| process_peak_id | Picos no Processo |
| process_length_id | Número Médio de Etapas |
| process_decision_complexity_id | Variabilidade do Processo |
| process_digital_input_percent | % de Entrada de Dados Digitais |
| process_scanned_input_use_id | Entrada de Dados Escaneados |
| process_structured_input_id | % de entrada de dados digitais estruturados* |
| process_lessons_learned | Lições Aprendidas |
| process_benefits_expected | Benefícios Esperados |
| process_benefits_actual | Benefícios Reais |
| process_uuid | ID exclusivo do processo |
| process_num_followers | Número de seguidores do processo |
| process_num_votes | Número de votos positivos |
| process_num_media | Número de mídias carregadas |
| process_num_documents | Número de documentos carregados |
| process_num_collaborators | Número de Colaboradores |
| process_num_components | Número de componentes anexados |
| process_num_comments | Número de Comentários |
| process_num_applications | Número de Aplicativos usados |
| process_automation_score | Potencial da ideia |
| process_ease_of_implementation_score | Facilidade de Implementação |
| process_estimated_benefit_score | Benefício (horas economizadas por ano) |
| process_benefit_expressed_in_currency_per_year | Benefício (moeda/ano) |
| process_num_similar_automations | Número de ideias semelhantes |
| process_is_potential_duplicate | Duplicatas potenciais para a ideia |
| project_manager_user_id | O ID do gerente de projeto anexado à ideia |
| process_goal | ID do objetivo da ideia |
| process_rejected_reason | Motivo para rejeitar a ideia |
| process_pain_points | Pontos problemáticos |
| process_negative_impact | Impacto negativo |
| process_submission_type | Tipo de envio (ideia orientada por Centro de Excelência/Funcionário) |
| process_volumes_per_year | Volumetria do processo — volumes/ano |
| process_AHT_employee_per_transaction | Funcionário AHT por Transação (minutos) |
| process_ease_of_implementation_level | Um dos 3 níveis de facilidade de implementação — Fácil/Médio/Difícil |
| process_cost_per_year | Custo operacional/ano antes da ideia para humanos |
| process_automation_id | ID da automação |
| process_business_unit | Unidade de negócios da ideia |
| process_department | Departamento da ideia |
| process_headcount | Número de Funcionários que Realizam a Tarefa |
| user_is_following | Existe um usuário que segue a ideia |
| user_has_voted | Há um usuário que votou na ideia |
| process_phase | Fase do status |
| phase_id | ID da fase |
| phase_key | Chave da fase |
| phase_name | Nome da fase |
| process_phase_status | Status do processo |
| phase_status_id | ID do status |
| phase_id | ID da fase |
| phase_status_key | Chave do status |
| phase_status_name | Nome do status |
| category_id | ID da categoria |
| category_other_text | Texto da categoria se ela foi renomeada |
| category_name | Nome da categoria da interface |
| category_level_id | ID do nível para a categoria — valores de 1 a 5 |
| category_is_other | Indica se a categoria é outra |
| subcategorias | Matriz para subcategorias |
| process_rules_comment | Comentário sobre a pergunta das regras |
| process_input_type_comment | Comentário sobre a pergunta do tipo de entrada |
| process_input_quality_comment | Comentário sobre a pergunta de qualidade de entrada |
| process_stability_comment | Comentário sobre a pergunta de estabilidade |
| process_document_availability_comment | Comentário sobre a pergunta de disponibilidade de documentos |
| process_submitter | Remetente da ideia |
| user_id | ID do remetente da ideia |
| user_email | E-mail do remetente da ideia |
| user_first_name | Nome do remetente |
| user_last_name | Sobrenome do remetente |
| readable_submission_time | Hora de envio da ideia |
| process_owner | Proprietário do processo da ideia |
| user_id | ID do proprietário do processo da ideia |
| user_email | E-mail do proprietário do processo da ideia |
| user_first_name | Nome do remetente |
| user_last_name | Sobrenome do remetente |
| advanced_information | Informações avançadas |
| Moeda | Moeda |
| currency_id | ID da moeda |
| currency_name | Nome da moeda |
| currency_abbreviation | Abreviação da moeda |
| currency_symbol | Símbolo de moeda |
| orchestrator_automation_uuid | ID da ideia |
GET App Inventory
| Name | Description |
| application_id | Indica o ID do aplicativo |
| application_name | Nome do aplicativo |
| application_taxonomy_L1_id | ID da categoria de aplicativo (L1) correspondente ao aplicativo |
| application_version | A versão do aplicativo |
| application_language | Idioma do aplicativo |
| application_code | Código do aplicativo |
| application_is_active | Indica se o aplicativo está ativo |
| application_added_by_end_user | Indica se o aplicativo foi adicionado por um usuário final |
| application_added_user_id | Indica o ID do usuário que adicionou o aplicativo |
| application_created_epoch | Valor epoch de quando o aplicativo foi criado |
| categoryIds | Indica os IDs das categorias às quais o aplicativo está vinculado |
GET Hierarchy
| Name | Description |
|---|---|
| category_id | ID da categoria |
| category_other_text | Texto da categoria se ela foi renomeada |
| category_name | Nome da categoria — que aparece na interface |
| category_level_id | ID do nível para a categoria — valores de 1 a 5 |
| category_is_other | Indica se a categoria é outra |
| subcategorias | Matriz para subcategorias |
GET Users
| Name | Description |
| user_id | Indica o ID do usuário |
| user_email | O e-mail do usuário |
| user_first_name | Primeiro nome do usuário |
| user_last_name | Sobrenome do usuário |
| user_is_admin | Indica se o usuário é o “Primeiro usuário” do tenant, o usuário que criou o tenant |
| user_job_title | Título do Trabalho do Usuário |
| user_location | Localização do Usuário |
| user_business_unit | Unidade de negócios do usuário |
| user_department | Departamento do usuário |
| user_created_at | Carimbo de data/hora de quando o usuário foi criado |
| user_updated_at | Carimbo de data/hora de quando o usuário foi atualizado |
| user_last_login_time | Último login do usuário |
| user_num_automations | Número de ideias do usuário |
| user_num_documents | Número de documentos do usuário criados no tenant |
| user_num_components | Número de componentes do usuário |
| user_invite_status | Define se o usuário recebeu um convite por e-mail ou não |
| user_is_active | Define se o usuário está ativo ou não |
GET Roles
| Name | Description |
|---|---|
| role_description | A descrição da função |
| role_id | O ID da função |
| role_name | O nome da função |
| role_slug | O campo de dados dinâmico da ideia |
| role_type | O tipo da função |