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": "476e1c423771a92eb8b69bc2", "font_size": -59289937, "type": "automation", "created": "2020-05-13T01:04:57.415Z", "last_updated": "2013-01-05T08:49:25.368Z", "createdVersion": "793211.56610036505.7275136", "lastUpdatedVersion": "57.923821.7839379495-4052.751873.6135", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -44593778, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 73686776.28578797, "sla": -11459079.14446798, "decorators": [ { "type": "encryption", "pointer": "/~0/Xc/h08/xzCu9fQ/zlp2QDF" }, { "type": "encryption", "pointer": "/~0/d/lLZmPg9/sDTJ" }, { "type": "encryption", "pointer": "/YNT/~0/~0/gqLH1pgB/b4nBJC/ZVmgweK5/~1/JBNkXd/~0" } ], "status": "paused", "tags": [], "error": [ { "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": "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": "workflow_end", "name": "myCoolDocumentName" }, { "task": "e28f", "name": "myCoolDocumentName", "message": "ipsum Ut consectetur" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "esse id adipisicing quis incididunt" } ], "ancestors": [ "1de0a56f0b14e206f85bd891", "a2612146be9399c58a9723e0" ], "validationErrors": [ { "keyword": "nostrud nulla et ullamco ut", "dataPath": "minim exercitation", "schemaPath": "sunt irure ad est", "message": "officia" }, { "keyword": "aute non minim", "dataPath": "in laborum", "schemaPath": "ex", "message": "do et" }, { "keyword": "cillum velit Excepteur", "dataPath": "commodo dolore", "schemaPath": "dolore", "message": "Duis" }, { "keyword": "in", "dataPath": "ad", "schemaPath": "nisi est sit exercitation ullamco", "message": "consectetur qui" } ], "created_by": null, "last_updated_by": { "_id": "75c2ca5c86e7045ee00df32e", "provenance": "eiusmod incididunt", "username": "eiusmod exercitation culpa", "firstname": "dolor in est cillum", "memberOf": [ { "groupId": "18807527879a50ea852a72dc", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eu anim" } ], "inactive": false, "lastLogin": "1987-12-07T03:30:30.664Z", "_meta": { "created": "1956-02-05T00:35:03.551Z", "updated": "2024-04-17T12:05:55.214Z", "migrationVersion": 73223932 }, "email": "ea do Ut incididunt Duis" }, "tasks": { "workflow_start": { "x": 36065384.25680849, "y": 26409162.029696047, "gridCoordinate": { "x": 36795582.50725785, "y": 42414962.498594284 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 4993413.801316485, "finish_state": "error", "user": "cf7a5691a1c07d85af4fc81b" }, "groups": [ "1e706b9e6e691414953695aa", { "_id": "1cc8769937475768e76f94cd", "provenance": "in ex", "name": "id eu velit", "description": "Excepteur eu consectetur deserunt", "memberOf": [ { "groupId": "692d8c4614747e6681c93680", "aaaManaged": true }, { "groupId": "53ba3d2beb1ec4d8ea311e2d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "est et nulla fugiat mollit" } ], "inactive": true, "_meta": { "created": "1967-11-18T21:12:50.485Z", "updated": "1976-08-20T06:50:22.728Z", "migrationVersion": 6441326 } }, "default", "2a8980c438f383e8c052a99e", { "_id": "8c32ad39a62ce03bcbe61924", "provenance": "cupidatat", "name": "et Excepteur", "description": "nostrud Excepteur sint sunt", "memberOf": [ { "groupId": "df639a1a81007cdf230e74dd", "aaaManaged": false }, { "groupId": "e9449be41918a32b7d4c6522", "aaaManaged": true }, { "groupId": "6f0bff96490d31cbe699ef85", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consectetur nostrud" }, { "roleId": "eu nulla" } ], "inactive": true, "_meta": { "created": "1974-02-26T01:36:27.09Z", "updated": "1992-12-08T05:51:32.604Z", "migrationVersion": -21529874 } } ], "iterations": [ "C9f8B7Fb-dbB2-e667-C31E-F86a985C7aEE" ] }, "workflow_end": { "x": 12318956.486040607, "y": 49261787.68950811, "gridCoordinate": { "x": 60187121.13872206, "y": -28905032.542101458 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start" ], "complete": [ "e28f", "workflow_end", "workflow_start", "error_handler" ], "error": [ "error_handler", "error_handler" ] }, "metrics": { "end_time": -69314003.58552429, "run_time": 74107256.80133942 }, "groups": [ "33d01f53553ebe4c10ad524d", "13572328b8c1c9999133b4dc" ], "iterations": [ "6FBc232C-8b25-f20B-dEDA-7e3290bdf8d0" ] }, "error_handler": { "x": -39672506.154007435, "y": -56333724.209656656, "gridCoordinate": { "x": 90165371.74673626, "y": 57290021.90179041 }, "name": "childJob", "location": "Application", "locationType": null, "app": "et eiusmod est aliquip sit", "canvasName": "veniam nostrud", "displayName": "aute dolor culpa", "summary": "amet eiusmod esse consequat", "description": "amet ad sunt fugiat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/h-OYCHQBh" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "aute cillum dolore velit", "highlightString": "mollit voluptate" }, { "key": "dolore voluptate", "highlightString": "cupidatat do ipsum dolor sint" } ], "status": "running", "previous": { "incomplete": [ "3a1f", "3a1f" ], "complete": [ "workflow_end", "3a1f", "workflow_end", "workflow_end", "e28f" ], "error": [ "workflow_start", "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "e28f", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "Excepteur et cillum commodo", "start_time": "1949-01-03T11:29:38.839Z", "end_time": 38453638.86357936, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "b67d16ae188db8b98ba348d8", { "_id": "bda5f4761e19d872fd7a5ffd", "provenance": "dolore elit", "name": "aliqua incididunt in fugiat", "description": "reprehenderit anim consequat", "memberOf": [ { "groupId": "e365be0bac5b6c4313b7781c", "aaaManaged": false }, { "groupId": "f0c22f3e3227f31f29f8f452", "aaaManaged": false }, { "groupId": "cbb3f68bc005d499e1d42386", "aaaManaged": false }, { "groupId": "2824d393e00d5bed28e15b1a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Excepteur ut nulla dolor" }, { "roleId": "in consectetur culpa nisi nulla" }, { "roleId": "anim dolore Excepteur sed ut" }, { "roleId": "officia eiusmod mollit adipisicing reprehenderit" } ], "inactive": false, "_meta": { "created": "1949-02-19T19:04:28.969Z", "updated": "1963-10-22T13:20:50.469Z", "migrationVersion": 66688342 } }, "cc95235faf0339369323eeb7", { "_id": "2ff7e05a92c3b233f11f9783", "provenance": "laborum sit labore", "name": "ullamco dolor", "description": "voluptate labore sint nulla", "memberOf": [ { "groupId": "e0f4cebb6115956820c0aba3", "aaaManaged": true }, { "groupId": "0e7d2d4676bb08c10330e131", "aaaManaged": true }, { "groupId": "1b6084f4f44d42527a282e12", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "do officia dolore mollit" }, { "roleId": "mollit laboris fugiat cupidatat" }, { "roleId": "fugiat" }, { "roleId": "sint mollit anim dolore dolore" } ], "inactive": true, "_meta": { "created": "1992-12-28T10:29:02.083Z", "updated": "1994-05-25T08:58:01.723Z", "migrationVersion": -94386359 } } ], "iterations": [ "70Fe71A1-5E04-16fC-A9C1-910e3275Ac5B", "E6Dd7edA-1DF4-bFb2-2Ed3-E07Df1F4Fb3F" ] }, "f16": { "actor": "dd7f354d8038c05872468146", "groups": [ "751aa17e72ba8d5d712d13d5", { "_id": "f4d2a8bd885b6f14c7055ee3", "provenance": "aliquip quis pariatur labore in", "name": "amet proident sed cupidatat ex", "description": "sit labore officia", "memberOf": [ { "groupId": "e81d93ca50e9ad9f85c78aca", "aaaManaged": false }, { "groupId": "bbbb69e243afaaab1e17054e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sed est elit" }, { "roleId": "voluptate Duis consectetur" }, { "roleId": "laborum labore est" } ], "inactive": true, "_meta": { "created": "1990-12-30T08:12:46.786Z", "updated": "1965-07-11T02:34:36.083Z", "migrationVersion": 41283920 } } ], "iterations": [ "92acb23d-cc81-C5A2-490d-AB0EAbbBb70F", "a58F81AE-Fc59-2AfD-BA8B-9DcC3EEC21A5", "bc7e097F-bdD6-e1B9-ebe1-DfdFE4e3bf3a" ], "x": -71176544.55750349, "y": -53911172.543908894, "gridCoordinate": { "x": -97168379.04995441, "y": 88847372.77099192 }, "name": "eiusmod sunt commodo", "location": "Adapter", "locationType": "consectetur esse mollit eiusmod anim", "app": "fugiat amet laborum", "canvasName": "minim irure", "displayName": "esse consequat enim", "summary": "ea sed aliquip non", "description": "quis consequat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/pJ/Wp9/y7u,/~0/~0/~1/HMIiD7/" }, { "type": "encryption", "pointer": "/Ubq+/~0/bMt65qV/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "magna dolor consectetur tempor", "highlightString": "mollit" }, { "key": "Lorem nisi ex sed", "highlightString": "nisi esse officia" }, { "key": "velit nulla Lorem dolor non", "highlightString": "incididunt exercitation esse commodo deserunt" }, { "key": "eu Excepteur", "highlightString": "velit officia incididunt dolore amet" } ], "status": "paused", "previous": { "incomplete": [ "workflow_start", "workflow_end", "e28f", "workflow_start", "e28f" ], "complete": [ "3a1f", "workflow_start", "workflow_start", "e28f" ], "error": [ "error_handler", "error_handler", "3a1f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "3a1f", "type": "standard" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "3a1f", "type": "revert" }, { "task": "3a1f", "type": "revert" } ], "error": [ { "task": "workflow_end", "type": "standard" }, { "task": "3a1f", "type": "standard" }, { "task": "error_handler", "type": "loop" } ] }, "serverId": "ea velit laborum amet", "start_time": "2016-09-11T19:13:29.266Z", "end_time": -27370666.28381273, "finish_state": "failure", "retrySettings": null, "type": "manual", "view": "Excepteur nulla" } }, "parent": { "task": "voluptate", "iteration": -66811545.1816306, "element": -57926040.84175234 }, "errorHandler": null, "groups": [ { "_id": "d4084faf6f9d2f83d58672b0", "provenance": "ut in nulla labore cupidatat", "name": "esse dolor", "description": "quis ut deserunt enim ullamco", "memberOf": [ { "groupId": "c2652af20468d3e41d621c09", "aaaManaged": true }, { "groupId": "0e2f0adb9192c5dc59b32e21", "aaaManaged": true }, { "groupId": "4b921106cfa04583432b4a84", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sunt tempor Lorem" }, { "roleId": "minim incididunt in nostrud nisi" }, { "roleId": "occaecat adipisicing in velit" } ], "inactive": true, "_meta": { "created": "1973-08-03T23:31:23.287Z", "updated": "2014-10-15T12:28:23.149Z", "migrationVersion": 10926844 } }, "default", "default" ], "watchers": [ null, "a6bb66fc376b721b33c86d8f", "Pronghorn" ], "metrics": { "start_time": 98149689.3201367, "progress": 0.4226515333379022, "end_time": 96751059.2664023, "user": { "_id": "e3505e79fde85b3766d2b196", "provenance": "velit commodo mollit incididunt veniam", "username": "ea elit", "firstname": "consequat aliqua nulla voluptate", "memberOf": [ { "groupId": "283954ec3dec5acf2c8836c8", "aaaManaged": false }, { "groupId": "fa8fc25a1529c93b343f6954", "aaaManaged": true }, { "groupId": "b04acc50dc0bd79ac5c6f8df", "aaaManaged": true }, { "groupId": "576ea0d007cc51f7399454c9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cillum tempor Excepteur" }, { "roleId": "exercitation" } ], "inactive": true, "lastLogin": "1966-06-28T04:56:09.302Z", "_meta": { "created": "1953-02-15T20:30:34.74Z", "updated": "2005-07-13T09:43:10.347Z", "migrationVersion": 29031639 }, "email": "ut tempor aliqua ipsum irure" }, "owner": { "_id": "a27b00de9d720f998b1fd704", "provenance": "est tempor", "username": "esse pariatur ex laborum in", "firstname": "irure eu", "memberOf": [ { "groupId": "9168fca8a3d86efd333ac198", "aaaManaged": true }, { "groupId": "e7259aa7ebaf47fe6ac6ac82", "aaaManaged": false }, { "groupId": "f4132bf884b324fcbada0b52", "aaaManaged": false }, { "groupId": "05ca50d9ff6f269b4e609381", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aliqua" }, { "roleId": "aliquip ipsum adipisicing proident Ut" } ], "inactive": true, "lastLogin": "2003-12-24T22:39:28.643Z", "_meta": { "created": "2021-04-23T10:52:58.412Z", "updated": "1996-05-24T00:13:05.673Z", "migrationVersion": 44962516 }, "email": "cillum labore" } } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }