UiPath Documentation
automation-hub
2023.10
false
Automation Hub API guide

Output Dictionary

Output field reference for Automation Hub API responses, covering Pipeline, Ideas, App Inventory, Hierarchy, Users, and Roles endpoints.

GET Automation Pipeline

NameDescription
process_idID of the process
process_slugSlug of the idea
process_nameIdea Name
process_descriptionDescription of the Idea
orchestrator_automation_uuidIdea ID
user_departmentSubmitter's Department
user_business_unitSbumitter's Business Unit
process_goalProcess goal
process_phase_idPhase ID
process_phase_status_idPhase status ID
process_overall_gauge_scoreOverall idea score
process_automation_scoreIdea potential
process_estimated_benefit_scoreEstimated benefit (Hours)
software_vendor_idRPA Software Vendor
software_cost_idSoftware cost
cost_descriptionCost Description
process_type_idIdea Type
ownerProcess Owner
process_ease_of_implementation_scoreEase of implementation
process_submitter_user_idSubmitter User ID
process_submission_typeIdea Submission type
process_num_collaboratorsNumber of collaborators
process_num_votesNumber of votes
process_created_epochThe epoch when the process was created
process_updated_epochThe epoch when the process was updated
check_collaborators(internal field)
number_of_robotsNumber of robots
relevance(internal field)
category_idIdea Area ID
category_other_textIdea Area ID
category_nameIdea Area name
category_level_idIdea Area creation time
category_is_otherIdea Area created epoch
subcategoriesIdea Area updated time
software_vendorRPA Software Vendor
running_costEst. Running Costs
process_phaseIdea phase
phase_idIdea phase ID
phase_keyIdea phase key
phase_nameIdea phase name
phase_is_activePhase is active
phase_orderPhase order
process_phase_statusIdea status
phase_status_idIdea status ID
phase_idIdea phase ID
phase_status_keyIdea status key
phase_status_nameIdea status name
phase_status_is_activeIdea status is active
phase_status_orderIdea status order
currencyCurrency
currency_idCurrency ID
currency_nameCurrency name
currency_abbreviationCurrency abbreviation
currency_symbolCurrency symbol
currency_is_activeCurrency is active
currency_sort_orderCurrency sort order
process_submitterIdea Submitter
user_idIdea Submitter user ID
user_emailIdea submitter e-mail
user_first_nameIdea submitter first name
user_last_nameIdea submitter last name
readable_submission_timeIdea submission time
ownerIdea Process Owner
user_idIdea Process Owner user ID
user_emailIdea Process Owner e-mail
user_first_nameIdea Process Owner first name
user_last_nameIdea Process Owner last name
pdd_linkPDD Link
idea_phase_approverThe person that updated the idea phase
launch_assessment_approverThe person that launched the idea assessment
qualification_phase_approver

Automation Ideas

GET Automation Ideas

NameDescription
process_idID of the process
process_slugSlug of the Idea
process_submitter_user_idThe DB ID of the submitter of the idea
process_nameIdea Name
process_descriptionDescription of the idea
process_rules_idAnswer to question: How rule based is your task
process_input_type_idAnswer to question: How would you describe the input data for your task/process?
process_stability_idAnswer to question: Are you aware of any expected changes to the way you currently perform the activity or process in the following 6 months?
process_input_structure_idAnswer to question: How would you describe the structure of your input data?
process_documentation_availability_idsAnswer to question: Do you have any documentation regarding this process/activity?
ownerThe DB ID of the Process Owner
process_created_epochThe epoch when the process was created
process_created_atTimestamp when the process was created
process_updated_epochThe epoch when the process was updated
process_updated_atTimestamp when the process was updated
process_updated_user_idThe DB ID of the user who last updated the process
process_phase_idPhase ID
process_phase_status_idPhase status ID
process_challenges_encounteredEncountered Challenges
process_challenges_expectedExpected Challenges
process_task_stability_idProcess Changes Expected in the Next 6 Months
process_application_stability_idApplications Changes Expected in the Next 6 Months
process_frequency_idTask/Process Frequency
process_volumeActivity Volume Average
process_average_handling_timeAverage Processing Time/Transaction
process_peak_idProcess Peaks
process_length_idAverage Number of Steps
process_decision_complexity_idProcess Variability
process_digital_input_percent% of Digital Data Input
process_scanned_input_use_idScanned Data Input
process_structured_input_id% of Structured Digital Data Input*
process_lessons_learnedLessons Learned
process_benefits_expectedExpected Benefits
process_benefits_actualActual Benefits
process_suitability_scoreIdea Suitability
process_readiness_scoreIdea Readiness
process_overall_gauge_scoreOverall idea score
process_uuidProcess Unique ID
process_num_followersNumber of Followers of the process
process_num_votesNumber of Upvotes
process_num_mediaNumber of Media Uploaded
process_num_documentsNumber of Documents uploaded
process_num_collaboratorsNumber of Collaborators
process_num_componentsNumber of Components attached
process_has_ownerIndicates if the Process Owner has been attached or not to the idea
process_num_commentsNumber of Comments
process_num_applicationsNumber of Applications used
process_automation_scoreIdea Potential
process_ease_of_implementation_scoreEase of Implementation
process_estimated_benefit_scoreBenefit (hours saved/year)
process_benefit_expressed_in_currency_per_yearBenefit (currency/year)
process_east_of_baseline_score
process_num_similar_automationsNumber of similar ideas
process_is_potential_duplicatePotential duplicates for the idea
process_submitted_atTimestamp when the process was submitted
process_submitted_epochEpoch when the process was submitted
process_history_version
project_manager_user_idThe ID of the Project Manager attached to the idea
process_goalIdea goal ID
process_archived_reasonReason for archiving the idea
process_rejected_reasonReason for rejection of the idea
process_pain_pointsPain points
process_negative_impactNegative impact
process_submission_typeSubmission type (Coe/Employee driven Idea)
process_volumes_per_yearProcess Volumetry - Volumes / year
process_AHT_employee_per_transactionAHT employee per transaction (minutes)
process_ease_of_implementation_levelOne of the 3 Ease of Implementation levels - Easy / Medium / Difficult
process_cost_per_yearRunning Cost/Year before idea for Human
process_automation_idIdea ID
process_business_unitIdea Business Unit
process_departmentIdea Department
orchestrator_automation_uuidIdea ID
process_headcountNumber of Employees Performing the Task
user_is_followingThere is a user that follows the idea
user_has_votedThere is a user that voted for the idea
process_phasePhase of the status
phase_idPhase ID
phase_keyPhase key
phase_namePhase name
phase_is_activePhase is active
phase_orderPhase order
process_phase_statusProcess status
phase_status_idStatus ID
phase_idPhase ID
phase_status_keyStatus key
phase_status_nameStatus name
phase_status_is_activeStatus is active
phase_status_orderStatus order
category_idID of the category
category_other_textText of the category if it was renamed
category_nameName of the category from the interface
category_level_idID of the level for the category - values from 1 to 5
category_is_otherIndicates if the category is other
subcategoriesArray for subcategories
process_rules_commentComment on Rules Question
process_input_type_commentComment on Input_Type Question
process_input_quality_commentComment on Input_Quality Question
process_stability_commentComment on Stability Question
process_document_availability_commentComment on Document_Availability Question
process_submitterIdea submitter
user_idIdea submitter ID
user_emailIdea submitter email
user_first_nameSubmitter first name
user_last_nameSubmitter last name
readable_submission_timeIdea submission time
process_ownerIdea Process Owner
user_idIdea Process Owner ID
user_emailIdea Process Owner email
user_first_nameSubmitter first name
user_last_nameSubmitter last name
advanced_informationAdvanced information
currencyCurrency
currency_idCurrency ID
currency_nameCurrency name
currency_abbreviationCurrency abbreviation
currency_symbolCurrency symbol
currency_is_activeIndicates if the currency is active
currency_sort_orderIndicates the sort order of the currency in the currency table

POST Automation Ideas

NameDescription
process_phase_status_idPhase status ID
process_nameIdea name
process_descriptionDescription of the idea
process_has_ownerProcess Owner defined
ownerProcess Owner user ID
process_rules_idAnswer to question: How rule based is your task
process_input_type_idAnswer to question: How would you describe the input data for your task/process?
process_input_structure_idAnswer to question: Are you aware of any expected changes to the way you currently perform the activity or process in the following 6 months?
process_stability_idAnswer to question: How would you describe the structure of your input data?
process_documentation_availability_idsAnswer to question: Do you have any documentation regarding this process/activity?
process_suitability_scoreIdea Suitability
process_readiness_scoreIdea Readiness
process_overall_gauge_scoreOverall idea score
process_slugThe slug of the idea
process_submitted_atTimestamp when the idea was submitted
process_submitted_epochEpoch when the idea was submitted
process_updated_user_idUser ID of the last user who updated the idea
process_updated_epochIdea last updated epoch
process_updated_atIdea last updated timestamp
process_idThe ID of the process
process_submitter_user_idThe DB ID of the submitter of the idea
process_created_epochThe epoch when the process was created
process_created_atTimestamp when the process was created
process_phase_idPhase ID
process_challenges_encounteredEncountered Challenges
process_challenges_expectedExpected Challenges
process_task_stability_idProcess Changes Expected in the Next 6 Months
process_application_stability_idApplications Changes Expected in the Next 6 Months
process_frequency_idTask/Process Frequency
process_volumeActivity Volume Average
process_average_handling_timeAverage Processing Time/Transaction
process_peak_idProcess Peaks
process_length_idAverage Number of Steps
process_decision_complexity_idProcess Variability
process_digital_input_percent% of Digital Data Input
process_scanned_input_use_idScanned Data Input
process_structured_input_id% of Structured Digital Data Input*
process_lessons_learnedLessons Learned
process_benefits_expectedExpected Benefits
process_benefits_actualActual Benefits
process_uuidProcess Unique ID
process_num_followersNumber of Followers of the process
process_num_votesNumber of Upvotes
process_num_mediaNumber of Media uploaded
process_num_documentsNumber of Documents uploaded
process_num_collaboratorsNumber of Collaborators
process_num_componentsNumber of Components attached
process_num_commentsNumber of Comments
process_num_applicationsNumber of Applications used
process_automation_scoreIdea Potential
process_ease_of_implementation_scoreEase of Implementation
process_estimated_benefit_scoreBenefit (hours saved/year)
process_benefit_expressed_in_currency_per_yearBenefit (currency/year)
process_num_similar_automationsNumber of similar ideas
process_is_potential_duplicatePotential duplicates for the idea
project_manager_user_idThe ID of the Project Manager attached to the idea
process_goalIdea goal ID
process_rejected_reasonReason for rejection of the idea
process_pain_pointsPain points
process_negative_impactNegative impact
process_submission_typeSubmission type (Coe/Employee driven Idea)
process_volumes_per_yearProcess Volumetry - Volumes / year
process_AHT_employee_per_transactionAHT employee per transaction (minutes)
process_ease_of_implementation_levelOne of the 3 Ease of Implementation levels - Easy / Medium / Difficult
process_cost_per_yearRunning Cost/Year before idea for Human
process_automation_idAutomaiton ID
process_business_unitIdea Business Unit
process_departmentIdea Department
process_headcountNumber of Employees Performing the Task
user_is_followingThere is a user that follows the idea
user_has_votedThere is a user that voted the idea
process_phasePhase of the status
phase_idPhase ID
phase_keyPhase key
phase_namePhase name
process_phase_statusProcess status
phase_status_idStatus ID
phase_idPhase ID
phase_status_keyStatus key
phase_status_nameStatus name
category_idID of the category
category_other_textText of the category if it was renamed
category_nameName of the category from the interface
category_level_idID of the level for the category - values from 1 to 5
category_is_otherIndicates if the category is other
subcategoriesArray for subcategories
process_rules_commentComment on Rules Question
process_input_type_commentComment on Input Type Question
process_input_quality_commentComment on Input Quality Question
process_stability_commentComment on Stability Question
process_document_availability_commentComment on Document Availability Question
process_submitterIdea submitter
user_idIdea submitter ID
user_emailIdea submitter email
user_first_nameSubmitter first name
user_last_nameSubmitter last name
readable_submission_timeIdea submission time
process_ownerIdea Process Owner
user_idIdea Process Owner ID
user_emailIdea Process Owner email
user_first_nameSubmitter first name
user_last_nameSubmitter last name
advanced_informationAdvanced information
currencyCurrency
currency_idCurrency ID
currency_nameCurrency name
currency_abbreviationCurrency abbreviation
currency_symbolCurrency symbol
orchestrator_automation_uuidIdea ID

GET App Inventory

NameDescription
application_idIndicates the ID of the application
application_nameName of the application
application_taxonomy_L1_idID of the Application Category (L1) correspondent to the application
application_versionThe version of the application
application_languageLanguage of the application
application_codeCode of the application
application_is_activeIndicates if the application is active
application_added_by_end_userIndicates if the application was added by an end-user
application_added_user_idIndicates the user ID which added the app
application_created_epochEpoch when the application was created
categoryIdsIndicates the IDs of the categories where the app is linked

GET Hierarchy

NameDescription
category_idID of the category
category_other_textText of the category if it was renamed
category_nameName of the category - that appears in the interface
category_level_idID of the level for the category - values from 1 to 5
category_is_otherIndicates if the category is other
subcategoriesArray for subcategories

GET Users

NameDescription
user_idIndicates the ID of the user
user_emailThe e-mail of the user
user_first_nameFirst name of the user
user_last_nameLast name of the user
user_is_adminIndicates if the user is the "First user" of the tenant, the user that created the tenant
user_job_titleUser's Job Title
user_locationUser's Location
user_business_unitUser's Business Unit
user_departmentUser's Department
user_created_atTimestamp when the user has been created
user_updated_atTimestamp when the user has been updated
user_last_login_timeUser last login time
user_num_automationsUser's number of ideas
user_num_documentsUser's number of documents created in the tenant
user_num_componentsUser's number of components
user_invite_statusDefines if the user has received an e-mail invitation or not
user_is_activeDefines if the user is active or not

GET Roles

NameDescription
role_descriptionThe description of the role
role_idThe ID of the role
role_nameThe name of the role
role_slugThe slug of the role
role_typeThe type of role
  • Automation Ideas

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated