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": "ee357b0a85e331b77682949c", "uuid": "1ce6141b-ad51-a682-d977-14e4b43c8a33", "font_size": -74014327, "type": "automation", "created": "1980-12-11T01:45:10.462Z", "last_updated": "1978-01-05T14:13:27.502Z", "createdVersion": "04088.1863128912.30955-1115.549820.0978471289.9", "lastUpdatedVersion": "6904.082758069.15066756-8462.775602.0464.3165845", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 26120284, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 20839152.001707673, "sla": -90904490.96299365, "decorators": [ { "type": "encryption", "pointer": "/~0/~1/Q/Krv6B,/LqO/~0/g17Hqc" }, { "type": "encryption", "pointer": "/~1/~0/~0/O0iwKIu1hBf/Y/~1/H9tNYW/bZ4d9+in/q-Db.5+" }, { "type": "encryption", "pointer": "/~1/~0" }, { "type": "encryption", "pointer": "/~0/nGnAYSRnyxN/~1/~1/~1/Em+Dn.3b/oizIOq5h/vFanIvB09/~1" } ], "status": "canceled", "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": "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 } ], "warnings": [ { "task": "3a1f", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "culpa in ut" }, { "task": "3a1f", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "proident veniam", "instancePath": "aliquip eu", "schemaPath": "sit", "message": "nostrud proident" }, { "keyword": "fugiat voluptate dolor qui Lorem", "instancePath": "proident aliquip incididunt", "schemaPath": "ut", "message": "qui mollit in consectetur" }, { "keyword": "cupidatat", "instancePath": "Lorem esse id magna incididunt", "schemaPath": "qui esse", "message": "Lorem aliqua adipisicing in" } ], "created_by": { "_id": "629034a6c34f487eb8f97574", "provenance": "quis in nostrud nulla", "username": "laboris", "firstname": "est sint dolor", "memberOf": [ { "groupId": "467db522f1e98a801b166ab3", "aaaManaged": true }, { "groupId": "1064a89b0129ca8235725096", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nostrud pariatur ullamco" }, { "roleId": "incididunt id reprehenderit cillum Lorem" } ], "inactive": false, "lastLogin": "1965-03-12T22:07:42.803Z", "_meta": { "created": "1968-03-10T06:57:58.532Z", "updated": "1978-04-28T16:23:01.167Z", "migrationVersion": 25366795 }, "email": "veniam sint occaecat" }, "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": 47523124.659202635, "y": -68912459.2062365, "gridCoordinate": { "x": -64381309.238709286, "y": 34415385.67002538 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -71930103.71158773, "finish_state": "failure", "user": null }, "groups": [ "default" ], "iterations": [] }, "workflow_end": { "x": -12578697.849760577, "y": -56784933.35961106, "gridCoordinate": { "x": -63198841.5562736, "y": -24078751.58053501 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end" ], "complete": [ "workflow_start" ], "error": [ "workflow_start", "3a1f", "e28f" ] }, "metrics": { "end_time": -37934274.236965805, "run_time": 31059755.055109054 }, "groups": [ { "_id": "dd1c16943bc92c56ad3d454a", "provenance": "labore irure esse aliquip ut", "name": "Excepteur elit in aliqua ullamco", "description": "fugiat laborum qui pariatur commodo", "memberOf": [ { "groupId": "6cf1af62632a79ff371cc475", "aaaManaged": false }, { "groupId": "65875eb4d5d5b44d2c542bb5", "aaaManaged": true }, { "groupId": "0a65fe02fd4e22109b1505d2", "aaaManaged": false }, { "groupId": "8d4fc2191808a28ddfc2ebbf", "aaaManaged": false }, { "groupId": "8558026cc812b1676555e1e4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "qui adipisicing Ut" }, { "roleId": "deserunt consequat magna" }, { "roleId": "fugiat dolor" } ], "inactive": false, "_meta": { "created": "1948-01-02T02:23:54.975Z", "updated": "2025-06-16T23:19:49.532Z", "migrationVersion": 64999895 } }, { "_id": "91afbc605bf1f1309ba28d06", "provenance": "Ut", "name": "veniam culpa sint enim voluptate", "description": "et adipisicing", "memberOf": [ { "groupId": "99bd65fa8aa5befa6aea987e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "labore nostrud in ea" }, { "roleId": "quis veniam" } ], "inactive": true, "_meta": { "created": "1957-03-27T03:12:19.92Z", "updated": "1971-08-24T16:47:18.128Z", "migrationVersion": 2696585 } } ], "iterations": [ "11a5B3ca-AD2F-B2CF-e5E8-fAD35f3518A8" ] }, "error_handler": { "x": 8087915.154503331, "y": -80660076.86903194, "gridCoordinate": { "x": -51138431.6599973, "y": -91431627.39169788 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "Duis", "canvasName": "ut culpa et anim aliqua", "displayName": "officia", "summary": "velit veniam pariatur", "description": "tempor mollit officia esse", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~0/rQYuAh/~1/~1/YEFX/gzTrGiPzYx0/~1/~0/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "anim Duis deserunt eiusmod ex", "highlightString": "magna in dolore fugiat est" }, { "key": "dolore nisi Excepteur non ea", "highlightString": "elit reprehenderit adipisicing ullamco et" } ], "status": "paused", "previous": { "incomplete": [ "workflow_end", "workflow_end", "e28f", "error_handler" ], "complete": [ "workflow_start", "error_handler" ], "error": [ "workflow_start", "e28f", "workflow_start", "e28f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "e28f", "type": "loop" }, { "task": "e28f", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "ut dolor et", "start_time": "1995-09-01T13:54:16.15Z", "end_time": 42955987.65269855, "finish_state": "failure", "retrySettings": { "state": [ "error", "success", "error" ], "autoRetry": false, "limit": 54930866, "delay": 38458800, "count": 6365275, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ { "_id": "f8bb0f5b0f10122d4e03da58", "provenance": "pariatur in ex occaecat", "name": "incididunt Excepteur", "description": "consequat fugiat Ut ut laboris", "memberOf": [ { "groupId": "b54b1632ddf3dfe4bf9ccf53", "aaaManaged": false }, { "groupId": "363a21a5e64c152609fb8141", "aaaManaged": false }, { "groupId": "bbe489bbe76305b45fbc5a7e", "aaaManaged": true }, { "groupId": "9d2b99ed355a02ddf546eb55", "aaaManaged": false }, { "groupId": "98b4a05dd9c99d7e6a19532c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ipsum" } ], "inactive": true, "_meta": { "created": "1976-08-21T15:56:24.836Z", "updated": "1963-03-22T00:33:20.46Z", "migrationVersion": 27740859 } }, { "_id": "6c7e2da9a634fb1204079449", "provenance": "in id qui", "name": "nostrud labore cupidatat", "description": "sed ad enim", "memberOf": [ { "groupId": "37327503bffa70570b056634", "aaaManaged": true }, { "groupId": "b325e4cdaff72dd2e78431e6", "aaaManaged": true }, { "groupId": "7b8795e75ba2505f3583ae8c", "aaaManaged": false }, { "groupId": "86ad6d1b1a343dee6928add0", "aaaManaged": true }, { "groupId": "d458272857b987f73991ef00", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolor" }, { "roleId": "aute irure" }, { "roleId": "do velit consectetur" }, { "roleId": "officia" }, { "roleId": "esse reprehenderit" } ], "inactive": true, "_meta": { "created": "1948-08-20T06:56:18.315Z", "updated": "1968-02-23T13:12:10.431Z", "migrationVersion": -96921127 } } ], "iterations": [ "39AfEfAd-63F6-3D87-CcB8-BFB61bACEBfD" ] }, "31c": { "actor": "$var.127.4ARofxSNwLD", "groups": [ { "_id": "050034cf709c9cb42604524a", "provenance": "sit dolor cupidatat dolore", "name": "ea mollit cupidatat", "description": "eu", "memberOf": [ { "groupId": "bd947592493cc045b0174297", "aaaManaged": true }, { "groupId": "4b0c13d2e06f8adcd4bf6f16", "aaaManaged": true }, { "groupId": "5bb96e81e9a190253b7b47e7", "aaaManaged": false }, { "groupId": "1a0b7f285dbe0f2fcfc93ae8", "aaaManaged": true }, { "groupId": "5701c72cd07fc27bd9ea6eb2", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "velit ut aute exercitation" }, { "roleId": "dolore Lorem ex magna enim" }, { "roleId": "et" }, { "roleId": "dolor Ut amet cillum" }, { "roleId": "velit" } ], "inactive": false, "_meta": { "created": "1956-09-05T09:50:30.084Z", "updated": "1985-11-21T10:48:09.237Z", "migrationVersion": -71656668 } }, { "_id": "e1fff8dc2b4470ff86564af6", "provenance": "laborum", "name": "mollit aliquip exercitation", "description": "enim Duis do", "memberOf": [ { "groupId": "30badcd0fd4c89f43afda0f9", "aaaManaged": true }, { "groupId": "f5162344f15dcf8e4ee6439c", "aaaManaged": false }, { "groupId": "5cd48a6adaefb44e96b67860", "aaaManaged": false }, { "groupId": "6a3433c92197f60a2c212ec9", "aaaManaged": true }, { "groupId": "7673af2a0a638a8d7ab6944d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "minim adipisicing id mollit" } ], "inactive": false, "_meta": { "created": "1978-04-05T15:35:58.827Z", "updated": "1955-07-30T06:53:08.548Z", "migrationVersion": -28781362 } }, "6e4ba4b231c7145412c733f7", "default" ], "iterations": [ "ABe44F50-8c2b-4CFf-aaA0-48CcBeB90871" ], "x": -5564946.020647183, "y": 37273377.78408247, "gridCoordinate": { "x": -59517359.43357433, "y": -55492038.766213 }, "name": "non ea sit", "location": "Broker", "locationType": "aliquip ea", "app": "in tempor proident dolore esse", "canvasName": "consequat commodo et ut", "displayName": "non", "summary": "deserunt ad anim aliquip nulla", "description": "nostrud", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/k1DP0vj/~0/bJ3X5y/r/qJ4lt2gq7/Qyanf/uunE3iMb/~1/~1" }, { "type": "encryption", "pointer": "/n8D/l8xdK/QS3" }, { "type": "encryption", "pointer": "/D77l9vPvw4K/gU2cu/xSdz/~0/~0" }, { "type": "encryption", "pointer": "/rBhzsfDh0r+/~0/~0/DN.7bsK/~1/~1/FrzZAxD2ZW/WV9Av" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "sed pariatur incididunt ad", "highlightString": "Lorem tempor pariatur" }, { "key": "ex incididunt ut et", "highlightString": "ipsum Ut labore eiusmod" }, { "key": "nostrud aute eu Ut", "highlightString": "dolore officia quis" }, { "key": "qui ex veniam aute", "highlightString": "in Duis nulla dolor laboris" }, { "key": "esse Ut", "highlightString": "fugiat velit" } ], "status": "scheduled", "previous": { "incomplete": [ "e28f", "workflow_end", "e28f", "e28f", "workflow_start" ], "complete": [ "workflow_start", "error_handler", "workflow_end", "workflow_start" ], "error": [ "e28f" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "e28f", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "standard" } ] }, "serverId": "Ut commodo", "start_time": "1972-02-13T23:22:59.152Z", "end_time": -78512749.75397687, "finish_state": "success", "retrySettings": null, "type": "automatic" } }, "parent": { "job": "enim Ut esse dolore culpa", "task": "amet ea", "iteration": -80845914.91776977, "element": -27015898.396289065 }, "errorHandler": { "actor": "job", "groups": [ "39d0f71d3940c5f34bcbf5d2", "default", "default" ], "iterations": [ "F8F5Da2d-A0D1-88Ab-FfE6-e2C03d4BCfD4", "ccB88228-E0EF-C1aA-DA61-F8BbaFFb6A28" ], "x": 65182630.49243331, "y": 7890563.604739949, "gridCoordinate": { "x": 52514766.1312584, "y": 82135739.3831445 }, "name": "laboris dolore", "location": "Broker", "locationType": null, "app": "ullamco consequat aliquip culpa occaecat", "canvasName": "non ad dolor est irure", "displayName": "laboris nulla", "summary": "aliqua", "description": "amet nisi nostrud", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~1/vl/~0/~0/a/A/~0/Ckrkh-5z." }, { "type": "encryption", "pointer": "/~1/~1/O8Ld/~1/e.+dXSTE./at8hINWEF/~1/hzfOsvSka/~0/~0/FGk" }, { "type": "encryption", "pointer": "/PMuF9B/zIfMDWM0Q3a/~0/UDh" }, { "type": "encryption", "pointer": "/~1/~1/fmLzRU/SD" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "amet est in dolor", "highlightString": "esse ea" }, { "key": "ut Ut id", "highlightString": "reprehenderit exercitation ad magna" } ], "status": "complete", "previous": { "incomplete": [ "e28f" ], "complete": [ "workflow_end" ], "error": [ "3a1f", "workflow_end", "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_end", "type": "standard" }, { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "standard" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "consequat enim", "start_time": "1999-04-27T09:05:30.892Z", "end_time": 87444677.41221622, "finish_state": "failure", "retrySettings": null, "type": "automatic" }, "groups": [ "b2e8bdcdc706bd22455b43e9", { "_id": "95750004fcd30766b3833418", "provenance": "aute irure in", "name": "veniam", "description": "veniam culpa proident sint fugiat", "memberOf": [ { "groupId": "5d93c0be943eaa9a73f5bb86", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consequat officia commodo" }, { "roleId": "ipsum" }, { "roleId": "dolore nostrud quis" }, { "roleId": "officia occaecat nostrud qui ullamco" }, { "roleId": "nulla" } ], "inactive": false, "_meta": { "created": "1952-04-30T13:23:50.852Z", "updated": "1994-11-26T01:25:11.334Z", "migrationVersion": -9859658 } }, "default" ], "watchers": [ "Pronghorn", { "_id": "411a84e3359b3eba67a3cd7c", "provenance": "id", "username": "ipsum minim", "firstname": "aliqua", "memberOf": [ { "groupId": "f123fa07593eff5de1a0d27f", "aaaManaged": true }, { "groupId": "fa2f6d4bba66449bc2ec1d78", "aaaManaged": true }, { "groupId": "79144498b38d2a7e13a51298", "aaaManaged": true }, { "groupId": "93899ccfaa7d9acb99514f61", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eiusmod" }, { "roleId": "dolore Excepteur" }, { "roleId": "dolor Lorem dolore reprehenderit" }, { "roleId": "mollit fugiat sint" } ], "inactive": true, "lastLogin": "1993-03-02T16:34:08.16Z", "_meta": { "created": "1947-12-22T19:26:16.792Z", "updated": "2015-04-30T04:54:52.876Z", "migrationVersion": 51275733 }, "email": "quis dolor" }, "Pronghorn", "Pronghorn" ], "metrics": { "start_time": 95233310.68256277, "progress": 0.8852279267586753, "end_time": 68605871.18736863, "user": "44057b347db55445a70f56a4", "owner": "78b13ecf8af01ea1d980b89e" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }