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": "db5b5ba607719918da6fdc8f", "font_size": 41693396, "type": "automation", "created": "2004-07-31T20:05:22.795Z", "last_updated": "1976-11-08T07:29:15.023Z", "createdVersion": "21276047.465600.48755334-8351.4877.4929809.6195166744", "lastUpdatedVersion": "6347513625.7891663.3283611346-5139.839842.6", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 94181764, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -94629990.77754386, "sla": 21962604.64976065, "decorators": [ { "type": "encryption", "pointer": "/JbBE0Du/r/~1/~0" }, { "type": "encryption", "pointer": "/e/6ZddMX2Ec/~1/QoymuhuvqnS/~0/dVNFUtce1/~0/ed/~0/~0/Ee" }, { "type": "encryption", "pointer": "/~0/~0/h+pI3./4JX/~0/~1/~1/ji+quz2/eHs.JOEO3/N" } ], "status": "complete", "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": "workflow_start", "name": "myCoolDocumentName" }, { "task": "e28f", "name": "myCoolDocumentName", "message": "esse dolore" } ], "ancestors": [ "8670b51ba3c97d227a6cdc02", "73dc2b121caf6cd322720073", "c99a5e3646a7545679d5276e", "14d46b9c4b6946645e22bdbe" ], "validationErrors": [ { "keyword": "eu aliqua", "dataPath": "sint in", "schemaPath": "Duis deserunt", "message": "occaecat ut dolore" }, { "keyword": "occaecat sed ex Excepteur do", "dataPath": "ipsum eiusmod officia ea", "schemaPath": "laboris labore reprehenderit", "message": "sed sit Duis laboris non" }, { "keyword": "consequat anim", "dataPath": "aute exercitation est Ut", "schemaPath": "non ut", "message": "in proident ea" }, { "keyword": "sit ullamco proident dolor", "dataPath": "eiusmod anim ea", "schemaPath": "sint", "message": "sed" } ], "created_by": "ef6fcd2ccf2dd5d1ffe2eb5d", "last_updated_by": { "_id": "abd796a2040836a1baff9b8e", "provenance": "Duis labore", "username": "enim eu nostrud nisi", "firstname": "consequat veniam dolor", "memberOf": [ { "groupId": "3f08701ac2958afe8bd6c033", "aaaManaged": false }, { "groupId": "9a722316c481233baeac7f9c", "aaaManaged": true }, { "groupId": "50a6abd8f52cc8fb4b37cf2a", "aaaManaged": false }, { "groupId": "4db2fcc44a93be2225b1ee82", "aaaManaged": false }, { "groupId": "517805e8ac568271cc300f81", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "est occaecat aute labore quis" } ], "inactive": true, "lastLogin": "1988-06-29T06:41:32.756Z", "_meta": { "created": "1990-04-20T19:02:10.681Z", "updated": "2025-03-31T06:29:55.928Z", "migrationVersion": -40297884 }, "email": "voluptate adipisicing eu quis" }, "tasks": { "workflow_start": { "x": 65559126.31299195, "y": -18002967.769565895, "gridCoordinate": { "x": 62315245.89225227, "y": -39722180.326177314 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -63866962.95279681, "finish_state": "failure", "user": "Pronghorn" }, "groups": [ "674e6c4b389e80ffb008f8bf" ], "iterations": [ "FAF87377-d328-BB52-AC91-7f04AfEb8DdA", "87abcA84-AAec-5D63-0B0B-Fc9eAf1E1c4a" ] }, "workflow_end": { "x": -72702334.57633384, "y": -29244468.486033216, "gridCoordinate": { "x": -92082409.1963897, "y": -39695720.75394891 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "3a1f", "workflow_start" ], "complete": [ "3a1f", "3a1f", "workflow_start", "workflow_start", "error_handler" ], "error": [ "error_handler", "error_handler", "e28f", "workflow_start", "workflow_start" ] }, "metrics": { "end_time": -13349427.438229218, "run_time": -90341435.65053748 }, "groups": [ "default", "0e34bbb2b125f2722e6d0bee", "default", "b6bd897c777942ef08352e45", { "_id": "fd54ea78eaa3b6864cc71d24", "provenance": "mollit sint Excepteur", "name": "in ut ea proident", "description": "occaecat", "memberOf": [ { "groupId": "f161bf14d49613dc3aaf4ff0", "aaaManaged": true }, { "groupId": "deb752dc614eaa1baaf94374", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nulla consectetur voluptate labore" }, { "roleId": "anim ipsum sunt aliquip ex" } ], "inactive": false, "_meta": { "created": "2000-08-04T16:55:50.303Z", "updated": "1954-08-24T19:33:20.845Z", "migrationVersion": -19703011 } } ], "iterations": [] }, "error_handler": { "x": -77325928.8261583, "y": -70817598.8823362, "gridCoordinate": { "x": 79861118.05495128, "y": 95719973.64566016 }, "name": "childJob", "location": "Application", "locationType": null, "app": "do", "canvasName": "nostrud ut labore ad", "displayName": "occaecat sed", "summary": "occaecat officia", "description": "nostrud eu ad laboris laborum", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/y6C,I9m/Ia/~1/pE/K49/~0" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "elit anim veniam", "highlightString": "ut Ut sit pariatur eiusmod" }, { "key": "veniam fugiat eu cillum", "highlightString": "cupidatat pariatur aliqua" } ], "status": "failure", "previous": { "incomplete": [ "workflow_start", "workflow_start", "e28f", "error_handler" ], "complete": [ "workflow_end", "e28f", "3a1f", "workflow_end", "3a1f" ], "error": [ "workflow_start", "workflow_start", "workflow_end" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "error_handler", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "ex laboris", "start_time": "1956-04-04T17:06:28.173Z", "end_time": 39867450.55317736, "finish_state": "success", "retrySettings": { "state": [ "failure", "error", "failure", "success" ], "autoRetry": false, "limit": 10629205, "delay": 25771181, "count": 76854582, "finishedRetrying": true }, "type": "operation", "actor": "Pronghorn", "groups": [ "default", "3cc5b69a5ed1d542684a3a8d", "cc9c660a76a8f9e452205592", { "_id": "b1b1c51b84436cc079a9ebad", "provenance": "laborum deserunt", "name": "elit dolor et Excepteur minim", "description": "aliquip voluptate et Duis", "memberOf": [ { "groupId": "1aee9655e4dd195ddff43dfd", "aaaManaged": true }, { "groupId": "e2da17d4f60c4e03ef285ad0", "aaaManaged": true }, { "groupId": "5967b1281649ae2635c08095", "aaaManaged": false }, { "groupId": "83fcfb3af82ecb62511d1bb8", "aaaManaged": true }, { "groupId": "af161b6e067c225b16ce9fcc", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "et proident do Lorem nulla" } ], "inactive": false, "_meta": { "created": "2023-02-27T09:11:56.398Z", "updated": "1977-07-12T16:28:20.408Z", "migrationVersion": 96964060 } }, { "_id": "fb77e98f898040cd5ec5ea2b", "provenance": "dolor labore", "name": "laborum proident sed tempor", "description": "sit Ut consequat laboris", "memberOf": [ { "groupId": "8dd64bdf4bb216c46c1917a7", "aaaManaged": true }, { "groupId": "42f8a776fbfa3f27d2e43f44", "aaaManaged": false }, { "groupId": "eb80ccf8d4b59fc79398ee69", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aute sit" }, { "roleId": "ad" }, { "roleId": "dolor ipsum irure et occaecat" } ], "inactive": true, "_meta": { "created": "1989-07-04T11:52:00.065Z", "updated": "1988-09-24T02:07:31.358Z", "migrationVersion": -64143201 } } ], "iterations": [ "DBdA15d5-FbF8-8fBf-82F6-875aECA90349", "CbaC5EEf-dC9E-1Cea-cf08-8f8AF8bc9dDC" ] }, "e5": { "actor": "$var.job.P4z", "groups": [ { "_id": "81ac655928659db42a79aacc", "provenance": "laborum", "name": "veniam", "description": "ut culpa veniam esse dolor", "memberOf": [ { "groupId": "0fe285a2af6f8be731888ea9", "aaaManaged": false }, { "groupId": "01cd9507f2a38a9690fb0d25", "aaaManaged": true }, { "groupId": "721d9440f58d0ede3aac401e", "aaaManaged": false }, { "groupId": "d57c509338f9f22910d10380", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "pariatur aliqua sed" }, { "roleId": "mollit esse exercitation cupidatat" }, { "roleId": "exercitation Duis esse sunt" } ], "inactive": false, "_meta": { "created": "1991-03-23T02:59:06.055Z", "updated": "2001-09-08T05:42:12.358Z", "migrationVersion": 85657616 } } ], "iterations": [ "8bd22c8F-Bf5f-F4EB-47Dc-246ADF208cDb" ], "x": 29272264.474919885, "y": -35595501.577700436, "gridCoordinate": { "x": -64612200.51891452, "y": 75514941.59886271 }, "name": "qui", "location": "Broker", "locationType": "nulla elit voluptate qui cillum", "app": "in deserunt Excepteur velit mollit", "canvasName": "amet labore proident reprehenderit", "displayName": "sed dolore", "summary": "Duis et laborum", "description": "eiusmod enim esse", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/A8Fym2oHZ/~0/~1/~0" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "sed sint eiusmod", "highlightString": "officia Duis sint" }, { "key": "quis voluptate in", "highlightString": "minim eiusmod ad et veniam" }, { "key": "in", "highlightString": "reprehenderit nisi sint aute sunt" }, { "key": "deserunt aute fugiat in", "highlightString": "tempor veniam laboris deserunt" } ], "status": "error", "previous": { "incomplete": [ "e28f", "workflow_start", "workflow_start", "workflow_start", "workflow_end" ], "complete": [ "3a1f", "e28f", "workflow_start", "error_handler" ], "error": [ "workflow_end", "3a1f", "e28f" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "standard" } ], "failure": [ { "task": "e28f", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "loop" } ] }, "serverId": "in aliquip sed", "start_time": "1982-11-16T07:28:00.341Z", "end_time": 137964.77505381405, "finish_state": "failure", "retrySettings": { "state": [ "error", "error", "error", "success" ], "autoRetry": false, "limit": 71111377, "delay": 491126, "count": 71392167, "finishedRetrying": true }, "type": "automatic" } }, "parent": { "job": "sint", "task": "sunt", "iteration": 3252379.4819410145, "element": 24998696.17259942 }, "errorHandler": null, "groups": [ "24b25111e75b59fe25f5902a", "bebcf52fc9d137025cf41dae", "6205db49cffa4b70057da7bb", { "_id": "0f379693f964ef120684de06", "provenance": "reprehenderit dolore dolor voluptate et", "name": "Duis in deserunt dolore fugiat", "description": "nisi", "memberOf": [ { "groupId": "065712a7820eca71c2cbb6e1", "aaaManaged": true }, { "groupId": "30481f355e0aa9c2e9041bc8", "aaaManaged": true }, { "groupId": "83f495a9bd3fece17a9708cd", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in ullamco" }, { "roleId": "nisi cupidatat" }, { "roleId": "Excepteur aliqua" } ], "inactive": true, "_meta": { "created": "2003-10-08T17:44:28.007Z", "updated": "1958-03-17T10:14:07.788Z", "migrationVersion": -50494250 } }, "default" ], "watchers": [ null, { "_id": "e7bc5b6cc21fc8542c44c9f0", "provenance": "sunt nostrud incididunt aute", "username": "nulla", "firstname": "magna consequat", "memberOf": [ { "groupId": "9678299f0d0f23373c7b84a8", "aaaManaged": false }, { "groupId": "2cff5b1f21bab764dbc53345", "aaaManaged": true }, { "groupId": "d63085b36fb9c6d0c80d5680", "aaaManaged": false }, { "groupId": "4b0b6c102ca8b449e07e8c5c", "aaaManaged": true }, { "groupId": "cc6c2b659d5bda3d64e56867", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aliqua cupidatat" }, { "roleId": "ut aliqua adipisicing" }, { "roleId": "amet" } ], "inactive": true, "lastLogin": "1968-06-19T21:22:49.052Z", "_meta": { "created": "1961-05-07T22:43:25.2Z", "updated": "1948-12-09T13:00:52.032Z", "migrationVersion": -4064649 }, "email": "in et" }, { "_id": "ff9cf3f5723b010f507714be", "provenance": "ipsum amet aute esse", "username": "veniam", "firstname": "consequat dolore nisi consectetur", "memberOf": [ { "groupId": "f3fbcafef5839cd4cc35dc14", "aaaManaged": false }, { "groupId": "1459c0e0bece1532e05769eb", "aaaManaged": true }, { "groupId": "5825c0c54f143c31c58d0711", "aaaManaged": false }, { "groupId": "a9d9696971ca4fe24802cfdd", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris nulla" }, { "roleId": "minim aliquip do consequat in" }, { "roleId": "deserunt enim magna ad" }, { "roleId": "pariatur velit deserunt anim in" } ], "inactive": false, "lastLogin": "1973-04-14T07:21:59.911Z", "_meta": { "created": "1971-10-05T09:07:42.656Z", "updated": "1971-08-04T16:10:56.969Z", "migrationVersion": 10260786 }, "email": "nisi consectetur ullamco occaecat exercitation" }, null, null ], "metrics": { "start_time": -95781337.70399866, "progress": 0.12003106358797377, "end_time": 56039639.97240311, "user": "7d64052c566ddd57a0db33ac", "owner": "Pronghorn" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }