automation-start-endpoint
  • 18 Oct 2024
  • Dark
    Light
  • PDF

automation-start-endpoint

  • Dark
    Light
  • PDF

Article summary

Purpose

This automation starts an automation given the name of a trigger endpoint, as well as optional form data if desired.

automation-start-endpoint

API used:

/operations-manager/triggers/endpoint/:trigger_name

Input

Inputs Data Type Sample Input Description
instance_name Dropdown (String) SE Lab Prod 2023.1 The IAP instance name
trigger_name String test_form_trigger Name of the trigger
data (optional) JSON { "formData":{ "OS-Type": "cisco-ios", "severity":"HIGH" } } Form data as per the schema being used by the trigger. Note: Refer to the sample input to structure the JSON object in the same format
token (optional) string 9f0999c2-7054-4820-8eeb-c3052d30acaa Authentication token or empty if an API key is used

Output

Output Data Type Sample Output Description
automation_response JSON Sample outputs shown below. Returns a JSON object with the start status of the automation
job_id String 4278c701b83943b08a98*** The Job ID of the automation that was started

Sample 1 - Output

{
    “taskId”: “workflow_start”,
                “owner”: “Pronghorn”,
                “iterations”: [],
                “transitions”: {
                    “success”: [
                        {
                            “task”: “6e4c”,
                            “type”: “standard”
                        },
                        {
                            “task”: “30e5”,
                            “type”: “standard”
                        }
                    ]
                }
            },
            “workflow_end”: {
                “name”: “workflow_end”,
                “groups”: [],
                “x”: 1,
                “y”: 0.5,
                “status”: “incomplete”,
                “previous”: {
                    “incomplete”: [
                        “ec30"
                    ],
                    “complete”: [],
                    “error”: []
                }

Sample 2 - Output

{
    “taskId”: “workflow_end”,
                “owner”: “Pronghorn”,
                “iterations”: [],
                “transitions”: {},
                “endTasks”: {
                    “incomplete”: [
                        “30e5”
                    ],
                    “complete”: [],
                    “error”: []
                }
            },
            “ec30": {
                “name”: “stub”,
                “canvasName”: “stub”,
                “summary”: “Stub”,
                “description”: “Create a stub for an automated task”,
                “location”: “Application”,
                “locationType”: null,
                “app”: “WorkFlowEngine”,
                “type”: “automatic”,
                “displayName”: “Tools”,
                “variables”: {
                    “incoming”: {
                        “type”: “success”,
                        “delay”: “$var.6e4c.result”,
                        “response”: “ok”
                    },
                    “outgoing”: {
                        “response”: null
                    },
                    “error”: “”,
                    “decorators”: []
                },
                “deprecated”: false,
                “groups”: [],
                “actor”: “Pronghorn”,
                “x”: 0.4454901960784314,
                “y”: 0.4226254002134472,
                “scheduled”: false,
                “status”: “incomplete”,
                “previous”: {
                    “incomplete”: [
                        “6e4c”
                    ],
                    “complete”: [],
                    “error”: []
                }

Sample 3 - Output

{
    “taskId”: “ec30",
                “owner”: “Pronghorn”,
                “iterations”: [],
                “transitions”: {
                    “success”: [
                        {
                            “task”: “workflow_end”,
                            “type”: “standard”
                        }
                    ]
                }
            },
            “6e4c”: {
                “name”: “parseInt”,
                “canvasName”: “parseInt”,
                “summary”: “Converts a string to an integer.“,
                “description”: “Parses a string argument and returns an integer of the specified radix or base.“,
                “location”: “Application”,
                “locationType”: null,
                “app”: “WorkFlowEngine”,
                “type”: “automatic”,
                “displayName”: “Number”,
                “variables”: {
                    “incoming”: {
                        “str”: “$var.job.time”,
                        “radix”: “”
                    },
                    “outgoing”: {
                        “result”: null
                    },
                    “error”: “”,
                    “decorators”: []
                },
                “deprecated”: false,
                “groups”: [],
                “actor”: “Pronghorn”,
                “x”: 0.16705882352941176,
                “y”: 0.3575240128068303,
                “scheduled”: false,
                “retrySettings”: null,
                “status”: “running”,
                “previous”: {
                    “incomplete”: [],
                    “complete”: [],
                    “error”: []
                }

Sample 4 - Output

{
   “taskId”: “6e4c”,
                “owner”: “Pronghorn”,
                “iterations”: [],
                “transitions”: {
                    “success”: [
                        {
                            “task”: “ec30”,
                            “type”: “standard”
                        }
                    ]
                }
            },
            “30e5": {
                “name”: “parseInt”,
                “canvasName”: “parseInt”,
                “summary”: “Converts a string to an integer.“,
                “description”: “Parses a string argument and returns an integer of the specified radix or base.“,
                “location”: “Application”,
                “locationType”: null,
                “app”: “WorkFlowEngine”,
                “type”: “automatic”,
                “displayName”: “Number”,
                “variables”: {
                    “incoming”: {
                        “str”: “$var.job.endtime”,
                        “radix”: “”
                    },
                    “outgoing”: {
                        “result”: null
                    },
                    “error”: “”,
                    “decorators”: []
                },
                “deprecated”: false,
                “groups”: [],
                “actor”: “Pronghorn”,
                “x”: 0.18745098039215685,
                “y”: 0.5827107790821772,
                “scheduled”: false,
                “retrySettings”: null,
                “status”: “running”,
                “previous”: {
                    “incomplete”: [],
                    “complete”: [],
                    “error”: []
                }

Sample 5 - Output

{
    “taskId”: “30e5",
                “owner”: “Pronghorn”,
                “iterations”: [],
                “transitions”: {}
            }
        },
        “transitions”: {
            “workflow_start”: {
                “6e4c”: {
                    “type”: “standard”,
                    “state”: “success”
                },
                “30e5": {
                    “type”: “standard”,
                    “state”: “success”
                }
            },
            “workflow_end”: {},
            “ec30": {
                “workflow_end”: {
                    “type”: “standard”,
                    “state”: “success”
                }
            },
            “6e4c”: {
                “ec30”: {
                    “type”: “standard”,
                    “state”: “success”
                }
            },
            “30e5": {}
        },
        “font_size”: 12,
        “last_updated”: “2023-07-20T15:46:38.473Z”,
        “last_updated_by”: “6475f9fe2d6fb91936274693”,
        “lastUpdatedVersion”: “5.44.64-2022.1.33.0”,
        “groups”: [
            “default”
        ],
        “created”: “2023-07-20T15:46:38.664Z”,
        “created_by”: “6475f9fe2d6fb91936274693”,
        “createdVersion”: “5.44.64-2022.1.33.0”,
        “tags”: [],
        “description”: “(Started from Operations Manager) API trigger”,
        “status”: “running”,
        “variables”: {
            “time”: “10”,
            “endtime”: “20”,
            “_id”: “8d887c9ad8a54569b3a44849”,
            “initiator”: “snow-token”
        },
        “watchers”: [
            “63fc02eed99e7739b84b660e”
        ],
        “ancestors”: [
            “8d887c9ad8a54569b3a44849”
        ],
        “decorators”: [],
        “metrics”: {
            “start_time”: 1690904550118,
            “user”: “63fc02eed99e7739b84b660e”,
            “progress”: 0
        }
    },
    “metadata”: {}
}

Error Output

Error Output Data Type Sample Output Description
error_message String Method failed: (/operations-manager/automations) with code: 401 - Invalid username/password combination Error message

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.