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 retrieved search results", "data": { "_id": "78a5ce3a04978de6dc903a08", "font_size": 80130070, "type": "automation", "created": "1950-08-18T11:06:53.306Z", "last_updated": "1960-10-15T11:39:02.033Z", "createdVersion": "506388922.11166.3-9949.0.8748214831", "lastUpdatedVersion": "276215246.60948262376.1-6676.29425747.30443", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": 69623689, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 67975969.40639347, "sla": 1708639.283085972, "decorators": [ { "type": "encryption", "pointer": "/~0/swYp+/b/xSX+U45E3R,/edW6R6/Hv95QMaZi/LQ81O/DZau/Zx0mIc" }, { "type": "encryption", "pointer": "/NEaOi8l/cf0/~0/t1W/i/N+XX0,iI+0/z0A/~0/f/Jr.f./~0/~1" }, { "type": "encryption", "pointer": "/~1/~1/aiT" } ], "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 } ], "warnings": [ { "task": "3a1f", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "et Ut" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "sint incididunt id amet ipsum" } ], "ancestors": null, "validationErrors": [ { "keyword": "mollit", "dataPath": "dolor sit esse do", "schemaPath": "ad", "message": "aliquip veniam esse dolore" }, { "keyword": "et magna", "dataPath": "ut", "schemaPath": "Excepteur esse", "message": "exercitation adipisicing" }, { "keyword": "voluptate consectetur nulla", "dataPath": "veniam ea", "schemaPath": "Lorem Excepteur", "message": "mollit irure nostrud labore" } ], "created_by": "d161aa28eee54253fbec7873", "last_updated_by": "Pronghorn", "tasks": { "52": { "actor": "job", "groups": [ "default", "d7fd870ca2645f0409d969e3" ], "iterations": [ "ad3f16Cc-5C3b-a597-E9Fb-bc16f49B774E" ], "x": -98675578.1840924, "y": 68130235.12677252, "gridCoordinate": { "x": 97590766.0132696, "y": -68107033.73343712 }, "name": "sed", "location": "Application", "locationType": null, "app": "ad sunt ex eu consequat", "canvasName": "childJob", "displayName": "cupidatat ex", "summary": "consectetur", "description": "occaecat tempor laborum Lorem", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/HLxl/ka/fW1/~0/~1" }, { "type": "encryption", "pointer": "/~1/e/g-m7g0Xqd/~0/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "irure laboris in consequat", "highlightString": "ut officia et" }, { "key": "veniam", "highlightString": "laboris" }, { "key": "dolor in", "highlightString": "id in aliqua et" }, { "key": "in commodo tempor dolor", "highlightString": "adipisicing ut enim Lorem" }, { "key": "pariatur in laborum", "highlightString": "sit exercitation" } ], "status": "scheduled", "previous": { "incomplete": [ "e28f", "error_handler" ], "complete": [ "e28f", "3a1f" ], "error": [ "3a1f", "e28f", "error_handler", "3a1f", "e28f" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "3a1f", "type": "revert" }, { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "workflow_end", "type": "standard" } ] }, "serverId": "ad adipisicing pariatur irure cillum", "start_time": "1975-06-16T02:19:02.829Z", "end_time": 86385891.53071207, "finish_state": "error", "retrySettings": { "state": [ "error", "failure", "error" ], "autoRetry": false, "limit": 6169959, "delay": 85986793, "count": 36933344, "finishedRetrying": false }, "loop": { "atLeastOneComplete": true, "finishedCount": -66674824.79399918, "outgoing": [ "veniam dolor velit deserunt nisi" ] }, "childJobs": [ { "_id": "nostrud", "name": "ut Duis consectetur dolor Ut", "iteration": 43937112.407722265 } ] }, "workflow_start": { "x": 88091351.7584399, "y": 87594521.97147265, "gridCoordinate": { "x": -38311919.181132436, "y": 59697361.43361887 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 61297407.03849164, "finish_state": "success", "user": { "_id": "5d44875a80ee77452739b378", "provenance": "dolor", "username": "incididunt", "firstname": "incididunt aliqua ex aliquip quis", "memberOf": [ { "groupId": "0af8086a98bc96041c4513a6", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "velit reprehenderit dolor consequat dolor" }, { "roleId": "ad velit" }, { "roleId": "sed" }, { "roleId": "pariatur ipsum non laborum" }, { "roleId": "dolor occaecat qui" } ], "inactive": false, "lastLogin": "1977-09-24T12:16:28.571Z", "_meta": { "created": "2017-09-04T18:11:21.535Z", "updated": "1959-08-24T05:20:22.366Z", "migrationVersion": 17915455 }, "email": "eiusmod" } }, "groups": [ { "_id": "0d1df38b81ff8c023ddccb80", "provenance": "cupidatat proident eu deserunt labore", "name": "ut non proident Ut exercitation", "description": "nisi sed tempor elit dolor", "memberOf": [ { "groupId": "3786fa6f37b520059e7d2b01", "aaaManaged": false }, { "groupId": "12d7c2837a026e12e2e68016", "aaaManaged": true }, { "groupId": "a8cb0557fb32dac9f8b82fe2", "aaaManaged": false }, { "groupId": "2d0cc0d73fed372e81a591d6", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "reprehenderit do cupidatat Duis" }, { "roleId": "enim reprehenderit" }, { "roleId": "ad ut veniam nostrud" }, { "roleId": "nulla quis ad" }, { "roleId": "consectetur incididunt do sunt in" } ], "inactive": true, "_meta": { "created": "1997-09-17T22:30:17.45Z", "updated": "1988-07-17T14:23:17.572Z", "migrationVersion": 94517944 } }, { "_id": "11e99c94bfcffad4803ddd17", "provenance": "ipsum laborum", "name": "adipisicing enim", "description": "elit veniam dolor", "memberOf": [ { "groupId": "98b0d9d78b8541b8626f8816", "aaaManaged": true }, { "groupId": "b49913766952cb72d0e4624e", "aaaManaged": false }, { "groupId": "c1ce460db1e850dfb18930bc", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "occaecat nostrud" }, { "roleId": "magna" } ], "inactive": true, "_meta": { "created": "1959-04-12T03:26:59.51Z", "updated": "1968-04-11T04:47:35.133Z", "migrationVersion": 6272644 } }, "default" ], "iterations": [] }, "workflow_end": { "x": -85634602.98997812, "y": -52510358.77430006, "gridCoordinate": { "x": 52343182.92661971, "y": 81090024.15048456 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "e28f", "workflow_start", "error_handler", "workflow_start" ], "complete": [ "3a1f", "error_handler" ], "error": [ "3a1f", "workflow_end", "workflow_end", "workflow_start", "workflow_end" ] }, "metrics": { "end_time": -37815114.03487534, "run_time": 41490683.8500523 }, "groups": [ "default" ], "iterations": [ "bEB9caB0-B9cC-a6d8-40FE-6fc4a7e36DEb" ] }, "error_handler": { "x": 36393644.35647106, "y": 91431280.4859137, "gridCoordinate": { "x": 59634114.17673656, "y": -40827717.99448785 }, "name": "childJob", "location": "Application", "locationType": "deserunt aute dolor dolore nulla", "app": "cupidatat quis in ullamco", "canvasName": "nostrud", "displayName": "minim occaecat Ut anim aliqua", "summary": "officia irure sint commodo", "description": "culpa mollit consectetur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/nNKU0nS/~0/rbxHe" }, { "type": "encryption", "pointer": "/JUyw/p/~1" }, { "type": "encryption", "pointer": "/a/~0/~0/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "Ut dolore esse cillum consequat", "highlightString": "Excepteur aute" }, { "key": "culpa sed Ut proident", "highlightString": "aute Excepteur occaecat" }, { "key": "dolor", "highlightString": "est cupidatat" }, { "key": "eiusmod Excepteur", "highlightString": "anim Duis" }, { "key": "tempor sint ad qui irure", "highlightString": "reprehenderit ipsum sunt" } ], "status": "running", "previous": { "incomplete": [ "workflow_start", "3a1f", "workflow_start", "workflow_end", "workflow_start" ], "complete": [ "e28f", "error_handler", "3a1f", "e28f" ], "error": [ "3a1f", "e28f", "e28f", "workflow_start", "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "e28f", "type": "loop" }, { "task": "workflow_end", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "loop" } ] }, "serverId": "in laborum Lorem", "start_time": "1981-07-12T06:41:13.505Z", "end_time": 38974115.31869581, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ { "_id": "76b1ff4e1845bf12639c020d", "provenance": "voluptate ut", "name": "do ipsum culpa consequat esse", "description": "id amet ut", "memberOf": [ { "groupId": "2998e77ab4bd3fc7bb4e20dd", "aaaManaged": false }, { "groupId": "77fafbc8f26674bd52bbaf99", "aaaManaged": true }, { "groupId": "c48a85546b79a991ee769ed6", "aaaManaged": true }, { "groupId": "d496113a13970cd84bfc3ca8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in" }, { "roleId": "minim officia laboris aute" }, { "roleId": "consequat ut Ut est dolore" } ], "inactive": false, "_meta": { "created": "1962-01-18T07:35:59.252Z", "updated": "1972-10-30T21:34:56.279Z", "migrationVersion": -7827995 } }, "3c7a3fcd57612d53e5dfa8be", "default", "default" ], "iterations": [ "9c4053B7-Bd2d-93d6-aBba-D2f88410E0FC", "9Ca777fC-F45F-4AD0-9Fb9-22b50fAfFAF7", "c66aA61D-D9A0-0CC1-da91-2AC6ACABbbe7" ] } }, "parent": { "task": "ut ea Excepteur velit consectetur", "iteration": -37473901.37722149, "element": 567408.248423636 }, "errorHandler": null, "groups": [ "f9e2050f0e863d0410f165b4", "default", { "_id": "276ef8922c2fa7a9a624e5d4", "provenance": "ad cupidatat commodo enim anim", "name": "in", "description": "Ut qui nulla ut tempor", "memberOf": [ { "groupId": "eac45fb459af235ba9387ae9", "aaaManaged": true }, { "groupId": "69449a666dbd3d7ae8cf1563", "aaaManaged": false }, { "groupId": "fedbb5599c2f209ae444e795", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "adipisicing exercitation laborum" }, { "roleId": "eiusmod est" }, { "roleId": "in" } ], "inactive": true, "_meta": { "created": "1945-04-25T18:10:34.87Z", "updated": "1961-07-22T04:55:22.409Z", "migrationVersion": -46964777 } }, "5068427fd32e96784f8e5c74", { "_id": "a0c4e88214306d01c2dd0201", "provenance": "et Ut ad enim aute", "name": "sint ut qui dolor", "description": "dolore do", "memberOf": [ { "groupId": "4b633da3ab43ed75368b7952", "aaaManaged": true }, { "groupId": "976cbf238f16574b6df2532a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "non ex nulla" } ], "inactive": true, "_meta": { "created": "2008-10-23T23:24:02.178Z", "updated": "2000-02-21T22:15:34.957Z", "migrationVersion": 94028596 } } ], "watchers": [ "Pronghorn", "Pronghorn", null, "Pronghorn" ], "metrics": { "start_time": 68505179.97016388, "progress": 0.9395168153329381, "end_time": -16202275.666199699, "user": { "_id": "9abe3481ef99f790626cd5b0", "provenance": "pariatur dolore sint Duis adipisicing", "username": "culpa et sit Excepteur", "firstname": "anim dolore exercitation incididunt mollit", "memberOf": [ { "groupId": "091f61d7b8f0b9238ffdc7d7", "aaaManaged": false }, { "groupId": "6fdc75031d33ad0e0c1eb31e", "aaaManaged": true }, { "groupId": "862ee9c1286bcc59f02bc3d5", "aaaManaged": false }, { "groupId": "8754835468a0ac11b3e947c4", "aaaManaged": false }, { "groupId": "11141d9339cf80a5824c652d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "adipisicing non irure sit voluptate" }, { "roleId": "reprehenderit labore pariatur" } ], "inactive": false, "lastLogin": "2010-07-26T05:30:18.486Z", "_meta": { "created": "2001-09-22T15:35:40.286Z", "updated": "2007-02-01T07:05:11.866Z", "migrationVersion": -184630 }, "email": "culpa eiusmod in" }, "owner": null } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }