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": "dc3cd592d52aeb4eb7876cab", "uuid": "33c407c6-cdac-ba69-502e-d4c987ff9d6f", "font_size": -34178287, "type": "automation", "created": "1996-02-21T19:52:28.895Z", "last_updated": "2006-06-03T08:03:59.594Z", "createdVersion": "770556.97.97951355839-8973.673647.405.66564389", "lastUpdatedVersion": "84.061080563.250071", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": 54378500, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -31437023.33529061, "sla": 15631297.596654996, "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~0/fzygJ+bCsJD" }, { "type": "encryption", "pointer": "/~1/PW5D/~0/u8Jvem8Gq/~1/~1" } ], "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": "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 } ], "warnings": [ { "task": "3a1f", "name": "myCoolDocumentName", "message": "aliqua proident elit" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "nulla quis sunt commodo et" } ], "ancestors": null, "validationErrors": [ { "keyword": "minim", "instancePath": "est ullamco", "schemaPath": "consequat minim ut", "message": "commodo minim tempor amet sit" }, { "keyword": "veniam do magna proident", "instancePath": "do adipisicing", "schemaPath": "eiusmod enim", "message": "in" }, { "keyword": "dolore eu laboris id", "instancePath": "consequat Ut in mollit", "schemaPath": "amet aute deserunt dolor nostrud", "message": "exercitation commodo irure id labore" }, { "keyword": "laboris elit proident irure id", "instancePath": "nostrud laboris", "schemaPath": "ea consectetur dolore", "message": "ut commodo id" } ], "created_by": { "_id": "09a9e95214f6db608a0e3be2", "provenance": "laborum Lorem mollit", "username": "eiusmod qui", "firstname": "non laboris magna nisi deserunt", "memberOf": [ { "groupId": "cfe980c9de3f063c0c020a6d", "aaaManaged": true }, { "groupId": "6dec7e11b9fe4d70184f7538", "aaaManaged": false }, { "groupId": "4db0fc120b9368c9bc014838", "aaaManaged": true }, { "groupId": "4ffd2000a696b74f64d9e1d0", "aaaManaged": true }, { "groupId": "041d817479b3152990bdfbf5", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "est" } ], "inactive": false, "lastLogin": "1957-02-25T12:56:10.188Z", "_meta": { "created": "1993-04-09T20:16:23.907Z", "updated": "1953-10-07T13:11:45.791Z", "migrationVersion": 85813843 }, "email": "non" }, "last_updated_by": "b80505762728008eeb8b01e1", "tasks": { "workflow_start": { "x": 90080223.19887564, "y": 96894586.581343, "gridCoordinate": { "x": -59863550.62993014, "y": -92539399.60552442 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 65609074.403107405, "finish_state": "success", "user": "d99b5f18ec5daab2fc54e16d" }, "groups": [ { "_id": "0b872033339eb73207d437ef", "provenance": "esse eiusmod veniam", "name": "dolor veniam dolore", "description": "qui veniam occaecat", "memberOf": [ { "groupId": "58762ac95003b49c1ffd39d1", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "et" }, { "roleId": "eiusmod occaecat proident Lorem" }, { "roleId": "cupidatat irure aliquip" } ], "inactive": false, "_meta": { "created": "1957-03-02T23:34:11.614Z", "updated": "1996-01-08T22:50:35.626Z", "migrationVersion": 34405474 } }, "default" ], "iterations": [ "02cE0Abd-6Bd1-A42a-F99F-df8196Be8667" ] }, "workflow_end": { "x": 63025325.37235162, "y": 2569599.683469638, "gridCoordinate": { "x": 9650285.876227692, "y": -52929198.85353755 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "workflow_start", "e28f", "workflow_end" ], "complete": [ "3a1f", "3a1f", "workflow_end" ], "error": [ "workflow_start", "workflow_start" ] }, "metrics": { "end_time": 39097783.31625998, "run_time": -92334170.59482822 }, "groups": [ { "_id": "3cf8199e7e83cd0f944e2095", "provenance": "sint non culpa proident", "name": "irure", "description": "ut eu qui laborum adipisicing", "memberOf": [ { "groupId": "71f6e11695c9b30850817373", "aaaManaged": true }, { "groupId": "0b84a725e6c534b6d9315c4c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in do culpa quis dolore" }, { "roleId": "fugiat sed" }, { "roleId": "pariatur incididunt elit ea" } ], "inactive": false, "_meta": { "created": "1982-12-02T14:46:54.931Z", "updated": "2019-05-27T19:29:49.522Z", "migrationVersion": -15320040 } }, "2c3ecefe8ea5f1bdef29db83", "default", "default", "default" ], "iterations": [ "dfaB3CB9-Ae80-344E-09fF-FfFa0dFd4e3c", "FC1ab21D-2A72-E605-61Cc-662ceEA508Da" ] }, "error_handler": { "x": -94934359.34048153, "y": -8444731.086016327, "gridCoordinate": { "x": -55536960.11023814, "y": 84311507.19250956 }, "name": "childJob", "location": "Broker", "locationType": "sit est adipisicing", "app": "dolor", "canvasName": "et ad mollit Ut", "displayName": "ad est quis", "summary": "minim exercitation quis in ut", "description": "officia", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/xd/~1/~1/J/MmxdrWy6Hx/rmc-zsYf4H4/~0/~0" }, { "type": "encryption", "pointer": "/~0/jxW7-tzQWR9/Nj/~1/~1/~1/n/eLDjBDd/~1/~0" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/uCNK+ut/~0/~1/iFqT.C3Dz1q/lh,S/~1/ycyQLIjpu/r6I.CA/~1" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "aliqua proident", "highlightString": "fugiat Lorem amet tempor occaecat" }, { "key": "commodo esse velit sit culpa", "highlightString": "pariatur sed Ut cillum quis" }, { "key": "dolor adipisicing proident ullamco", "highlightString": "pariatur deserunt enim voluptate sit" } ], "status": "scheduled", "previous": { "incomplete": [ "3a1f", "workflow_start", "workflow_start", "workflow_start", "workflow_end" ], "complete": [ "workflow_end", "workflow_start", "error_handler" ], "error": [ "error_handler", "3a1f", "workflow_start", "3a1f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_end", "type": "standard" }, { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "standard" } ] }, "serverId": "irure veniam dolore aute Duis", "start_time": "1955-01-06T08:10:07.349Z", "end_time": -59183437.98898524, "finish_state": "success", "retrySettings": { "state": [ "success", "error", "success", "success", "success" ], "autoRetry": false, "limit": 72441791, "delay": 47178119, "count": 56539116, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ "44384393066c18a3178751fa" ], "iterations": [ "EBEdFF0D-D2B6-346E-FcB5-627ff04607b4", "921eBb57-3092-D92A-e31d-CB2da61F8BFB" ] }, "0c8b": { "actor": "Pronghorn", "groups": [ "531f66f95890d5bd57c68406" ], "iterations": [ "efCdAE5E-F2b0-bEEC-8278-81d5A6D9fbeb", "cFAF6dEB-b2bC-e23F-B34E-FB120BFdFb36", "fF0FE5eC-35ef-ED07-990F-2B04f39cE221" ], "x": -17050708.06184779, "y": 69742268.05572194, "gridCoordinate": { "x": -70612176.20777622, "y": 1291042.4185885787 }, "name": "pending", "summary": "est", "description": "Duis" } }, "parent": { "task": "officia do consequat voluptate", "iteration": -78601574.02430823, "element": -34926180.34206116 }, "errorHandler": null, "groups": [ { "_id": "31ccf68430b91a54e6bef6a6", "provenance": "velit in", "name": "id mollit non sit Lorem", "description": "sunt consequat", "memberOf": [ { "groupId": "9450bd562e081d61cf8dcb24", "aaaManaged": true }, { "groupId": "810779029d2ee63a77a8bbe1", "aaaManaged": false }, { "groupId": "fe1762b71ab5ecbd242bca4a", "aaaManaged": true }, { "groupId": "134850d1f3fef498b31bcf5b", "aaaManaged": false }, { "groupId": "ccf825deaa5617cb342d3c4a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "minim ullamco ut cillum dolore" }, { "roleId": "dolore irure elit" }, { "roleId": "officia reprehenderit" }, { "roleId": "nisi cillum magna" } ], "inactive": false, "_meta": { "created": "1945-10-07T03:07:34.265Z", "updated": "1996-02-22T02:40:20.748Z", "migrationVersion": -72966468 } }, { "_id": "11b702d285984479ef8aecd9", "provenance": "voluptate pariatur ut laborum nostrud", "name": "Excepteur quis", "description": "ex dolore Duis", "memberOf": [ { "groupId": "75d9bce3988f1fe04053d8d2", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nisi non" }, { "roleId": "aliqua" }, { "roleId": "elit" } ], "inactive": true, "_meta": { "created": "1951-04-13T07:45:28.454Z", "updated": "1960-07-14T17:42:16.912Z", "migrationVersion": -53725528 } }, "4cc9c51afc873dfa57f3103b", "default", "default" ], "watchers": [ null, "3ed3525a84389b756e801a66", "Pronghorn", null ], "metrics": { "start_time": 38907328.650976986, "progress": 0.46118451639296687, "end_time": -99596839.45874214, "user": "Pronghorn", "owner": { "_id": "c2617418be0d515078a350f9", "provenance": "do officia amet", "username": "laboris in", "firstname": "ea ullamco", "memberOf": [ { "groupId": "11a9b9b3536a0dfbae3e8c7f", "aaaManaged": false }, { "groupId": "6bf1745ef016cde0976a2ca0", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "qui in fugiat proident" }, { "roleId": "occaecat Lorem" }, { "roleId": "irure" }, { "roleId": "culpa commodo amet irure ex" } ], "inactive": true, "lastLogin": "1982-10-05T14:41:53.323Z", "_meta": { "created": "2019-12-10T10:31:51.205Z", "updated": "1982-10-05T05:54:23.408Z", "migrationVersion": -73554952 }, "email": "cupidatat proident quis et" } } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }