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 imported 3 of 4 documents", "data": { "_id": "8123a181f9ebe7fa2c20c4f1", "font_size": -37102563, "type": "resource:action", "created": "1971-10-25T22:43:59.77Z", "last_updated": "1986-10-01T10:52:20.621Z", "createdVersion": "2.609540.75404577155", "lastUpdatedVersion": "41.93.5635140-3144.49111.05", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": -81366586, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 13256914.631272301, "sla": -12882637.08676967, "decorators": [ { "type": "encryption", "pointer": "/nOg0p8/~0/xs6B/HPHwBD/~1/~1/jGB/B+/~1" }, { "type": "encryption", "pointer": "/N8bGN0fiC1q/~0/~0/b-UIl-/ClZ/~1/~1/~0/JD3/x" }, { "type": "encryption", "pointer": "/I6H7zQ2/bDj9ELKrsNg" }, { "type": "encryption", "pointer": "/Ehta0A9X/~0/cclNXSI/dTUrhQ/~0/~1/xv/WC2w/~0" } ], "status": "error", "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": "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": "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": "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", "message": "Duis Excepteur in aute" } ], "ancestors": null, "validationErrors": [ { "keyword": "pariatur", "dataPath": "ut", "schemaPath": "commodo et", "message": "tempor id cillum commodo" }, { "keyword": "enim voluptate consequat aliquip", "dataPath": "ad magna dolor sunt exercitation", "schemaPath": "aliqua dolore", "message": "ut in in" } ], "created_by": "ee92c7d9a9591a13d95271ca", "last_updated_by": { "_id": "8d0ee4c9012d0d5c14a96c00", "provenance": "Duis", "username": "dolor qui ullamco proident esse", "firstname": "qui ex culpa", "memberOf": [ { "groupId": "19ef37c4d1cadbab61f4f1ae", "aaaManaged": false }, { "groupId": "c824f435d6feda2b321a4e54", "aaaManaged": true }, { "groupId": "1d0ec405c2f9fa14f5595d74", "aaaManaged": true }, { "groupId": "a1f27205342d251daf97dce4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "est" }, { "roleId": "in dolor ipsum non" } ], "inactive": true, "lastLogin": "1956-04-17T22:32:48.06Z", "_meta": { "created": "2001-01-17T00:09:21.487Z", "updated": "1954-05-20T10:42:50.448Z", "migrationVersion": -42554906 }, "email": "elit ea sit deserunt ex" }, "tasks": { "94": { "x": -89306826.24208552, "y": 1344640.3071306646, "gridCoordinate": { "x": -64326838.59693196, "y": 37695712.18200579 }, "name": "deserunt laboris", "location": "Adapter", "locationType": "fugiat Lorem proident", "app": "eu consectetur irure", "canvasName": "amet pariatur ea ullamco", "displayName": "eiusmod proident laborum aliquip non", "summary": "nisi Duis deserunt in ut", "description": "ad", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/c,urcng5sTg/~1/o10P/iyQO0m/W2uFqwtF,bf/~1/~0/~0/NQUOu," }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/~0/~0/l3.VSC+F3A/~1/j/ut6Uv/CkR28Bv" }, { "type": "encryption", "pointer": "/~1/~1/~0/~1/i/Z/qxLER.W/h3G,y2Trb" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "veniam laborum deserunt dolore", "highlightString": "ex ad" }, { "key": "est", "highlightString": "est commodo cupidatat eiusmod enim" }, { "key": "enim", "highlightString": "ullamco voluptate Excepteur dolore culpa" }, { "key": "enim ullamco voluptate", "highlightString": "cillum nisi ad incididunt deserunt" }, { "key": "commodo sunt", "highlightString": "ullamco et" } ], "status": "failure", "previous": { "incomplete": [ "3a1f", "error_handler", "3a1f", "e28f" ], "complete": [ "workflow_end", "3a1f", "workflow_start" ], "error": [ "e28f", "workflow_start" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "3a1f", "type": "loop" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_end", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "3a1f", "type": "revert" } ] }, "serverId": "in ullamco irure ut dolore", "start_time": "1953-09-27T19:37:57.188Z", "end_time": -64649395.45050963, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ { "_id": "31ce6780369f399dbd76f1bb", "provenance": "occaecat esse", "name": "eiusmod", "description": "ex reprehenderit mollit minim", "memberOf": [ { "groupId": "1a74ff1c2cf4d7d19fbb1ad7", "aaaManaged": true }, { "groupId": "8c36db25a15757ecc9d8eac4", "aaaManaged": true }, { "groupId": "af584637836220ab98c0fa42", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "incididunt magna in" } ], "inactive": false, "_meta": { "created": "1988-01-08T17:48:45.164Z", "updated": "1977-05-28T04:50:09.344Z", "migrationVersion": 62538867 } }, { "_id": "bdee6bb4684c711207aaca2d", "provenance": "do aliquip aute ullamco ea", "name": "occaecat", "description": "cillum", "memberOf": [ { "groupId": "e736ee2505764503c062d7bf", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolore officia anim deserunt minim" }, { "roleId": "sint et nisi" } ], "inactive": true, "_meta": { "created": "1965-04-22T19:48:30.162Z", "updated": "1958-02-05T04:23:31.844Z", "migrationVersion": -91501354 } }, "b6427d3383c6f9da79095712", "default", "50701d53d5c70338b13dae21" ], "iterations": [] }, "workflow_start": { "x": 59147207.94973031, "y": 39979431.75801173, "gridCoordinate": { "x": -69805351.16654871, "y": -96202979.57732862 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 17646925.678430364, "finish_state": "success", "user": { "_id": "10975754b4f8eda73ef4f57a", "provenance": "in in et esse cupidatat", "username": "laboris irure cillum nostrud", "firstname": "ut cillum consequat", "memberOf": [ { "groupId": "84e22fb23370d719b25694c8", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aliquip" }, { "roleId": "Ut exercitation dolor" }, { "roleId": "culpa magna laborum" } ], "inactive": false, "lastLogin": "2016-11-12T00:41:41.871Z", "_meta": { "created": "1986-01-25T16:09:55.873Z", "updated": "1967-10-23T10:33:52.335Z", "migrationVersion": 21830711 }, "email": "sint et" } }, "groups": [ "default", { "_id": "26ddd6604f38305e875bf6f1", "provenance": "aliquip in", "name": "Ut cillum", "description": "consectetur sed ad commodo dolor", "memberOf": [ { "groupId": "28a804952c91ab83fbbda82e", "aaaManaged": true }, { "groupId": "aaff3df98d98103bf18d5135", "aaaManaged": true }, { "groupId": "6b3183c128e0d9579d2371d5", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolore minim irure" } ], "inactive": true, "_meta": { "created": "1987-04-07T02:01:42.834Z", "updated": "1952-10-31T01:36:55.004Z", "migrationVersion": -52546604 } } ], "iterations": [ "eAbaEBfb-FEd4-c6Df-E2aa-E8747cC9B0bB", "078d638e-e72f-fbe3-6fdb-2F53b5b3d8f6", "1AF37b86-8c73-e9fA-EC7A-bfBa96ACa9da" ] }, "workflow_end": { "x": 97523848.94452244, "y": 99199746.06723416, "gridCoordinate": { "x": 72238908.25526485, "y": 55483675.45116758 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "e28f", "workflow_end", "workflow_start", "3a1f" ], "complete": [ "error_handler" ], "error": [ "workflow_end", "workflow_end" ] }, "metrics": { "end_time": -81742071.00059503, "run_time": 1978293.2911799103 }, "groups": [ "14f8437f54aeeab83e222b57", { "_id": "18f1938b4f6c140bac48de3f", "provenance": "sit nisi", "name": "in elit", "description": "proident irure", "memberOf": [ { "groupId": "a568ffdc6c0bc71279a0e408", "aaaManaged": true }, { "groupId": "d54d2c6a9930d46a7e51bd4c", "aaaManaged": false }, { "groupId": "570e1a22ac50d02e3dbb102b", "aaaManaged": false }, { "groupId": "afca753e15d37f30deb9d0f9", "aaaManaged": true }, { "groupId": "99be62ca6ffb01072253a154", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "esse ipsum" }, { "roleId": "nulla qui aliquip" }, { "roleId": "adipisicing" }, { "roleId": "non id ullamco" }, { "roleId": "cillum culpa" } ], "inactive": false, "_meta": { "created": "2010-08-08T14:22:07.719Z", "updated": "2017-01-19T06:32:07.243Z", "migrationVersion": -19291680 } }, "ca5f8438cf9918e9830be59d", "default", "731e2063aab327842248ccba" ], "iterations": [ "321D7e03-b3fA-6ab4-70D8-BDB0BD7Fcc11", "B82CF988-a1D1-58fF-0Bb4-AAF3a3dbc2A9" ] }, "error_handler": { "x": 13100256.603841841, "y": -80279392.42209601, "gridCoordinate": { "x": -98460624.5062826, "y": -85314080.95434947 }, "name": "childJob", "location": "Application", "locationType": "est nisi ea", "app": "dolore aliqua", "canvasName": "qui ut ex dolore", "displayName": "reprehenderit ad sed ullamco velit", "summary": "aliqua", "description": "dolore", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/yejMfW5P/~1/FdwFS9W3VZT/sW/,n3td/~1" }, { "type": "encryption", "pointer": "/~1/hJTHc,6zb3/K/vfRRL/~0/PS/qqz92QB/~0/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "laboris Duis", "highlightString": "laborum in ullamco irure amet" } ], "status": "paused", "previous": { "incomplete": [ "3a1f" ], "complete": [ "error_handler", "workflow_start", "3a1f", "workflow_start" ], "error": [ "error_handler", "3a1f", "workflow_start", "workflow_start", "workflow_end" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "error_handler", "type": "standard" }, { "task": "e28f", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_end", "type": "standard" }, { "task": "e28f", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "error_handler", "type": "standard" } ] }, "serverId": "nisi officia anim pariatur adipisicing", "start_time": "2006-09-19T02:15:58.796Z", "end_time": 43675982.32917991, "finish_state": "success", "retrySettings": { "state": [ "error", "success", "success" ], "autoRetry": true, "limit": 16851504, "delay": 84390667, "count": 41364832, "finishedRetrying": false }, "type": "operation", "actor": null, "groups": [ { "_id": "eeb98bf7f266af0c660bc76c", "provenance": "consequat culpa dolore elit Duis", "name": "incididunt ipsum esse Lorem anim", "description": "do in Duis deserunt", "memberOf": [ { "groupId": "c2cdaee9641b9972b242af14", "aaaManaged": true }, { "groupId": "32a14e06135eee5b890b06da", "aaaManaged": false }, { "groupId": "4403b5e497ce3943f4e9b94f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut id" }, { "roleId": "esse in ut" }, { "roleId": "id minim commodo sit" }, { "roleId": "consectetur ut proident ex mollit" }, { "roleId": "dolore" } ], "inactive": false, "_meta": { "created": "1994-08-11T08:27:58.424Z", "updated": "1976-08-16T14:34:45.666Z", "migrationVersion": -6077778 } } ], "iterations": [] } }, "parent": { "job": "eu", "task": "laborum est magna", "iteration": 26102085.114153787, "element": 69004177.59514031 }, "errorHandler": null, "groups": [ { "_id": "3561701462722c48cf395ecf", "provenance": "qui incididunt", "name": "nulla eiusmod qui", "description": "do irure veniam", "memberOf": [ { "groupId": "011c77ec9573566ba7a1257f", "aaaManaged": false }, { "groupId": "f00b6f453d7fab7f9ef1d846", "aaaManaged": false }, { "groupId": "0b91245bfc9d66bb114116a3", "aaaManaged": true }, { "groupId": "eebcd29a24ce00c218f933be", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in Ut dolor adipisicing" }, { "roleId": "reprehenderit elit in" } ], "inactive": false, "_meta": { "created": "1997-09-13T22:25:25.809Z", "updated": "2009-11-23T11:19:23.352Z", "migrationVersion": 5577753 } }, "96e77e6e2d5981a30cde817e", "default", "f88b866759bb65f84a6029b2" ], "watchers": [ "6114b8718df3841d06ec0a68", "Pronghorn", null ], "metrics": { "start_time": -14756855.828016534, "progress": 0.8661252951223339, "end_time": 3402166.532964751, "user": null, "owner": "bed503b2d55893e152cb9788" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }