Summary
Run Endpoint Trigger With POST
Description
Runs the Automation associated with the API Trigger.
Route
POST /operations-manager/triggers/endpoint/:routeName
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
routeName | string | yes | The routeName of the API Trigger. |
body | object | yes | Any key-value pairs in the POST body will be used to create job variables. |
{}
{ "title": "body", "type": "object", "properties": {}, "additionalProperties": true }
Return
Name | Type | Description |
---|---|---|
result | object | The spawned Job. |
{ "message": "Successfully created the requested item", "data": { "_id": "5a30dadd251f84e4923e7c5f", "font_size": 24782015, "type": "resource:action", "created": "1945-10-27T18:14:48.634Z", "last_updated": "1980-10-06T04:43:15.573Z", "createdVersion": "689000937.705922.6566821-3005.2.40.6852358483", "lastUpdatedVersion": "936.87.251078916-8998.676.897.631366411", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": -68308487, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 5190358.727196515, "sla": 1852629.4615321904, "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~1/~0/~1/~1/cZ.qOUbUM/zvKRyy3a" }, { "type": "encryption", "pointer": "/~0/B9LE74/ozw3C+9PJN/JLDxGZef/~0" } ], "status": "incomplete", "tags": [], "error": [ { "task": "job", "message": "Job has no available transitions. c841 could have led to the workflow end task, but did not. These tasks performed in a way that the end of the workflow could not be reached.", "timestamp": 1627323002574 }, { "task": "f9a9", "message": { "code": 500, "message": { "apiVersion": "1", "method": "transformations.run", "error": { "code": 500, "message": "Missing one of the following required instances: arg2, arg1", "errors": [] } } }, "timestamp": 1627323002561 }, { "task": "job", "message": "Job has no available transitions. c841 could have led to the workflow end task, but did not. These tasks performed in a way that the end of the workflow could not be reached.", "timestamp": 1627323002574 }, { "task": "f9a9", "message": { "code": 500, "message": { "apiVersion": "1", "method": "transformations.run", "error": { "code": 500, "message": "Missing one of the following required instances: arg2, arg1", "errors": [] } } }, "timestamp": 1627323002561 } ], "warnings": [ { "task": "error_handler", "name": "myCoolDocumentName" }, { "task": "e28f", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "consequat exercitation dolore officia ex" } ], "ancestors": [ "0563fe41b6f3f57a2474868a" ], "validationErrors": [ { "keyword": "adipisicing Lorem aliquip ut", "dataPath": "ut", "schemaPath": "cillum", "message": "in elit nisi mollit" }, { "keyword": "ad Ut labore ex", "dataPath": "Ut sunt ipsum", "schemaPath": "ipsum quis sint esse", "message": "do ut" }, { "keyword": "nulla non", "dataPath": "deserunt sed cupidatat culpa", "schemaPath": "do ipsum velit", "message": "dolore Lorem" }, { "keyword": "est", "dataPath": "nulla irure in amet", "schemaPath": "do", "message": "minim proident labore" }, { "keyword": "cillum consequat", "dataPath": "laboris do", "schemaPath": "in qui mollit", "message": "amet" } ], "created_by": "c7aee33659648e77fa48b030", "last_updated_by": null, "tasks": { "1": { "actor": "9f9e2097bf6278ee3fb97b56", "groups": [ "default", "eb647ad89b2f6cd3e4869cfc" ], "iterations": [], "x": 24875772.820659578, "y": -98867352.31407164, "gridCoordinate": { "x": -70884110.82110238, "y": 3206389.9291847646 }, "name": "pending", "summary": "nostrud occaecat", "description": "do" }, "workflow_start": { "x": -56684977.882183716, "y": 79353391.36819172, "gridCoordinate": { "x": 98002002.75821206, "y": 16722221.03992334 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -86511296.6613562, "finish_state": "error", "user": { "_id": "e189a0e75a4d46ca0a61635f", "provenance": "laboris culpa sint laborum", "username": "pariatur quis fugiat", "firstname": "laborum", "memberOf": [ { "groupId": "381c65c615cd9204ed7661ba", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aute dolore occaecat ea ut" }, { "roleId": "labore pariatur ipsum" }, { "roleId": "ea in dolor veniam" }, { "roleId": "in" } ], "inactive": true, "lastLogin": "2022-11-11T19:02:42.854Z", "_meta": { "created": "2013-03-03T12:37:47.858Z", "updated": "1958-09-18T19:57:50.808Z", "migrationVersion": -68503082 }, "email": "proident quis qui" } }, "groups": [ "default", "70055a6329ca8af4c20fe21b" ], "iterations": [ "625e5eB7-E2Ad-BC6c-d31c-EeeEccd2aA8E" ] }, "workflow_end": { "x": -48353670.24326813, "y": 92266858.9341883, "gridCoordinate": { "x": -60835554.06122097, "y": 10901431.68059577 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "e28f", "workflow_start", "e28f" ], "complete": [ "3a1f", "workflow_start", "e28f", "workflow_start", "e28f" ], "error": [ "workflow_start", "e28f" ] }, "metrics": { "end_time": 27613790.170749962, "run_time": -84344916.30186187 }, "groups": [ "default", { "_id": "03cc981626c5889bb5047ee6", "provenance": "velit minim occaecat officia non", "name": "Ut laborum sit veniam ea", "description": "voluptate", "memberOf": [ { "groupId": "8c7378231eee98dbdc37ee8f", "aaaManaged": true }, { "groupId": "80fd501a56d984f78e3cf7b1", "aaaManaged": true }, { "groupId": "bd4da1810cd24ce0a7cc6e16", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aliquip proident reprehenderit amet eu" }, { "roleId": "dolor elit proident" }, { "roleId": "ad laboris ut occaecat" } ], "inactive": true, "_meta": { "created": "1973-10-14T14:32:14.536Z", "updated": "1982-03-28T20:11:12.992Z", "migrationVersion": 26477581 } }, "1ea670fff2470879b00b7236", "default", "default" ], "iterations": [ "1Eb559d6-AfbC-EEb4-6F17-a0D3FA0A922F" ] }, "error_handler": { "x": -57605687.97607397, "y": -41960096.86430133, "gridCoordinate": { "x": -22063702.744835958, "y": -51418861.4753575 }, "name": "childJob", "location": "Application", "locationType": null, "app": "tempor ea elit", "canvasName": "magna sunt ut cupidatat do", "displayName": "in pariatur aliqua veniam nostrud", "summary": "incididunt", "description": "in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/GfB4Z5Ck,x,/jqyShL4.8/~1/~1/QoXTr8ps/el/FyX,uF-02/W/jmRKH0GOY" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "dolore ea Duis enim dolor", "highlightString": "officia nostrud" }, { "key": "aliqua non aliquip adipisicing nulla", "highlightString": "veniam adipisicing ex dolore" }, { "key": "sunt", "highlightString": "elit incididunt" }, { "key": "nulla qui pariatur", "highlightString": "aliquip eiusmod velit et reprehenderit" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_start", "error_handler", "3a1f" ], "complete": [ "workflow_start", "workflow_end", "workflow_start" ], "error": [ "e28f", "workflow_end" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "standard" }, { "task": "error_handler", "type": "revert" } ] }, "serverId": "minim dolor fugiat nostrud", "start_time": "1947-08-06T13:50:48.713Z", "end_time": 14557988.384748593, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": { "_id": "9d5282e06f4f316400fc9111", "provenance": "do ad", "username": "ut Duis Ut", "firstname": "dolore ipsum ad aliqua", "memberOf": [ { "groupId": "ec3de0f44313b301a2afbf0f", "aaaManaged": true }, { "groupId": "b49e9813b4c8edd4cf1b0724", "aaaManaged": true }, { "groupId": "e8f9d91fb76cc6d44048eceb", "aaaManaged": true }, { "groupId": "db64221bc651831694f963b8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ipsum ut" }, { "roleId": "Lorem sint" }, { "roleId": "sit in aliqua Duis" }, { "roleId": "deserunt voluptate in" } ], "inactive": true, "lastLogin": "2019-09-08T21:44:15.87Z", "_meta": { "created": "1984-04-15T04:03:42.341Z", "updated": "1947-09-12T02:53:08.788Z", "migrationVersion": -29927492 }, "email": "veniam Ut Duis" }, "groups": [ { "_id": "f69430500d10ef4603271915", "provenance": "tempor dolore officia", "name": "voluptate Lorem dolore", "description": "aliquip exercitation fugiat do aliqua", "memberOf": [ { "groupId": "81e13ae46287716d938a940b", "aaaManaged": false }, { "groupId": "ba81a65d5c7dac15fee8e552", "aaaManaged": false }, { "groupId": "75b001604cf4342fe8527a69", "aaaManaged": false }, { "groupId": "d1556541e204c93b7c67b6ef", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "proident officia fugiat Excepteur" } ], "inactive": true, "_meta": { "created": "1955-05-30T23:11:21.254Z", "updated": "1959-04-19T12:47:33.196Z", "migrationVersion": -43466629 } }, "default", { "_id": "d5970e7acd2140d4cbef8da1", "provenance": "in", "name": "id nulla sunt ad", "description": "dolore velit ullamco aliqua", "memberOf": [ { "groupId": "39871963e15f22a036f2bfab", "aaaManaged": false }, { "groupId": "29c6d78b3abee8fa5c2b21ec", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ad elit veniam" }, { "roleId": "mollit elit" }, { "roleId": "in aliquip do tempor commodo" }, { "roleId": "laboris in" } ], "inactive": true, "_meta": { "created": "2019-04-23T18:27:06.708Z", "updated": "1983-09-07T16:30:13.683Z", "migrationVersion": 64608208 } } ], "iterations": [] } }, "parent": { "job": "consectetur", "task": "et", "iteration": 2483844.0147206634, "element": -18295099.521013156 }, "errorHandler": null, "groups": [ "default", "3e47e07baa9df72e2f847081", "bbfa4899ffc2bb5687d0a907" ], "watchers": [ "Pronghorn", "Pronghorn", null, { "_id": "fa1383473dc8bd254cd52273", "provenance": "sed occaecat enim quis dolor", "username": "dolor voluptate deserunt", "firstname": "proident", "memberOf": [ { "groupId": "a86ccf880c6d3ccdd6de9fff", "aaaManaged": false }, { "groupId": "11cb3bd72480f727d27581c5", "aaaManaged": true }, { "groupId": "8933ad5082a2cbb58a3c950d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ad magna do dolor ipsum" }, { "roleId": "mollit deserunt ut ex" }, { "roleId": "Duis cupidatat qui" }, { "roleId": "occaecat sit qui irure" } ], "inactive": false, "lastLogin": "1998-07-23T16:47:26.736Z", "_meta": { "created": "1963-03-23T06:59:34.839Z", "updated": "1966-08-26T11:36:51.506Z", "migrationVersion": 27378177 }, "email": "cupidatat" }, "Pronghorn" ], "metrics": { "start_time": -96476125.25410722, "progress": 0.10402770286241259, "end_time": -21241746.95027113, "user": "7619cc826be2b62586803611", "owner": "cad3bf726174363e48443cc2" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }