automation-hub
2022.4
false
- Open API
- Introduction to Automation Hub API
- API References
- Generate your Token from Automation Hub
- Authenticating to Your Automation Hub Tenant
- Add users in bulk to Automation Hub using OpenAPI
- Bulk edit users in Automation Hub using OpenAPI
- Retrieve Automation Idea in Idea Phase Awaiting Review Status
- Retrieve the Cost Benefit Analysis for a Specific Idea
- Update Automation Idea Phase and Status
- Retrieve a User Account
- Update Account Details for Employees from Automation Hub
- Inactivate User Accounts that are Not Part of the Company
- Input for Automation Pipeline
- Input for Submission Type
- Input for Phase
- Input for Status
- Input for Phase and Status Update
- Input for Business Unit
- Input for Applications
- Input for Category
- Input for Cost Benefit Analysis
- Input for High Level Assessment
- Input for Detailed Assessment
- Input for Automation Idea Creation Date
- Input for Users
- Input for User Status
- User Status Table
- Input for Collaborators
- Output Dictionary
- Automation Hub Open API Power Query Data Parsing
Automation Hub API Guide
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=717Request:
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-tokenResponse:
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
