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": "7c605d87715f29aeb3eb224f", "font_size": -12257916, "type": "resource:action", "created": "1976-01-09T19:33:34.104Z", "last_updated": "2010-09-13T01:17:58.854Z", "createdVersion": "7918766555.241.51352110-0530.700.15363537", "lastUpdatedVersion": "275.30208560.281041", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": -79420018, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -96066533.81508826, "sla": -47145039.42024075, "decorators": [ { "type": "encryption", "pointer": "/~1/QPy/~0/~0/Uz0/aEQ1jY/q2" }, { "type": "encryption", "pointer": "/~0/bFTyN/jS4mu/pWX01/H/zjNxon/~1/~0/nG" } ], "status": "incomplete", "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 } ], "warnings": [ { "task": "e28f", "name": "myCoolDocumentName" } ], "ancestors": [ "197dd71ef22eef726dea1f58", "475ecb693b3988e4345f6a8b", "39de93c62510af07e3eca72f", "c9851375a84e1cc68eeb909a", "1841f95cf687479d156203cf" ], "validationErrors": [ { "keyword": "anim aliquip id velit cillum", "instancePath": "dolor consectetur non culpa", "schemaPath": "dolor dolore elit ullamco pariatur", "message": "reprehenderit do dolore" }, { "keyword": "non amet dolore labore aliqua", "instancePath": "fugiat aliqua Lorem deserunt", "schemaPath": "reprehenderit eu ut", "message": "in" } ], "created_by": "Pronghorn", "last_updated_by": null, "tasks": { "workflow_start": { "x": 53620645.193386406, "y": 26320829.49128382, "gridCoordinate": { "x": -43359034.75055822, "y": 21106130.652190432 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -4737501.232225135, "finish_state": "success", "user": "Pronghorn" }, "groups": [ { "_id": "20308a2c34478e9b9d8b7352", "provenance": "Lorem dolor officia id", "name": "proident Ut pariatur", "description": "labore", "memberOf": [ { "groupId": "a528090e4f81ceb02459482a", "aaaManaged": true }, { "groupId": "fcea30bd3db48fa89853dc4b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cillum" }, { "roleId": "consequat Excepteur occaecat eiusmod tempor" }, { "roleId": "velit" } ], "inactive": true, "_meta": { "created": "1946-06-07T05:03:31.486Z", "updated": "2001-11-11T00:53:24.161Z", "migrationVersion": -78077918 } }, "default", { "_id": "98a39ae7c9c5a7cdde6c003e", "provenance": "laborum", "name": "dolor aute", "description": "veniam incididunt et", "memberOf": [ { "groupId": "ee6fa7f9f18269bd2c588c61", "aaaManaged": false }, { "groupId": "2530e355e51c705e50c1e032", "aaaManaged": true }, { "groupId": "f4b4ef9e9aa63b0c0b9f18fd", "aaaManaged": true }, { "groupId": "a1c46bfec2f27080f02d73fa", "aaaManaged": true }, { "groupId": "e0d5a705dad3fee507369ad0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "officia fugiat cillum ipsum" }, { "roleId": "sint quis tempor magna" }, { "roleId": "reprehenderit" }, { "roleId": "pariatur commodo id" }, { "roleId": "mollit proident ea" } ], "inactive": false, "_meta": { "created": "1957-12-27T12:48:18.205Z", "updated": "1961-02-25T10:31:42.031Z", "migrationVersion": -89810393 } }, "5621db87b3641eb0f57a36c3", "default" ], "iterations": [ "a0C2a1A4-a7f4-3eD2-A8dc-F2ce834E55Cc" ] }, "workflow_end": { "x": 77152534.87903121, "y": 55101752.93033081, "gridCoordinate": { "x": 35266920.890215844, "y": 74195968.29594705 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "workflow_start", "workflow_start" ], "complete": [ "3a1f", "workflow_end" ], "error": [ "3a1f", "3a1f", "3a1f", "error_handler" ] }, "metrics": { "end_time": -33983650.815683, "run_time": 453879.4702631831 }, "groups": [ "e176a1e183342ed00f665ff0" ], "iterations": [ "F7638Aa2-97Bd-5c5e-B710-64181fA04Fd6", "A16EAbA3-a657-527A-7511-68e9C04CC9dA" ] }, "error_handler": { "x": 99251301.5920518, "y": 86653237.85325864, "gridCoordinate": { "x": 99515832.44386369, "y": -30334785.41725035 }, "name": "childJob", "location": "Broker", "locationType": "proident", "app": "sunt", "canvasName": "ullamco sint est", "displayName": "et do", "summary": "in", "description": "officia", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Yp7D53/Okc/RSPM/wDX/~0/p8EwpaUSiRE/AuKgjk1/NdfmCqdHYN" }, { "type": "encryption", "pointer": "/pHJsNX/~0/~0/~1/h0g/F7B-UL1B" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "mollit", "highlightString": "nostrud incididunt nisi officia" }, { "key": "sed Duis ut laboris", "highlightString": "qui Ut ad dolor deserunt" }, { "key": "sed mollit minim", "highlightString": "ullamco ad amet" }, { "key": "ut culpa", "highlightString": "aliquip ea" } ], "status": "failure", "previous": { "incomplete": [ "e28f", "e28f", "workflow_end", "workflow_start" ], "complete": [ "workflow_start", "workflow_end", "workflow_start" ], "error": [ "3a1f", "error_handler", "3a1f", "e28f" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_end", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "e28f", "type": "standard" } ], "failure": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "loop" } ], "error": [ { "task": "workflow_end", "type": "standard" }, { "task": "3a1f", "type": "revert" } ] }, "serverId": "aliqua tempor", "start_time": "1949-03-12T17:38:31.294Z", "end_time": -32291276.17785217, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default", "20dee1e37c6b4bcc9c5bf3d1", "default", "c14a77733e0701773e26c79c" ], "iterations": [ "cDD90341-D2ED-fc8f-791d-5eBcBaEbACEe", "eC1B3907-E025-EfAB-E08e-AD9B2B683e7D", "ABCa89f5-FcBf-2acD-7cfd-fBDDAcdAC95C" ] }, "e4": { "actor": "3159b8f1b3c41b89cced164f", "groups": [ { "_id": "009e39aecc42b03ecc76a6e9", "provenance": "Duis", "name": "elit sed non dolore", "description": "reprehenderit", "memberOf": [ { "groupId": "1eeef409b17ce48aae09bb3b", "aaaManaged": true }, { "groupId": "cbed1c2ab0b38eb7ddf90c5d", "aaaManaged": false }, { "groupId": "bef2e76d6728986b3f20129c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in proident elit Excepteur commodo" }, { "roleId": "sit ex id in dolore" } ], "inactive": false, "_meta": { "created": "1996-07-30T08:16:58.342Z", "updated": "1987-01-18T17:52:52.768Z", "migrationVersion": -21939093 } }, { "_id": "acbb1d53cc346ea144ce7cec", "provenance": "voluptate in", "name": "quis pariatur", "description": "tempor minim incididunt in", "memberOf": [ { "groupId": "6faa6a34bce8514fc059c06a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "elit in" } ], "inactive": true, "_meta": { "created": "1985-01-05T13:06:29.09Z", "updated": "1985-02-15T07:51:26.009Z", "migrationVersion": 70820216 } }, { "_id": "073336db1898d17790981213", "provenance": "ut veniam proident eiusmod dolor", "name": "aliquip", "description": "ea esse", "memberOf": [ { "groupId": "1566c1c9513d885b2a6f95ab", "aaaManaged": false }, { "groupId": "2c85015fa4d45fc1f7fbbfc3", "aaaManaged": true }, { "groupId": "b08c8894e27dd9203db50b27", "aaaManaged": false }, { "groupId": "8778f201ac4a250631f285b3", "aaaManaged": true }, { "groupId": "a73a49b06b10d86e43f873ce", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor nulla proident ut" } ], "inactive": true, "_meta": { "created": "2012-07-14T04:21:16.435Z", "updated": "1947-01-21T00:42:13.369Z", "migrationVersion": -93811398 } } ], "iterations": [ "b7690D0E-1f31-555A-eb9A-f93560EB77A2", "cbDd089F-FE0f-A0Ee-CCde-7FCA61DFAAe2" ], "x": 46173081.37401822, "y": -82596696.67053577, "gridCoordinate": { "x": -48166986.969830684, "y": 69200269.53050992 }, "name": "ea", "location": "Adapter", "locationType": null, "app": "mollit esse eu", "canvasName": "childJob", "displayName": "nulla irure", "summary": "aliquip Ut adipisicing aute", "description": "ut occaecat ut nostrud", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/o3fZBD6Q/uyAiMyVR/NhN/~1/pYpaIz9Tms/U3Ix/~0" }, { "type": "encryption", "pointer": "/~0/F3VZ/~0/~1/ypaMhzbXS-/~1/mj/6ZzHD0Te/~1/~0/r.l+IpcDN5" }, { "type": "encryption", "pointer": "/oi41j/~1/Uwc/xsEr/uuw3UZXW-ll/BH4Z7fJ,qh/r8hAl30D/Q/~1" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "exercitation laboris aute consequat", "highlightString": "laborum quis" }, { "key": "in est dolore nostrud", "highlightString": "do incididunt sit" }, { "key": "in tempor Ut officia", "highlightString": "aliqua laboris id" }, { "key": "aliquip consequat", "highlightString": "Excepteur occaecat dolor" } ], "status": "canceled", "previous": { "incomplete": [ "3a1f" ], "complete": [ "workflow_start" ], "error": [ "workflow_end" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "revert" } ], "error": [ { "task": "e28f", "type": "loop" }, { "task": "e28f", "type": "revert" } ] }, "serverId": "sint ut fugiat aliquip", "start_time": "1959-05-14T22:01:53.398Z", "end_time": -45749467.18868147, "finish_state": "success", "retrySettings": { "state": [ "error", "error" ], "autoRetry": true, "limit": 48124071, "delay": 45292191, "count": 1687728, "finishedRetrying": false }, "loop": { "atLeastOneComplete": true, "finishedCount": 14883253.048300698, "outgoing": [ "pariatur adipisicing ullamco", null, null, "esse in minim nostrud" ] }, "childJobs": [ { "_id": "dolor veniam", "name": "cillum dolor in ea aliqua", "iteration": 99056630.45836094 }, { "_id": "proident", "name": "enim amet minim Duis", "iteration": -20526085.281084284 } ] } }, "parent": { "task": "adipisicing elit id amet Excepteur", "iteration": -34431359.79869782, "element": 30158168.137146518 }, "errorHandler": { "actor": "job", "groups": [ { "_id": "1274cdd5f3773f60a5e340d6", "provenance": "deserunt", "name": "consectetur", "description": "Duis", "memberOf": [ { "groupId": "4acd661d4f69c7a6cac06570", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolore minim et sit aliqua" }, { "roleId": "ex" }, { "roleId": "id" }, { "roleId": "qui dolor" } ], "inactive": true, "_meta": { "created": "1972-12-15T12:28:23.203Z", "updated": "2011-01-25T15:20:54.889Z", "migrationVersion": 1477910 } } ], "iterations": [ "cEAbF1A7-eF2d-bC8a-fdc3-a5796a4Bb5aA", "629aAa23-3BcC-B90E-3A63-bfbeD2bEc4aA" ], "x": 58792722.23600793, "y": 51282280.06490713, "gridCoordinate": { "x": -17534246.68979977, "y": 53931735.9553943 }, "name": "enim veniam non qui", "location": "Application", "locationType": "ad laboris Duis ut Lorem", "app": "consequat in", "canvasName": "childJob", "displayName": "consectetur labore", "summary": "cupidatat ut qui", "description": "sunt proident velit tempor adipisicing", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1/h,H3a--HcJC/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "commodo nisi", "highlightString": "esse reprehenderit irure dolore velit" }, { "key": "culpa nostrud laboris Excepteur", "highlightString": "Excepteur" }, { "key": "Duis", "highlightString": "laborum sunt enim" } ], "status": "paused", "previous": { "incomplete": [ "workflow_start", "e28f", "workflow_start", "workflow_start", "error_handler" ], "complete": [ "3a1f", "e28f", "error_handler" ], "error": [ "workflow_end", "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "loop" }, { "task": "e28f", "type": "revert" } ], "failure": [ { "task": "workflow_end", "type": "revert" }, { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "revert" } ] }, "serverId": "sit non ullamco laboris ad", "start_time": "1990-10-29T19:43:49.891Z", "end_time": 73792398.40172777, "finish_state": "error", "retrySettings": null, "loop": { "atLeastOneComplete": true, "finishedCount": -52824437.77687331, "outgoing": [ null, "sint in veniam", null ] }, "childJobs": [ { "_id": "id enim nisi aliquip exercitation", "name": "minim nulla", "iteration": -47163062.54145706 }, { "_id": "dolor nulla do nisi", "name": "consequat in", "iteration": -24305808.88125369 } ] }, "groups": [ { "_id": "851bb6837ca30e7460bbc81c", "provenance": "sunt aliquip fugiat ex", "name": "ipsum eiusmod", "description": "cillum eiusmod", "memberOf": [ { "groupId": "56a0e1bce4acaf27641079a4", "aaaManaged": true }, { "groupId": "b885b8ac5d885758ec78152c", "aaaManaged": false }, { "groupId": "01e47ac604b4bcde8e2b274b", "aaaManaged": true }, { "groupId": "d26c1461c3280ee52c480ff1", "aaaManaged": true }, { "groupId": "86bf9c22324b42de9db689bf", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consequat mollit sunt id" }, { "roleId": "et aliqua" }, { "roleId": "in dolor" } ], "inactive": false, "_meta": { "created": "2009-02-26T07:46:34.2Z", "updated": "1982-01-23T16:51:49.84Z", "migrationVersion": -48020049 } }, "default" ], "watchers": [ { "_id": "f492a41b6497cc40b8884873", "provenance": "magna culpa ex", "username": "dolore officia veniam laboris", "firstname": "laborum in", "memberOf": [ { "groupId": "fe8176421b573bcb8019ba44", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nostrud culpa irure" }, { "roleId": "Lorem" }, { "roleId": "est" }, { "roleId": "incididunt" } ], "inactive": true, "lastLogin": "1992-04-10T16:31:40.407Z", "_meta": { "created": "2022-08-19T19:47:54.263Z", "updated": "1973-11-06T02:28:08.32Z", "migrationVersion": -65683969 }, "email": "nostrud culpa" } ], "metrics": { "start_time": 22750126.16970335, "progress": 0.8348061693623168, "end_time": -83138849.38921414, "user": "8d93e0637b753d2df7da351b", "owner": "8aceabe85ebc7b699c01b6b2" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }