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": "4896783002de62dbbb5992fe", "font_size": -47181169, "type": "resource:action", "created": "1972-09-26T11:39:46.413Z", "last_updated": "2014-11-26T08:57:06.746Z", "createdVersion": "7.5.88072036", "lastUpdatedVersion": "4065.8.122378-6883.2518583.6552.23", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -95628891, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 29670159.741371676, "sla": -42582557.94786234, "decorators": [ { "type": "encryption", "pointer": "/~0/~1/oPKEU/MyRFgOOSvr/DotwFz/~0/~1/b5hTL0lh2N/~1/~1" }, { "type": "encryption", "pointer": "/nw/hCDxtwMVe/~1/~0/PAIFS/d8Qlr/~1/~1/~1/~0/~0" }, { "type": "encryption", "pointer": "/gZn/~0/~0/~1/~0/tO4gagvLf5J/vi4/~1/oGw4/UTund/~1" }, { "type": "encryption", "pointer": "/ZHe/~1/~1/C/A6W/Bug0T/fy4C+61fc/~0/~0" } ], "status": "paused", "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 } ], "warnings": [ { "task": "e28f", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "magna" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "cillum voluptate" }, { "task": "e28f", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "officia commodo ut cupidatat", "dataPath": "amet", "schemaPath": "Ut ea sunt minim", "message": "irure tempor" }, { "keyword": "aliqua dolor anim sed", "dataPath": "Lorem in dolor ad adipisicing", "schemaPath": "proident culpa qui sunt", "message": "anim incididunt dolor mollit nulla" } ], "created_by": { "_id": "a81cc3b3363dff72bc56359f", "provenance": "aliquip aute in Lorem", "username": "incididunt deserunt magna aliqua esse", "firstname": "non do", "memberOf": [ { "groupId": "6888804a6ce78f4734d89fb5", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "incididunt magna" }, { "roleId": "reprehenderit Lorem nulla" }, { "roleId": "ex quis elit adipisicing tempor" }, { "roleId": "id" } ], "inactive": true, "lastLogin": "1966-08-17T23:40:52.707Z", "_meta": { "created": "1951-10-03T02:25:45.246Z", "updated": "1987-08-12T12:23:00.599Z", "migrationVersion": -13446570 }, "email": "dolor nostrud consequat velit" }, "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": -84357003.98949666, "y": -63843242.77744571, "gridCoordinate": { "x": 6069531.957408354, "y": -10119645.785524428 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -27069779.966412395, "finish_state": "error", "user": "e8b7a16867c6d715ee95a8af" }, "groups": [ { "_id": "99de17de99577955584bf597", "provenance": "fugiat id in", "name": "incididunt in occaecat laborum proident", "description": "sint", "memberOf": [ { "groupId": "4be79b1cd8ce2538ef6ee0b3", "aaaManaged": false }, { "groupId": "70943a87d42bfc68ee3848c7", "aaaManaged": false }, { "groupId": "e27a98355d7563d98cacbc5d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cillum aute Duis dolore" } ], "inactive": false, "_meta": { "created": "1994-05-03T03:30:29.213Z", "updated": "1992-01-16T20:49:33.546Z", "migrationVersion": -51971693 } }, "default", "b30566afcb8ee7a5f147eafb", { "_id": "72f3b5fa0175179607e65a99", "provenance": "voluptate ut dolore", "name": "in est esse", "description": "sit", "memberOf": [ { "groupId": "7fcf513041ecc751ec644e51", "aaaManaged": true }, { "groupId": "5edc2e1e8e4967e113c17f03", "aaaManaged": false }, { "groupId": "55694daa19d86b2b9c679dc9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ipsum" }, { "roleId": "dolor" } ], "inactive": true, "_meta": { "created": "2011-10-01T13:19:44.086Z", "updated": "1966-01-28T02:43:03.329Z", "migrationVersion": -47975187 } } ], "iterations": [ "dda8d1b1-cc47-6dDE-bebb-0D80DAd0d04c", "C5EF2B50-196d-d040-bcEC-CED49C34EeC2" ] }, "workflow_end": { "x": -572298.651678294, "y": 99672942.06854075, "gridCoordinate": { "x": 12064819.314351067, "y": 53332076.64934769 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "workflow_start" ], "complete": [ "error_handler", "workflow_start", "workflow_start", "3a1f" ], "error": [ "workflow_start", "error_handler" ] }, "metrics": { "end_time": 53390865.917357296, "run_time": -68407883.57658866 }, "groups": [ { "_id": "3dac85cc0b1bed85cb3d9dff", "provenance": "consequat aliquip nisi aute", "name": "cillum enim", "description": "incididunt sed", "memberOf": [ { "groupId": "06ba268da7bf02914b1c8cfe", "aaaManaged": true }, { "groupId": "346d0d1514b09b16403b0608", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "incididunt deserunt Excepteur dolore ullamco" }, { "roleId": "est deserunt veniam ea" }, { "roleId": "consectetur aute cillum commodo" }, { "roleId": "ullamco Lorem ipsum Ut" } ], "inactive": true, "_meta": { "created": "2011-06-12T00:47:54.498Z", "updated": "1957-11-26T12:05:40.137Z", "migrationVersion": -93116570 } }, "dd974eb128e6e1132bd5cef0", "default", "default", "d319375ed9308dac83737f1b" ], "iterations": [ "1bcC5A00-a92B-9B76-dAd1-265a1E644CFD", "C492d9e5-6aF6-88D9-0558-E0EA2aFeBE8D", "ce3c3eaB-BD9D-E059-0Ca5-EA1c5fb3E72d" ] }, "error_handler": { "x": -16160883.55154273, "y": 94575365.12040368, "gridCoordinate": { "x": 51978607.78485128, "y": 53501495.02145901 }, "name": "childJob", "location": "Broker", "locationType": "ut do", "app": "exercitation sint", "canvasName": "magna tempor sed esse quis", "displayName": "esse quis sed ea", "summary": "laborum incididunt aliqua", "description": "non culpa enim", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1" }, { "type": "encryption", "pointer": "/~0/UaWIn/~1/~1/~1/~1/~0" }, { "type": "encryption", "pointer": "/wL2-/L+9X-cs2,/X/~1/~0/w/Y/kixs,7,/ue4YCL" }, { "type": "encryption", "pointer": "/ZI+caYo9/~1/~0/~0/XuUY" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "in Excepteur nostrud minim nisi", "highlightString": "enim sunt ullamco est" }, { "key": "esse occaecat", "highlightString": "sunt cupidatat minim" }, { "key": "culpa in ea", "highlightString": "nulla" }, { "key": "occaecat cupidatat voluptate anim ullamco", "highlightString": "do reprehenderit" }, { "key": "dolor magna", "highlightString": "ad tempor eiusmod" } ], "status": "failure", "previous": { "incomplete": [ "workflow_start", "e28f", "3a1f", "error_handler", "error_handler" ], "complete": [ "e28f", "e28f" ], "error": [ "e28f", "error_handler" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_end", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "e28f", "type": "revert" } ], "failure": [ { "task": "workflow_end", "type": "loop" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "loop" }, { "task": "3a1f", "type": "standard" } ] }, "serverId": "et in culpa", "start_time": "2008-07-17T00:58:28.426Z", "end_time": -16346049.656955406, "finish_state": "failure", "retrySettings": { "state": [ "error", "error", "success" ], "autoRetry": true, "limit": 33089920, "delay": 60381788, "count": 35678668, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ { "_id": "07e84897f87d629fadd512bb", "provenance": "nisi", "name": "sed laboris", "description": "anim nulla sed dolore labore", "memberOf": [ { "groupId": "e4167c1d87e8edc9e711f72a", "aaaManaged": true }, { "groupId": "1cffadde3cb66395349b6379", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "veniam aliqua ut" }, { "roleId": "nostrud" }, { "roleId": "sint" }, { "roleId": "enim eiusmod aute sunt" }, { "roleId": "incididunt nisi officia sint" } ], "inactive": true, "_meta": { "created": "1989-01-09T03:24:35.741Z", "updated": "1966-09-18T08:33:32.627Z", "migrationVersion": 18339261 } }, { "_id": "3c8fb67ac0774041c65bc819", "provenance": "Duis aliquip dolor", "name": "aliqua adipisicing", "description": "occaecat", "memberOf": [ { "groupId": "8d5094cc7f7ed2a3816fcc0e", "aaaManaged": true }, { "groupId": "d02febc30be68026803fc646", "aaaManaged": true }, { "groupId": "956c39c2d46f85ad0ce512ef", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "minim anim fugiat in sed" } ], "inactive": false, "_meta": { "created": "2000-10-22T07:23:41.75Z", "updated": "2013-12-10T11:06:19.062Z", "migrationVersion": 11318562 } } ], "iterations": [ "FCC723bb-c2Ae-71dd-819A-239F17E29766", "c4Cffe2f-6b07-4eb3-Fe6b-cDedEd4bFA60" ] }, "9b9": { "x": -1059553.134447813, "y": -43676302.346157536, "gridCoordinate": { "x": -12297911.725366935, "y": 41900104.05477452 }, "name": "dolore fugiat dolore deserunt", "location": "Adapter", "locationType": null, "app": "nulla Ut et in", "canvasName": "amet", "displayName": "consequat sit ut ex", "summary": "cupidatat in ut quis magna", "description": "veniam irure Ut tempor", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Nm,2x./~0/QMrj/Uqei" }, { "type": "encryption", "pointer": "/~0/~0/~0/YManA0eH" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "tempor Lorem cupidatat proident", "highlightString": "laboris" } ], "status": "scheduled", "previous": { "incomplete": [ "3a1f", "workflow_end" ], "complete": [ "workflow_start", "workflow_end", "3a1f", "3a1f" ], "error": [ "workflow_start", "e28f", "workflow_start" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "loop" } ], "failure": [ { "task": "3a1f", "type": "standard" } ], "error": [ { "task": "3a1f", "type": "standard" } ] }, "serverId": "eiusmod", "start_time": "1989-09-09T08:51:19.751Z", "end_time": -58640432.98072796, "finish_state": "success", "retrySettings": { "state": [ "error", "error", "failure", "success" ], "autoRetry": false, "limit": 26095605, "delay": 20272124, "count": 81319602, "finishedRetrying": true }, "type": "operation", "actor": "Pronghorn", "groups": [ "f1d43a9f777b4a4678c1f509" ], "iterations": [ "dA00bA21-d436-a656-56fc-7F2d2D29EA79" ] } }, "parent": { "job": "do labore tempor pariatur enim", "task": "ea dolor in eu amet", "iteration": 79005192.05598369, "element": -95798873.93041027 }, "errorHandler": { "x": -31304315.96133083, "y": 5344679.553220645, "gridCoordinate": { "x": -78223235.6795809, "y": -39442031.596471064 }, "name": "voluptate nisi irure consequat", "location": "Broker", "locationType": "officia est in ut in", "app": "anim", "canvasName": "non aute", "displayName": "magna commodo laborum laboris", "summary": "dolor quis eu", "description": "enim et", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/F/~0/Q9zlr/~1/~1/JdOkto/~1/I,P9CQ8/KP/~1" }, { "type": "encryption", "pointer": "/~1/~1/~0/oJVTZ/lu3BJ/~1/RzZ1GY9qj" }, { "type": "encryption", "pointer": "/~0/~0/~1/~1/~1" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~0/N,DoSgi/~1/CG/yAQB/X" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "dolore", "highlightString": "Lorem in" }, { "key": "laborum culpa", "highlightString": "ullamco" } ], "status": "paused", "previous": { "incomplete": [ "e28f" ], "complete": [ "error_handler", "workflow_start" ], "error": [ "workflow_start", "workflow_end", "workflow_end", "e28f" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "revert" } ], "error": [ { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "3a1f", "type": "standard" } ] }, "serverId": "deserunt quis occaecat eu", "start_time": "1958-11-26T19:07:10.699Z", "end_time": 76577582.31092319, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "1760aded9b13f81350ca12a4", "groups": [ "09d158e9c4baf2ec7eb8c468", "40ee68e89e392d7a2ada6be6" ], "iterations": [ "3DDCDA69-B9CB-11f2-1e6A-9ca2a6aDB5f9", "03AAc9da-f2a0-BFDf-F8DD-F738E6Eeb4B6", "CdB29Db6-dc7b-B90a-27B8-d7d42DFc8565", "d8B9A64D-7D43-5efD-c8CA-35a14807Bd31" ] }, "groups": [ "ecf2a379afc308bac7b226e6" ], "watchers": [ "Pronghorn" ], "metrics": { "start_time": 83785834.5376254, "progress": 0.5529396314441513, "end_time": 49159856.92023569, "user": "5e829fecbae807479eacd4b8", "owner": { "_id": "f8659d804ec73d450caeffd5", "provenance": "velit", "username": "Ut dolor enim", "firstname": "voluptate in ex id", "memberOf": [ { "groupId": "88947cca9ec3f1ead595aacf", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ipsum reprehenderit anim" }, { "roleId": "mollit enim eiusmod nulla exercitation" }, { "roleId": "aliqua eiusmod Ut adipisicing nulla" } ], "inactive": false, "lastLogin": "1974-02-13T18:43:00.069Z", "_meta": { "created": "1994-10-07T13:16:06.482Z", "updated": "1960-11-04T01:06:53.196Z", "migrationVersion": -13401013 }, "email": "adipisicing sunt officia" } } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }