Automation Hub
2023.4
false
Automation Hub API Guide
Last updated Apr 19, 2024

Retrieve the Cost Benefit Analysis for a Specific Idea

One of the most important aspects of the Automation Pipeline is seeing the Return on Investment, which you can easily find and manage in the Cost Benefit Analysis page from Automation Hub still the ROI data needs to be aggregated and exported into external systems in order to be further calculated and processed. To easily retrieve this information you can use the /cba API call.

The following request exemplifies how to retrieve the Cost Benefit Analysis details for one of your ideas.

Note:
  • Adding the id of the Automation Idea is mandatory for this call. To retrieve it first make a GET Automation Idea call.

  • Please also check the GET Automation Idea call example.

For this example, we'll retrieve the Cost Benefit Analysis entered for an idea that has the identification number 29 (id=29).

GET: https://{yourDomain}/automationhub_/api/v1/openapi/cba?id=29'

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": { 
        "baseline_is_set": 1, 
        "sections": [ 
            { 
                "title": "Project Plan", 
                "sections": [ 
                    { 
                        "title": "Ease of Implementation", 
                        "input_fields": [ 
                            { 
                                "field_name": "Estimated by Algorithm", 
                                "value": "Easy" 
                            }, 
                            { 
                                "field_name": "Final", 
                                "input_options": [ 
                                    "Easy", 
                                    "Medium", 
                                    "Difficult" 
                                ], 
                                "input_selected": "Easy" 
                            }, 
                            { 
                                "field_name": "Comment", 
                                "value": null 
                            } 
                        ] 
                    }, 
                    { 
                        "title": "Baseline", 
                        "input_fields": [ 
                            { 
                                "field_name": "Analysis", 
                                "start_date": { 
                                    "value": "07/16/2020" 
                                }, 
                                "end_date": { 
                                    "value": "07/31/2020" 
                                }, 
                                "baseline_cycle_time": { 
                                    "value": 12 
                                } 
                            }, 
                            { 
                                "field_name": "Solution Design", 
                                "start_date": { 
                                    "value": "07/31/2020" 
                                }, 
                                "end_date": { 
                                    "value": "08/13/2020" 
                                }, 
                                "baseline_cycle_time": { 
                                    "value": 10 
                                     ]
            }
        ]      { 
    "message": "Success", 
    "statusCode": 200, 
    "data": { 
        "baseline_is_set": 1, 
        "sections": [ 
            { 
                "title": "Project Plan", 
                "sections": [ 
                    { 
                        "title": "Ease of Implementation", 
                        "input_fields": [ 
                            { 
                                "field_name": "Estimated by Algorithm", 
                                "value": "Easy" 
                            }, 
                            { 
                                "field_name": "Final", 
                                "input_options": [ 
                                    "Easy", 
                                    "Medium", 
                                    "Difficult" 
                                ], 
                                "input_selected": "Easy" 
                            }, 
                            { 
                                "field_name": "Comment", 
                                "value": null 
                            } 
                        ] 
                    }, 
                    { 
                        "title": "Baseline", 
                        "input_fields": [ 
                            { 
                                "field_name": "Analysis", 
                                "start_date": { 
                                    "value": "07/16/2020" 
                                }, 
                                "end_date": { 
                                    "value": "07/31/2020" 
                                }, 
                                "baseline_cycle_time": { 
                                    "value": 12 
                                } 
                            }, 
                            { 
                                "field_name": "Solution Design", 
                                "start_date": { 
                                    "value": "07/31/2020" 
                                }, 
                                "end_date": { 
                                    "value": "08/13/2020" 
                                }, 
                                "baseline_cycle_time": { 
                                    "value": 10 
                                     ]
            }
        ]

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.