How To Edit An Existing Idea Through Open API?

News Knowledge Base
1

How to edit an existing idea in Automation Hub Cloud through Open API ?

Issue Description

Is there any way to update the details (for example, the Description field) of an automation already created in Automation Hub Cloud?

Resolution

Automation Hub users can edit ideas via the Open API, by first getting the idea schema and then using it in the edit endpoint.

  1. Get the idea schema:

GET https://YOUR_URL/ORGANIZATIONNAME/TENANT_NAME/automationhub_/api/v1/openapi/automations/id/schema

  1. Edit the idea (based on the previous schema):

PATCH https://YOUR_URL/ORGANIZATIONNAME/TENANT_NAME/automationhub_/api/v1/openapi/automations/id

Find below an example for editing the Description field for Automation ID 53 through Open API using Postman

  1. Getting the idea schema:

Authorization:

Type: Bearer Token

Value: Tenant ID/Token

Headers:

Accept: application/json

x-ah-openapi-app-key: your App Key

x-ah-openapi-auth: openapi-token

  1. Edit the idea based on the previous schema (using the same authorization and headers from the previous API call):

  1. When reviewing the previous idea in the Automation Hub interface, the description field should be updated as below:

3.jpg

3

Hi, when editing the idea for the PATCH call, I find it difficult to edit the schema file to match with the input that the patch requires. If I want to edit one field, e.g. the automation ID, what is your advice?