automation-hub
2022.4
false
UiPath logo, featuring letters U and I in white

Automation Hub API Guide

Automation CloudAutomation Cloud Public SectorAutomation Suite
Last updated Apr 19, 2024

Retrieve Automation Idea in Idea Phase Awaiting Review Status

The following request exemplifies how to retrieve the details for all the automation ideas registered in your tenant that match the following criteria:

  • Idea is in Idea phase: phases=1

  • Its status is Awaiting Review: status=46

  • Category ID is: category=717

Note:

Please use the lowes Category ID in order for the whole chain to be inputted.

GET: https://{yourDomain}/automationhub_/api/v1/openapi/automations?category=717

Request:

Headers 
Content-Type: application/json 
Authorization: Bearer [Tenant ID/Token] 
x-ah-openapi-app-key: [API key if added] 
x-ah-openapi-auth: openapi-tokenHeaders 
Content-Type: application/json 
Authorization: Bearer [Tenant ID/Token] 
x-ah-openapi-app-key: [API key if added] 
x-ah-openapi-auth: openapi-token

Response:

Content-Type: application/json

{
     "message": "Success",
    "statusCode": 200,
    "data": {
        "page": 1,
        "pageSize": 4,
        "totalItems": 4,
        "totalPages": 1,
        "processes": [
            {
                "process_id": 1,
                "process_slug": "onboarding-of-new-employee",
                "process_submitter_user_id": 2,
                "process_name": "Onboarding of new employee",
                "process_description": "{\"blocks\":
                "process_rules_id": 2,
                "process_input_type_id": 6,
                "process_stability_id": 17,
                "process_input_structure_id": 11,
                "process_documentation_availability_ids": "21",
                "owner": 2,
                "process_created_epoch": 1600350166000,
                "process_created_at": "2020-09-17T13:42:46.000Z",
                "process_updated_epoch": 1600350166000,
                "process_updated_at": "2020-09-17T13:42:46.000Z",
                "process_updated_user_id": 1,
                "process_phase_id": 9,
                "process_phase_status_id": 89,
                "process_challenges_encountered": 
...see more fields examples in swagger or postman documentation  {
     "message": "Success",
    "statusCode": 200,
    "data": {
        "page": 1,
        "pageSize": 4,
        "totalItems": 4,
        "totalPages": 1,
        "processes": [
            {
                "process_id": 1,
                "process_slug": "onboarding-of-new-employee",
                "process_submitter_user_id": 2,
                "process_name": "Onboarding of new employee",
                "process_description": "{\"blocks\":
                "process_rules_id": 2,
                "process_input_type_id": 6,
                "process_stability_id": 17,
                "process_input_structure_id": 11,
                "process_documentation_availability_ids": "21",
                "owner": 2,
                "process_created_epoch": 1600350166000,
                "process_created_at": "2020-09-17T13:42:46.000Z",
                "process_updated_epoch": 1600350166000,
                "process_updated_at": "2020-09-17T13:42:46.000Z",
                "process_updated_user_id": 1,
                "process_phase_id": 9,
                "process_phase_status_id": 89,
                "process_challenges_encountered": 
...see more fields examples in swagger or postman documentation

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.