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": "27c5d84457cfd3b41cecdc75", "uuid": "7e99103d-a716-2d3c-8329-7667048124fc", "font_size": 26376882, "type": "resource:compliance", "created": "2012-04-04T05:09:58.989Z", "last_updated": "2016-02-24T10:44:26.727Z", "createdVersion": "719.06.11467-6060.39542.65835890280", "lastUpdatedVersion": "963.630.3065374-4351.9210877.97123.73637", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": 99572721, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 44556630.27421367, "sla": 63716756.32868436, "decorators": [ { "type": "encryption", "pointer": "/y/Ph6noo/~0/T0KN4Xew5ES/Dffefk0Rk/~1/frKByE6AA/nB0uyEn/~0" }, { "type": "encryption", "pointer": "/nwe5YnvADYZ/LIOVzNU/~0/~1/L55.qqK3y7B/~0/~1/A/~0/~0/~1" }, { "type": "encryption", "pointer": "/~1/~0" }, { "type": "encryption", "pointer": "/U4j8zi/E/~0/YIc/N0d7qTz/s6vyBOKpCu/~0" }, { "type": "encryption", "pointer": "/~0" } ], "status": "error", "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": "error_handler", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "officia culpa in cillum" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "velit" } ], "ancestors": null, "validationErrors": [ { "keyword": "ex dolore", "instancePath": "dolor esse do Excepteur", "schemaPath": "qui", "message": "dolore cillum" }, { "keyword": "proident", "instancePath": "commodo", "schemaPath": "voluptate consequat id nostrud", "message": "dolore id incididunt veniam" }, { "keyword": "enim", "instancePath": "Duis", "schemaPath": "velit", "message": "culpa et sed" } ], "created_by": { "_id": "05894f6ef2b3f9f3151f07e7", "provenance": "aliqua eu Ut velit eiusmod", "username": "anim tempor sit non", "firstname": "ullamco", "memberOf": [ { "groupId": "9d74020e5c815fb8faf104e6", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cillum" }, { "roleId": "quis anim deserunt" }, { "roleId": "consequat est dolore ipsum" }, { "roleId": "tempor sunt cupidatat magna" } ], "inactive": true, "lastLogin": "1960-12-03T22:59:45.489Z", "_meta": { "created": "2018-10-02T05:59:11.181Z", "updated": "1991-08-21T23:59:00.004Z", "migrationVersion": -18374630 }, "email": "fugiat labore ea" }, "last_updated_by": "704ddcd76847ed08dc31db12", "tasks": { "422": { "actor": null, "groups": [ "default", "1615155a8f27ea01aa47a77d" ], "iterations": [], "x": 32437673.44624789, "y": 88923754.47185615, "gridCoordinate": { "x": 73255619.92333788, "y": -63171416.61459051 }, "name": "pending", "summary": "incididunt quis ullamco amet", "description": "elit in tempor" }, "workflow_start": { "x": -53023150.72811577, "y": -58236543.68369362, "gridCoordinate": { "x": 83563501.41165331, "y": 90138164.5073455 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -94712736.05675332, "finish_state": "success", "user": "Pronghorn" }, "groups": [ "e2b5a8c08f1a13afb98b5051", "default" ], "iterations": [ "FA7bCFf2-43DB-00Ab-9C1A-953e6124DFCa", "328bF66D-eA5B-47cb-cBEE-f54e86A39771", "3Ed9Ce7B-e26B-B056-DbDB-4a9D4Fe17A44", "df91fD0F-A9aD-Dd5C-bcEa-0B202d1900A6" ] }, "workflow_end": { "x": 68965535.76004094, "y": -11488440.456614539, "gridCoordinate": { "x": -26508726.19228442, "y": -90547637.61347426 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "error_handler", "error_handler", "3a1f" ], "complete": [ "error_handler" ], "error": [ "3a1f", "workflow_end", "e28f" ] }, "metrics": { "end_time": -56022745.6510372, "run_time": -13538514.876086399 }, "groups": [ { "_id": "b8fa009a231044f18c961dd8", "provenance": "cillum laborum id", "name": "sint", "description": "deserunt laborum nulla", "memberOf": [ { "groupId": "24fd38fcebad843a9c24aabe", "aaaManaged": true }, { "groupId": "e92a811e34ff8ee8d9f85dfe", "aaaManaged": true }, { "groupId": "359fb26e1d58c91c12a484d9", "aaaManaged": true }, { "groupId": "a168ba0a4ccc0bcdcca4829d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "culpa reprehenderit" }, { "roleId": "mollit consequat reprehenderit labore pariatur" }, { "roleId": "laboris Lorem reprehenderit id" }, { "roleId": "consectetur" } ], "inactive": true, "_meta": { "created": "1985-02-24T21:42:21.569Z", "updated": "1968-06-20T15:23:49.316Z", "migrationVersion": 53024005 } }, { "_id": "3dbcc72bf030a41dcab7acbf", "provenance": "deserunt officia sint nulla", "name": "ullamco sit", "description": "fugiat ullamco", "memberOf": [ { "groupId": "93e022861cbf3b978b4257c1", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "deserunt anim dolore" }, { "roleId": "irure culpa" }, { "roleId": "dolore irure Lorem" } ], "inactive": false, "_meta": { "created": "2020-12-22T10:05:46.23Z", "updated": "2017-07-28T15:47:17.047Z", "migrationVersion": 49674384 } }, "default", "default" ], "iterations": [ "38F1EF25-F7b8-a893-365c-fC6C9CCBCC2d" ] }, "error_handler": { "x": -97161220.2531816, "y": 62813722.57461718, "gridCoordinate": { "x": 3316039.473247215, "y": 55180314.34055209 }, "name": "childJob", "location": "Broker", "locationType": null, "app": "Duis et sint proident", "canvasName": "laboris proident labore dolor", "displayName": "sunt officia laboris aliquip eiusmod", "summary": "est aute sed ullamco", "description": "nulla est voluptate Ut quis", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/WW+cfw.M/~0" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "in", "highlightString": "aliquip laborum amet tempor" }, { "key": "sit reprehenderit anim", "highlightString": "aute fugiat tempor" }, { "key": "ea laborum", "highlightString": "ea nostrud" } ], "status": "failure", "previous": { "incomplete": [ "workflow_start", "e28f", "error_handler", "workflow_end" ], "complete": [ "error_handler", "e28f", "workflow_end", "workflow_start", "error_handler" ], "error": [ "workflow_start", "workflow_start", "e28f", "e28f", "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "e28f", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "e28f", "type": "loop" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "sunt incididunt aute labore", "start_time": "1990-06-12T20:24:49.325Z", "end_time": 32335418.9884149, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": { "_id": "51f26fb0e2efe34772e8934e", "provenance": "incididunt", "username": "ad reprehenderit dolore", "firstname": "dolore fugiat", "memberOf": [ { "groupId": "f1f4fa4e71c7c55493cbafad", "aaaManaged": false }, { "groupId": "032529aeae4acfd326744b29", "aaaManaged": false }, { "groupId": "a36a668b0517a1e3c0e802f4", "aaaManaged": false }, { "groupId": "e0f2e668f21c9c79ebb50431", "aaaManaged": true }, { "groupId": "2a7d6e8b160b78976b890b61", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "deserunt" }, { "roleId": "consectetur laborum exercitation incididunt enim" }, { "roleId": "quis" }, { "roleId": "laborum" } ], "inactive": false, "lastLogin": "1961-05-26T22:49:07.544Z", "_meta": { "created": "1959-01-28T02:48:00.762Z", "updated": "1979-07-30T19:57:10.501Z", "migrationVersion": 36309932 }, "email": "officia" }, "groups": [ "default", "2c9595693e4f6846ffe829bc", "d6c6a6838cdb8acd129e2c2d" ], "iterations": [ "1B6Dd8Cd-bb4D-E5d4-6Bcb-1eBbBA1C5AD8", "E27072cc-47E4-EEa7-d37b-40ea42f7F1Fa" ] } }, "parent": { "job": "ea", "task": "cupidatat cillum dolore Lorem", "iteration": 85161809.50607643, "element": -8384889.172545806 }, "errorHandler": null, "groups": [ "default", "default", "342084f49a24016ebccf2676", "default" ], "watchers": [ "Pronghorn", "Pronghorn", "Pronghorn" ], "metrics": { "start_time": -71132187.37962468, "progress": 0.5224977318601167, "end_time": -84526760.59710713, "user": null, "owner": "Pronghorn" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }