UiPath Documentation
automation-hub
latest
false

Automation Hub api guide

Last updated May 6, 2026

Input for Detailed Assessment

Used for Submitting CoE-driven Ideas

KeyKey TypeValueUse CaseMandatory?
Automation Idea Name = process_nameText inputEnter the name of the idea using the template.POST request parametersYes
Automation Idea ID = orchestrator_automation_uuidText inputEnter the ID number you want to assign to your idea using the template.POST request parametersNo
Description = process_descriptionText inputEnter the idea description using the template.POST request parametersYes
Automation Idea Area = category_idID input from CategoriesYou can easily extract Category ID by using the GET category call.POST request parametersYes
Pain Points = process_pain_pointsText inputEnter the pain points using the template.POST request parametersYes
Negative Impact = process_negative_impactText inputEnter the negative impact using the template.POST request parametersYes
Automation Idea Goal / Primary Reason to Automate the Process = automation_goalResponse choiceCost = automation-goal-cost Quality = automation-goal-quality Productivity = automation-goal-productivityPOST request parametersYes
Process Changes Expected in the Next 6 Months = task_stabilityResponse choiceNo change expected = task-stability-no-change-expected Minor change expected = task-stability-minor-change-expected Some change expected = task-stability-some-change-expected Several changes expected = task-stability-several-changes-expected Major change expected = task-stability-major-change-expectedPOST request parametersYes
Applications Changes Expected in the Next 6 Months = application_stabilityResponse choiceNo change expected = application-stability-no-change-expected Minor change expected = application-stability-minor-change-expected Some change expected = application-stability-some-change-expected Several changes expected = application-stability-several-changes-expected Major change expected = application-stability-major-change-expectedPOST request parametersYes
Average Working Days/Year = employee_average_working_daysType: positive integer (rounded)Enter the number corresponding to the average working days/year.POST request parametersYes
Working Hours/Day = employee_working_hoursType: positive integer (rounded)Enter the number corresponding to the working hours/day.POST request parametersYes
Average Employee Full Cost/Year = employee_average_full_costType: positive integer (rounded)Enter the number corresponding to the average employee full cost/year.POST request parametersNo
Task/Process Frequency = frequencyResponse choiceDaily = frequency-daily Weekly = frequency-weekly Bi-weekly = frequency-bi-weekly Monthly = frequency-monthly Quarterly = frequency-quarterly Yearly = frequency-yearlyPOST request parametersYes
Activity Volume Average = volumesType: positive integer (rounded)Enter the number corresponding to the activity volume average.POST request parametersYes
Average Processing Time/Transaction = average_handling_timeType: positive integer (rounded)Enter the number corresponding to the average processing time/transaction.POST request parametersYes
Average Error Rate (% of Total Volume) = average_error_rateType: positive integer (rounded)Enter the number corresponding to the average error rate.POST request parametersNo
Average Rework Time/Transaction (min) = average_rework_timeType: positive integer (rounded)Enter the number corresponding to the rework time.POST request parametersNo
Average Work to be Reviewed/Audited (% of Total Volume) = average_work_to_be_reviewedType: positive integer (rounded)Enter the number corresponding to the average rework time/transaction.POST request parametersNo
Average Review or Audit Time/Transaction (min) = average_review_audit_timeType: positive integer (rounded)Enter the number corresponding to the average review or audit time/transaction.POST request parametersNo
Number of Employees Performing the Task = number_of_employeesType: positive integer (rounded)Enter the value corresponding to the number of employees performing the task.POST request parametersYes
Process Peaks = process_peaksResponse choiceRegular (e.g. month closing) = process-peaks-regular Rare but predictable event (e.g. winter holidays/ yearly closing) = process-peaks-rare-predictable Rare and unpredictable event = process-peaks-rare-unpredictable There are no peaks = process-peaks-no-peaksPOST request parametersYes
Average Number of Steps = process_lengthResponse choiceLess than 20 steps = process-length-less-twenty Between 20-50 Steps = process-length-between-twenty-fifty Between 50-100 Steps = process-length-between-fifty-hundred Between 100-150 Steps = process-length-between-hundred-hundredfifty More than 150 Steps = process-length-more-than-hundredfiftyPOST request parametersYes
Number of Ways to Complete the Process = decision_complexityResponse choiceProcess is completed the same way every time = decision-complexity-same-way There are >=2 but <5 ways to complete the process = decision-complexity-between-two-five There are >=5 but <8 ways to complete the process = decision-complexity-between-five-eight There are >=8 ways to complete the process = decision-complexity-greater-eightPOST request parametersYes
% of Digital Data Input = digital_inputs_percentType: positive integer (rounded)Enter the number corresponding to the % of digital data input.POST request parametersYes
Scanned Data Input = scanned_inputsBoolean valueYes = scanned-inputs-yes No = scanned-inputs-noPOST request parametersYes
% of Structured Digital Data Input = structured_inputResponse choice>= 80% = structured-input-greater-eighty 60%-80% = structured-input-between-sixty-eighty 40%-60% = structured-input-between-forty-sixty <40% = structured-input-lesser-fortyPOST request parametersYes
Applications Used = applicationsID input from ApplicationsYou can easily extract the Application ID by using the GET appinventory call.POST request parametersYes
Process Owner = ownerProcess Owner email addressPOST request parametersYes

Example:

    "process_name": "Coe Submission",
    "orchestrator_automation_uuid": "100024",
    "process_description": "automate the submission process",
    "category_id": 85,
    "process_pain_points": "painpoints_nostyle",
    "process_negative_impact": "not applicable",
    "automation_goal": "automation-goal-productivity",
    "task_stability": "task-stability-some-change-expected",
    "application_stability": "application-stability-several-changes-expected",
    "employee_average_working_days": "25",
    "employee_working_hours": "15",
    "employee_average_full_cost": "8934",
    "frequency": "frequency-weekly",
    "volumes": "7",
    "average_handling_time": "928",
    "average_error_rate": "3",
    "average_rework_time": "4",
    "average_work_to_be_reviewed": "12",
    "average_review_audit_time": "76",
    "number_of_employees": "8",
    "process_peaks": "process-peaks-rare-predictable",
    "process_length": "process-length-between-twenty-fifty",
    "decision_complexity": "decision-complexity-between-five-eight",
    "digital_inputs_percent": "7",
    "scanned_inputs": "scanned-inputs-yes",
    "structured_input": "structured-input-between-forty-sixty",
    "applications": [68,45],
    "owner": "jane.doe@email.com"
}
    "process_name": "Coe Submission",
    "orchestrator_automation_uuid": "100024",
    "process_description": "automate the submission process",
    "category_id": 85,
    "process_pain_points": "painpoints_nostyle",
    "process_negative_impact": "not applicable",
    "automation_goal": "automation-goal-productivity",
    "task_stability": "task-stability-some-change-expected",
    "application_stability": "application-stability-several-changes-expected",
    "employee_average_working_days": "25",
    "employee_working_hours": "15",
    "employee_average_full_cost": "8934",
    "frequency": "frequency-weekly",
    "volumes": "7",
    "average_handling_time": "928",
    "average_error_rate": "3",
    "average_rework_time": "4",
    "average_work_to_be_reviewed": "12",
    "average_review_audit_time": "76",
    "number_of_employees": "8",
    "process_peaks": "process-peaks-rare-predictable",
    "process_length": "process-length-between-twenty-fifty",
    "decision_complexity": "decision-complexity-between-five-eight",
    "digital_inputs_percent": "7",
    "scanned_inputs": "scanned-inputs-yes",
    "structured_input": "structured-input-between-forty-sixty",
    "applications": [68,45],
    "owner": "jane.doe@email.com"
}

UI Correspondent: Submitting a CoE-driven Idea

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated