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": "10fd92c7db4fd1af98075a99", "font_size": 25279465, "type": "resource:action", "created": "1977-10-15T23:08:56.865Z", "last_updated": "2019-05-14T22:02:01.304Z", "createdVersion": "1.691.323-6537.57.497838073.3", "lastUpdatedVersion": "1667414533.5.1434755558-7145.1.339343959", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": -76604310, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 2891326.528508082, "sla": 74094983.63411099, "decorators": [ { "type": "encryption", "pointer": "/~1/Z-v+/e4y2muDJ/OBd6CL0w/WRhl73wN/Qly-mGR/~1" }, { "type": "encryption", "pointer": "/~0/dAYAPE6M7k/~1/Nn4+FqJbuI/x7wd2Z" }, { "type": "encryption", "pointer": "/K-OPXz2/oku/AS" } ], "status": "incomplete", "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": "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": "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": "workflow_start", "name": "myCoolDocumentName", "message": "mollit dolor labore id sed" }, { "task": "error_handler", "name": "myCoolDocumentName" } ], "ancestors": [ "db05e07e15bec3150227afd6", "4c672be2529e289a8bfbdc12", "78b8152d3bef0e35957dbc1d", "4b8baf3a5e0c17fb8564011f" ], "validationErrors": [ { "keyword": "laborum id", "dataPath": "reprehenderit cupidatat esse culpa", "schemaPath": "commodo", "message": "culpa" }, { "keyword": "nulla dolor aliqua Excepteur eu", "dataPath": "ullamco enim sint officia labore", "schemaPath": "in culpa voluptate cillum adipisicing", "message": "laboris" }, { "keyword": "labore", "dataPath": "in quis nulla nisi adipisicing", "schemaPath": "in aliquip enim sed fugiat", "message": "ad non" } ], "created_by": { "_id": "b32eaba035aec3efd210a6bd", "provenance": "dolore ipsum", "username": "Excepteur eu ut nostrud", "firstname": "magna in", "memberOf": [ { "groupId": "ae303152a2ece9512b870c13", "aaaManaged": true }, { "groupId": "f54d20156c367a720ce3738c", "aaaManaged": false }, { "groupId": "db8d24816a0b1790b6b7b178", "aaaManaged": true }, { "groupId": "c76c16e966c84b26a38c09e4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "esse ad nulla anim eu" }, { "roleId": "anim et cillum minim Excepteur" } ], "inactive": false, "lastLogin": "1994-05-26T13:46:41.028Z", "_meta": { "created": "1989-02-02T13:48:42.578Z", "updated": "2001-06-03T15:20:33.705Z", "migrationVersion": 63112348 }, "email": "dolor ullamco consequat" }, "last_updated_by": null, "tasks": { "workflow_start": { "x": 86319591.5016163, "y": -53233343.40597903, "gridCoordinate": { "x": 10431348.816306189, "y": 5202574.913621977 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 75451632.67670977, "finish_state": "failure", "user": null }, "groups": [ { "_id": "f7a78957a7c98667454c219f", "provenance": "sint dolor", "name": "dolor", "description": "exercitation dolore velit", "memberOf": [ { "groupId": "d447204269574084d07558d7", "aaaManaged": false }, { "groupId": "f04d4e72fbcda57cd00f403a", "aaaManaged": true }, { "groupId": "6d5561820f078aaf6b397b2a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "esse sint ad" }, { "roleId": "consequat in adipisicing officia" }, { "roleId": "incididunt" }, { "roleId": "aliquip Ut" } ], "inactive": false, "_meta": { "created": "1997-04-27T08:41:55.064Z", "updated": "1989-08-08T04:31:32.625Z", "migrationVersion": -3180703 } }, "default", "bdf0805419d329919f68913b", { "_id": "6a2ccf101cdd918a67512ca7", "provenance": "dolor", "name": "do aliquip sint nostrud", "description": "mollit Excepteur labore laborum id", "memberOf": [ { "groupId": "2bcdbe7b51de4f1161874dbf", "aaaManaged": false }, { "groupId": "64af7227392e956eff62ef8b", "aaaManaged": false }, { "groupId": "84e05dc8871b1a4302b6236d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "velit" }, { "roleId": "dolore ipsum" }, { "roleId": "cillum nostrud dolor eiusmod" }, { "roleId": "non veniam minim culpa" }, { "roleId": "esse irure dolor" } ], "inactive": true, "_meta": { "created": "1953-12-26T07:20:05.464Z", "updated": "2017-01-25T01:43:07.769Z", "migrationVersion": 43357766 } }, "default" ], "iterations": [ "dcA8e099-46Bf-f94C-0c6C-359D91F907B2", "170F57c5-B07A-792d-1a1d-2005a994D4AC" ] }, "workflow_end": { "x": 28843493.831308946, "y": 42300701.11335772, "gridCoordinate": { "x": 86903794.06100675, "y": 91761364.4354446 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "error_handler" ], "complete": [ "workflow_start" ], "error": [ "workflow_start", "e28f", "workflow_end" ] }, "metrics": { "end_time": -82347480.42860574, "run_time": -61603997.052823536 }, "groups": [ "5616a61710b6002a888ba2d4", "default", "cb5aded96d981876901effaa" ], "iterations": [] }, "error_handler": { "x": 91878849.5717859, "y": 26500916.98243253, "gridCoordinate": { "x": -72422306.2017979, "y": -27627046.486452267 }, "name": "childJob", "location": "Application", "locationType": null, "app": "ut sit sunt ipsum dolore", "canvasName": "in", "displayName": "magna pariatur labore sint ex", "summary": "laboris", "description": "quis aliquip nulla dolor", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/D/z9DxQ/RHn5ov/n/Ly/~0/sXjl+wo" }, { "type": "encryption", "pointer": "/~0/q/x0/e" }, { "type": "encryption", "pointer": "/~1/~0/mg0-/~0/~0/~1/O8g3oOYm" }, { "type": "encryption", "pointer": "/mHhVL6O/vB/llOa5/NhXt,t/Pz.jcy/P5/3/IJkFjg/~1/g2cjMH14o/~1/nHm" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "dolore in enim adipisicing cillum", "highlightString": "est" } ], "status": "canceled", "previous": { "incomplete": [ "3a1f" ], "complete": [ "e28f", "workflow_start", "e28f", "e28f", "e28f" ], "error": [ "workflow_start", "workflow_start", "workflow_end", "3a1f", "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "revert" } ], "error": [ { "task": "3a1f", "type": "loop" }, { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "revert" } ] }, "serverId": "enim ipsum aute sit commodo", "start_time": "1993-08-22T04:28:26.107Z", "end_time": 69420357.89061561, "finish_state": "success", "retrySettings": { "state": [ "failure", "error", "success", "failure", "success" ], "autoRetry": false, "limit": 50239426, "delay": 27547454, "count": 6243732, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ "cc82e0bff035c0845401a41b", "default", "9ffeee139a16c58ea7a47417", "default" ], "iterations": [ "97A4Fa3c-7f32-A2cC-B0cF-4B5fdc7F398a", "BEc328A9-ef23-95Cf-F8A3-C0B8EB1DE4BA", "4F7A6aFF-7178-BDf7-f3B5-0AAA4E27e58f" ] }, "c": { "actor": null, "groups": [ "f1bdee7163ec408f5cebe7f6" ], "iterations": [ "3AAa6FdA-d339-0fFC-2a7d-eF0C3323FaEe", "19df9A9C-74EC-0DEE-10bc-D7902aF0e49f" ], "x": -9926702.145487681, "y": 8851106.38360475, "gridCoordinate": { "x": 48368798.66271287, "y": 34776633.664441764 }, "name": "labore veniam", "location": "Adapter", "locationType": "in reprehenderit", "app": "tempor Lorem sed eiusmod ea", "canvasName": "childJob", "displayName": "adipisicing do", "summary": "sed tempor", "description": "voluptate aute eu consectetur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/zSea/sfAx2Yd/~1/~1/PQw4uCvQF1/~1/~0/BzEs6YAAZPf/~0" }, { "type": "encryption", "pointer": "/QWm2zdk/zAQND" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "mollit", "highlightString": "nostrud dolore" } ], "status": "error", "previous": { "incomplete": [ "workflow_start" ], "complete": [ "3a1f", "workflow_start", "workflow_end", "e28f" ], "error": [ "e28f" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "3a1f", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_end", "type": "standard" }, { "task": "e28f", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "loop" } ], "error": [ { "task": "e28f", "type": "loop" } ] }, "serverId": "sit cillum", "start_time": "2009-11-05T17:40:44.091Z", "end_time": -30929960.908321247, "finish_state": "error", "retrySettings": { "state": [ "failure" ], "autoRetry": false, "limit": 62464957, "delay": 56968430, "count": 31598859, "finishedRetrying": false }, "loop": { "atLeastOneComplete": true, "finishedCount": -13507635.299082741, "outgoing": [ null, "laborum aute ex", "nostrud" ] }, "childJobs": [ { "_id": "dolore Excepteur", "name": "esse sunt eiusmod consequat", "iteration": -7790565.164894804 }, { "_id": "exercitation labore", "name": "tempor", "iteration": -96524200.85457249 } ] } }, "parent": { "job": "Lorem dolor", "task": "mollit occaecat deserunt", "iteration": 21327330.91319801, "element": 89734153.13149053 }, "errorHandler": null, "groups": [ { "_id": "5d72c205c3d8814e46eea4d9", "provenance": "sit", "name": "exercitation dolor eu fugiat ut", "description": "voluptate et consectetur", "memberOf": [ { "groupId": "61fce530fa55d8c5484f77b4", "aaaManaged": false }, { "groupId": "43c01416b956f98f9ea325a8", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nisi" } ], "inactive": false, "_meta": { "created": "2020-07-01T05:00:41.182Z", "updated": "1998-04-30T08:56:55.721Z", "migrationVersion": -44180084 } }, { "_id": "2f5279aee18bf8a2fdb56a07", "provenance": "est esse ad ullamco eu", "name": "dolor", "description": "enim ad mollit in", "memberOf": [ { "groupId": "3671c9aa482a7541a5a898b8", "aaaManaged": true }, { "groupId": "bc8c90f106b24f11d0695c57", "aaaManaged": true }, { "groupId": "57d223e2fe75e2769f37f614", "aaaManaged": false }, { "groupId": "366477dab69e1b180b763b71", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eu culpa anim cillum" }, { "roleId": "nisi aute dolor laboris reprehenderit" }, { "roleId": "nisi est exercitation" }, { "roleId": "et Lorem" } ], "inactive": false, "_meta": { "created": "1967-03-16T07:30:56.309Z", "updated": "1968-06-14T21:58:35.865Z", "migrationVersion": 22709891 } } ], "watchers": [ { "_id": "2a8156c1bbcc15f3863e5c51", "provenance": "id consectetur nisi labore dolore", "username": "adipisicing consequat", "firstname": "elit", "memberOf": [ { "groupId": "52718b2386d9778d7347271d", "aaaManaged": true }, { "groupId": "73619af00f2c5b2913b62418", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "amet voluptate id" }, { "roleId": "et sit ad labore" }, { "roleId": "proident ipsum nulla sint deserunt" }, { "roleId": "ad non velit consequat" }, { "roleId": "ut qui in" } ], "inactive": false, "lastLogin": "2013-02-20T03:37:28.644Z", "_meta": { "created": "1950-05-07T02:18:42.751Z", "updated": "1952-06-28T22:49:21.832Z", "migrationVersion": -47512593 }, "email": "pariatur laboris commodo ipsum" }, "Pronghorn", null, { "_id": "31a85ba7230292bd39397d2e", "provenance": "et", "username": "cillum Ut", "firstname": "nisi sint quis", "memberOf": [ { "groupId": "53e5760089a06f823e6e815b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aute cillum quis" }, { "roleId": "aliqua" }, { "roleId": "est cupidatat amet elit eiusmod" }, { "roleId": "magna eiusmod culpa fugiat" } ], "inactive": true, "lastLogin": "1986-11-24T02:54:20.143Z", "_meta": { "created": "2015-11-13T05:28:37.955Z", "updated": "2016-09-30T04:16:11.439Z", "migrationVersion": 65380916 }, "email": "nisi" }, "Pronghorn" ], "metrics": { "start_time": -9706288.062471509, "progress": 0.10481045337252226, "end_time": -96938934.35999522, "user": { "_id": "8055373b65cfcb842afcda7d", "provenance": "Ut commodo incididunt", "username": "ut velit laborum dolor", "firstname": "occaecat", "memberOf": [ { "groupId": "06c3474ff1a07267fa9d5a45", "aaaManaged": false }, { "groupId": "54abdab766d1bb30c142095f", "aaaManaged": false }, { "groupId": "6ae6f83b53cd9d6aa0c993ae", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cupidatat in laboris mollit exercitation" }, { "roleId": "tempor pariatur" } ], "inactive": true, "lastLogin": "1979-09-02T20:35:57.028Z", "_meta": { "created": "2015-11-25T07:32:27.171Z", "updated": "2018-03-26T02:16:16.009Z", "migrationVersion": 99848534 }, "email": "nostrud in ut" }, "owner": "Pronghorn" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }