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": "43e15338bef861da6b748341", "font_size": -96061174, "type": "resource:action", "created": "1976-10-24T18:12:39.767Z", "last_updated": "1973-05-01T05:25:44.925Z", "createdVersion": "8134.617.9428981265-7301.703521.5", "lastUpdatedVersion": "6.9382121.58", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": -75654251, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 77015607.51113918, "sla": -52936809.0970487, "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~1" }, { "type": "encryption", "pointer": "/~0/~0/~1/~1/nKyfeI-5hep" }, { "type": "encryption", "pointer": "/dtDRsIrl/zz61XV/VVn/~1/~0/Umbn/ScLFmzSSE/~0" } ], "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 } ], "warnings": [ { "task": "error_handler", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "enim fugiat officia" }, { "task": "workflow_start", "name": "myCoolDocumentName" } ], "ancestors": [ "63bd44a0ef0f0c48491b6372", "71235e5019b96268d6fe26e7", "526c832705b608e9cdab46f7", "9b20d33ec1abe02d6002c928" ], "validationErrors": [ { "keyword": "Lorem", "dataPath": "in", "schemaPath": "esse quis dolore deserunt", "message": "eu eiusmod cillum exercitation" } ], "created_by": { "_id": "6c36165cb10db10ae3c14084", "provenance": "aute", "username": "magna cupidatat consequat ut aute", "firstname": "dolor", "memberOf": [ { "groupId": "748052c1ec748b8e837f4c08", "aaaManaged": false }, { "groupId": "8d41e6b6dbf90c657fdd80ca", "aaaManaged": true }, { "groupId": "34e24d7ec3fbe927660d7888", "aaaManaged": false }, { "groupId": "d0b52c926f50ab1b600d9f10", "aaaManaged": false }, { "groupId": "9c8979405b1ed673b238944b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laboris ea nostrud irure" } ], "inactive": false, "lastLogin": "1954-06-24T15:08:08.756Z", "_meta": { "created": "2014-10-26T08:36:42.168Z", "updated": "1993-05-16T17:35:14.759Z", "migrationVersion": -65234413 }, "email": "anim elit proident eu aliquip" }, "last_updated_by": { "_id": "0490d93bd9270479a476c43e", "provenance": "id", "username": "aliqua dolor dolore eu", "firstname": "mollit magna ut officia ullamco", "memberOf": [ { "groupId": "e43d39062e07ed31e36544ea", "aaaManaged": true }, { "groupId": "8239f592c07256bae42152fd", "aaaManaged": false }, { "groupId": "2089c67f3655e603fa7be44f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consectetur quis" }, { "roleId": "Ut officia et commodo" } ], "inactive": true, "lastLogin": "2002-06-01T22:38:14.96Z", "_meta": { "created": "1972-07-27T18:20:40.74Z", "updated": "2004-10-31T02:39:30.836Z", "migrationVersion": -92171076 }, "email": "do" }, "tasks": { "2": { "actor": "job", "groups": [ "42db41350291a329fec81914" ], "iterations": [ "A6DA9827-66e3-fC5D-258B-C8cbBA03fC72" ], "x": -96701969.3222745, "y": -76074346.01711112, "gridCoordinate": { "x": -35919781.462990485, "y": 56327124.000180274 }, "name": "pending", "summary": "cupidatat consequat magna", "description": "cupidatat aliqua ullamco qui voluptate" }, "workflow_start": { "x": 44691926.86306447, "y": 28891565.856044516, "gridCoordinate": { "x": -92043055.6594213, "y": -61286454.03375334 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -88468895.9332942, "finish_state": "error", "user": "47d583b66581c8353b448b63" }, "groups": [ "b4e5176b7f5fa109940129a8", "351d3cbbbbce449559f11e3b", "8dbe9c743fd15228fa0a7392", "b052c242c13e4383ba921d1a" ], "iterations": [ "aEb37cD5-8e49-e64d-AD5b-CbB4f1C8bBBF", "533CfCAD-319E-fBDe-6CEE-3fF1F6FCF184" ] }, "workflow_end": { "x": -71562600.15945293, "y": 18780354.026593, "gridCoordinate": { "x": -16264622.57316263, "y": -1536834.9866622835 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "workflow_end", "e28f", "workflow_end" ], "complete": [ "3a1f" ], "error": [ "e28f" ] }, "metrics": { "end_time": 990449.3503997773, "run_time": 64984302.987872005 }, "groups": [ { "_id": "838e099206cbcfc242f49d9a", "provenance": "consectetur", "name": "veniam in", "description": "est", "memberOf": [ { "groupId": "6ab94fe9655fed535003df78", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Excepteur" }, { "roleId": "minim" } ], "inactive": false, "_meta": { "created": "1996-01-10T22:55:24.788Z", "updated": "2008-01-09T18:28:39.72Z", "migrationVersion": -10069678 } }, "default", { "_id": "f3ae1092ffb5712033237d05", "provenance": "eu et Duis", "name": "ad", "description": "id laborum sed", "memberOf": [ { "groupId": "2d868cea272a1cae7e6fd8d3", "aaaManaged": false }, { "groupId": "70960cbc2afbba63a0d5a037", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "voluptate laboris nisi dolore dolor" }, { "roleId": "aute occaecat" }, { "roleId": "ullamco sint qui" } ], "inactive": true, "_meta": { "created": "2009-10-16T13:03:16.927Z", "updated": "1976-11-20T19:28:12.574Z", "migrationVersion": -31465627 } }, { "_id": "3013a9f2f3cf500b45e1b435", "provenance": "et est dolor occaecat", "name": "Excepteur laborum incididunt est cupidatat", "description": "reprehenderit", "memberOf": [ { "groupId": "e774377ca7cd768f128a7c5d", "aaaManaged": false }, { "groupId": "25e55a6f226aece7d08473b2", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "qui Ut irure" }, { "roleId": "ut culpa ad Lorem reprehenderit" }, { "roleId": "ipsum" }, { "roleId": "occaecat aute enim deserunt et" }, { "roleId": "sunt" } ], "inactive": true, "_meta": { "created": "1967-01-14T00:30:09.181Z", "updated": "1974-06-20T07:56:50.891Z", "migrationVersion": 37065285 } } ], "iterations": [ "760490be-eaaB-f87C-dB4D-6F29BF74D4B1", "F4fcDfEe-53BD-c94E-fC1a-0b0c8Adff9CF" ] }, "error_handler": { "x": 19445417.737359345, "y": -23364527.70747663, "gridCoordinate": { "x": -92100424.84453811, "y": -16402683.18818374 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "consequat ea velit amet", "canvasName": "id sit consectetur qui anim", "displayName": "sit", "summary": "esse", "description": "dolor in occaecat enim in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/YX2Jdj/Y/Vs9K/Xs/~1/GLRzktt/D6j/qDMh4fgAdF6/W/~1/~0" }, { "type": "encryption", "pointer": "/~1/~1/~1/~1/~1" }, { "type": "encryption", "pointer": "/w/uZi/Gsvj/aj/uXuWuBE/N/JmUq" }, { "type": "encryption", "pointer": "/QpZmL7/~0/~0" }, { "type": "encryption", "pointer": "/~1/~1/~0/d/~1/BUj3nnZ/My/tbcniz/~1/l" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "ad quis", "highlightString": "nisi consectetur ad dolore" }, { "key": "nisi exercitation aute magna ipsum", "highlightString": "minim ipsum adipisicing" }, { "key": "veniam", "highlightString": "velit commodo aute reprehenderit sit" } ], "status": "scheduled", "previous": { "incomplete": [ "workflow_start", "workflow_end" ], "complete": [ "workflow_end" ], "error": [ "error_handler", "error_handler" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "loop" } ], "failure": [ { "task": "3a1f", "type": "loop" }, { "task": "e28f", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "3a1f", "type": "loop" } ] }, "serverId": "cupidatat nisi Excepteur", "start_time": "1957-01-14T14:49:36.875Z", "end_time": -13398579.354693398, "finish_state": "success", "retrySettings": { "state": [ "failure" ], "autoRetry": false, "limit": 58689622, "delay": 35901688, "count": 81350352, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ "e2a2e3a4da344ac0b1f1d215" ], "iterations": [ "8E8EC9cf-c4FB-bB26-Ec71-016EaB19FbAf", "bf1F70e1-D5Dc-ae8A-ee05-D6d1F4e467e1", "bEFb4BBF-83c2-B0db-801A-de67936bba9f" ] } }, "parent": { "job": "anim ut", "task": "mollit nulla consequat", "iteration": 49010891.92028913, "element": -31603210.143074274 }, "errorHandler": { "actor": "Pronghorn", "groups": [ "7325c83f501492cfc013d8a9", "default" ], "iterations": [ "9b104f79-1F83-2Ae0-e71c-FdeCB4CAc5dd" ], "x": 95295381.17734152, "y": 84321750.26303947, "gridCoordinate": { "x": 34066933.44772363, "y": -23552680.360500753 }, "name": "pending", "summary": "incididunt", "description": "veniam nostrud velit deserunt" }, "groups": [ "3dc70c3a6fbcdbd94620aa35", { "_id": "b0fa71f016e3f77451ad013f", "provenance": "cupidatat laboris irure ea sit", "name": "veniam tempor consectetur in", "description": "id reprehenderit Duis est ut", "memberOf": [ { "groupId": "8b4df7207f81d12b24f47352", "aaaManaged": true }, { "groupId": "01aad9adf0e259126f7f1df1", "aaaManaged": true }, { "groupId": "421ff7bd0ac2d0e14dbd300e", "aaaManaged": false }, { "groupId": "aa1cfe5b71476a2846f59c7f", "aaaManaged": true }, { "groupId": "64cf845ca456a54cd078da0c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "do aliquip sit aute" }, { "roleId": "dolor ex qui magna proident" } ], "inactive": true, "_meta": { "created": "2019-06-08T14:14:38.834Z", "updated": "2020-08-21T12:45:17.235Z", "migrationVersion": 68813989 } }, "862ba1a40eced2ab25001af1", { "_id": "3ca727c5cc5aea60f4759c17", "provenance": "anim veniam aliqua", "name": "laboris velit occaecat", "description": "velit", "memberOf": [ { "groupId": "88806bebc3075441136b0442", "aaaManaged": false }, { "groupId": "d8051e993389e7f4a48ed132", "aaaManaged": true }, { "groupId": "8e487c9830351d6d24a2f10e", "aaaManaged": false }, { "groupId": "4a8bbc8addbfbcd907c40bde", "aaaManaged": false }, { "groupId": "ff6d87bf63f73b62710e2030", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "eu dolore non culpa ut" }, { "roleId": "laboris" }, { "roleId": "incididunt" }, { "roleId": "do magna ad" } ], "inactive": false, "_meta": { "created": "2013-11-19T14:44:46.067Z", "updated": "2009-03-22T21:25:19.23Z", "migrationVersion": 82574272 } }, { "_id": "06f997038febcbd09652e481", "provenance": "aliqua occaecat eu", "name": "qui aliqua", "description": "mollit dolor aliqua", "memberOf": [ { "groupId": "ae03d862272c22fe5974e24c", "aaaManaged": false }, { "groupId": "34e622ef0da9460ce3ddae05", "aaaManaged": false }, { "groupId": "7e2fbf470ad62a457eb139f5", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nisi" }, { "roleId": "deserunt Duis sunt qui ipsum" }, { "roleId": "officia" } ], "inactive": true, "_meta": { "created": "1989-09-09T07:40:57.55Z", "updated": "1999-04-23T07:41:58.916Z", "migrationVersion": -34039129 } } ], "watchers": [ null, null, "32aa98eecc80cf1d461b9eab", "c352d179406f4bc2e1bbb2d8" ], "metrics": { "start_time": 5849185.325898394, "progress": 0.3446902451114684, "end_time": 47314414.73655447, "user": "Pronghorn", "owner": "82baba14f273b580e3dd9da8" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }