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 retrieved search results", "data": { "_id": "8b4b00b168ccdee987bb808e", "font_size": 2139593, "type": "automation", "created": "1992-03-03T14:44:58.543Z", "last_updated": "1963-09-07T16:25:22.525Z", "createdVersion": "53339515574.75.6891116-4097.0163.091.69830397", "lastUpdatedVersion": "37596.48518230.368498-7190.74691233195.928838440.567", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": -98471144, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -95364505.05035204, "sla": -44191499.74167409, "decorators": [ { "type": "encryption", "pointer": "/rlhZOZ3/fA9-yZ" }, { "type": "encryption", "pointer": "/zExCybEcLc/~1/kSv/~0/dzDHS+ja,h/VHUD54X/RF,Cw3cePZz/oML/HC" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/nHTi" } ], "status": "complete", "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": "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 }, { "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": "e28f", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "labore exercitation est velit in" }, { "task": "e28f", "name": "myCoolDocumentName" } ], "ancestors": [ "51506fed278641afa00e1aed", "56809e4a619960aa6158a75a", "2cb215c38f0509b96ed04fcd", "6c178786eafc3edb38e9802a", "2606eab467fee325bf7ceedb" ], "validationErrors": [ { "keyword": "Excepteur voluptate ipsum elit culpa", "dataPath": "ut", "schemaPath": "enim in adipisicing", "message": "occaecat Lorem" }, { "keyword": "in", "dataPath": "eiusmod Duis dolor consectetur", "schemaPath": "minim labore qui tempor in", "message": "exercitation eiusmod incididunt" } ], "created_by": "e0f1f8a8a547cdd7cd75fa73", "last_updated_by": { "_id": "6a5b1002f19e9ef96132ac3a", "provenance": "enim do ipsum in et", "username": "magna eiusmod", "firstname": "ad ex", "memberOf": [ { "groupId": "3c37da7fe306feee994df4a1", "aaaManaged": true }, { "groupId": "463e78aa057497659514e311", "aaaManaged": false }, { "groupId": "0d95c517ad6aacd83625697c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "pariatur magna commodo in" }, { "roleId": "dolore incididunt" }, { "roleId": "consectetur" }, { "roleId": "exercitation laboris sed" }, { "roleId": "in magna esse" } ], "inactive": true, "lastLogin": "1998-07-22T00:08:20.43Z", "_meta": { "created": "1985-10-18T04:49:32.872Z", "updated": "2020-07-28T19:31:29.136Z", "migrationVersion": 43699334 }, "email": "proident consectetur" }, "tasks": { "4": { "x": -33425517.955140635, "y": 97805349.50962955, "gridCoordinate": { "x": 2749960.164554462, "y": -79791535.37777357 }, "name": "dolor nisi", "location": "Adapter", "locationType": "in sunt aute id magna", "app": "exercitation Excepteur incididunt", "canvasName": "pariatur labore consequat Excepteur nostrud", "displayName": "Lorem nostrud esse veniam", "summary": "Duis commodo occaecat non amet", "description": "exercitation nostrud consectetur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/mU/XXjUPnHroF/unv-q0+O8/Nph4yzXG-/~0/~0/~1/p2ouy2o./~0" }, { "type": "encryption", "pointer": "/ExupD,4f/~0/x4AP/dpG/iwXR+2ve7NQ" }, { "type": "encryption", "pointer": "/~0/~0/MeEE3rS7/nfbpE,/~0/~0/xUfNFs3/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "et incididunt ut", "highlightString": "laboris tempor adipisicing labore minim" }, { "key": "mollit incididunt ad Excepteur", "highlightString": "magna id elit" }, { "key": "est ullamco Excepteur", "highlightString": "deserunt incididunt aute enim" } ], "status": "failure", "previous": { "incomplete": [ "workflow_start", "error_handler" ], "complete": [ "e28f", "workflow_start" ], "error": [ "workflow_end", "workflow_start", "e28f" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "eu in magna sunt", "start_time": "1966-11-28T23:32:08.886Z", "end_time": 13329812.196937844, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default", "default", "abda6c16ae30fc693fbe08c0", { "_id": "53947f9328f1af0b05705798", "provenance": "enim sunt", "name": "culpa esse exercitation aliqua id", "description": "quis", "memberOf": [ { "groupId": "0ed9688ade98b8051ff3db89", "aaaManaged": false }, { "groupId": "44eaf82f32734ebf9c73ab1b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor Lorem in labore ipsum" } ], "inactive": true, "_meta": { "created": "1988-06-02T09:53:08.799Z", "updated": "1973-12-10T22:01:49.388Z", "migrationVersion": 47233884 } }, { "_id": "8001f2bf091ef55153473d5f", "provenance": "dolore sed sint est ullamco", "name": "do ut ut", "description": "esse occaecat exercitation", "memberOf": [ { "groupId": "961ca7db3d5ff61cdd5068d1", "aaaManaged": false }, { "groupId": "5f4f32fea502a220336cd09d", "aaaManaged": true }, { "groupId": "ae8ccb8848dfd8cb63bdfaac", "aaaManaged": false }, { "groupId": "341ac88dcf1acb1ecdfd8c75", "aaaManaged": true }, { "groupId": "6b19c343824d51f97167550c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "proident nostrud" }, { "roleId": "velit" }, { "roleId": "aliqua" } ], "inactive": false, "_meta": { "created": "1992-08-29T19:07:30.178Z", "updated": "1958-07-04T00:55:14.039Z", "migrationVersion": 21177438 } } ], "iterations": [ "51296e01-5EfD-901a-AD17-68568BACCb7D", "Db34a8f6-52BD-d1C2-11AD-463c0c35DcD5" ] }, "workflow_start": { "x": 89960972.8253496, "y": -66766820.81653626, "gridCoordinate": { "x": -21583280.861894757, "y": 57069500.77504289 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 1531739.4887816757, "finish_state": "success", "user": "9c12891e6ade5387f9c95f64" }, "groups": [ "1981dd9c589927727689939a", { "_id": "c329fc889b87d0e490ef8231", "provenance": "commodo laborum do sunt", "name": "voluptate ullamco", "description": "fugiat", "memberOf": [ { "groupId": "59d0227996fa3c89c0fc90e2", "aaaManaged": true }, { "groupId": "e8cd913fbc21e977058be15e", "aaaManaged": false }, { "groupId": "ea273a79f67c83e69f393c35", "aaaManaged": false }, { "groupId": "1d12a322790f72d68a451d81", "aaaManaged": false }, { "groupId": "aab983773e52cfa9f6560c25", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Ut" }, { "roleId": "ad sint eu labore" }, { "roleId": "nisi amet" }, { "roleId": "consectetur est" } ], "inactive": false, "_meta": { "created": "1983-08-02T22:38:27.235Z", "updated": "2020-09-20T22:29:15.012Z", "migrationVersion": -8887055 } }, { "_id": "0ba3a164858f3395e26c41aa", "provenance": "sint tempor incididunt", "name": "sed", "description": "mollit ipsum id", "memberOf": [ { "groupId": "e143fa5886d721eb8db6bbfb", "aaaManaged": true }, { "groupId": "1868230f5825941c5c91e98f", "aaaManaged": true }, { "groupId": "c9f9a95e8e88ac7c8ff4ad58", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Duis" } ], "inactive": false, "_meta": { "created": "2021-08-28T02:08:24.086Z", "updated": "2002-07-18T20:06:37.689Z", "migrationVersion": -62938785 } } ], "iterations": [ "8716Bebe-5dde-7e76-a1C2-082DabFbc25a", "2C2B4aAD-6ee9-38FE-B2B8-148BDe1eeb62", "3B1Ee6ed-E270-D1Dd-D108-9Dbfb4a04a72" ] }, "workflow_end": { "x": 57566798.580714285, "y": 16395326.518035576, "gridCoordinate": { "x": 2591848.4996243566, "y": 46187481.08954701 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "3a1f", "workflow_end", "3a1f" ], "complete": [ "workflow_start" ], "error": [ "workflow_start", "error_handler", "error_handler" ] }, "metrics": { "end_time": -66954368.50571137, "run_time": -20053601.17390938 }, "groups": [ "bc7067c07ff26e2a020ff4f7", { "_id": "e8b6241d60b85a740bc775a1", "provenance": "commodo tempor", "name": "sit ex officia aliquip sed", "description": "veniam ea velit", "memberOf": [ { "groupId": "4789779a3f340fc1e4fdc04c", "aaaManaged": true }, { "groupId": "2f39e3d59ad2c96a0622d6ca", "aaaManaged": false }, { "groupId": "5c7934e3fed814361496e882", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "qui eu" }, { "roleId": "nisi cillum dolor eiusmod" }, { "roleId": "amet adipisicing" }, { "roleId": "ullamco" }, { "roleId": "in anim dolor" } ], "inactive": false, "_meta": { "created": "2018-05-18T09:17:46.003Z", "updated": "1972-02-09T07:46:13.635Z", "migrationVersion": -38504418 } }, "95ed65acc8a862cfc89a32a8" ], "iterations": [ "01fD75Af-959c-60E6-0a41-D6bdB63aCdDE" ] }, "error_handler": { "x": 73149089.46389443, "y": -77402781.88723741, "gridCoordinate": { "x": -10339874.163121283, "y": -19113028.798341647 }, "name": "childJob", "location": "Broker", "locationType": "nostrud sunt eiusmod non aliqua", "app": "sint veniam", "canvasName": "elit aute nostrud ad deserunt", "displayName": "in", "summary": "sint eu aliquip", "description": "nisi Duis deserunt", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/MJ" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~0/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "consequat velit ut fugiat", "highlightString": "minim" }, { "key": "consectetur tempor commodo ea", "highlightString": "veniam nostrud Excepteur sed" }, { "key": "consectetur", "highlightString": "Duis sunt ut" }, { "key": "et eu nisi dolor ullamco", "highlightString": "reprehenderit quis ad nisi Ut" }, { "key": "amet aliqua ullamco", "highlightString": "occaecat" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start", "workflow_start", "3a1f", "workflow_start", "3a1f" ], "complete": [ "workflow_start" ], "error": [ "workflow_end", "e28f", "workflow_start", "e28f", "workflow_end" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "3a1f", "type": "loop" }, { "task": "error_handler", "type": "standard" } ] }, "serverId": "ipsum sit proident", "start_time": "2010-10-23T05:24:20.263Z", "end_time": -77931585.78539398, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "a9bfbbfb8a9ac9566a8bd1eb", "default" ], "iterations": [ "362A0FD2-bA3d-d51F-A322-d975ac8Dfbc7" ] } }, "parent": { "task": "laboris sint commodo ipsum", "iteration": -27108283.23092653, "element": 48165762.3103258 }, "errorHandler": { "x": 98070271.97407335, "y": 85243500.72194481, "gridCoordinate": { "x": 99133963.90697765, "y": 43649458.7196551 }, "name": "est", "location": "Adapter", "locationType": "voluptate", "app": "Excepteur dolor", "canvasName": "amet elit dolor", "displayName": "esse", "summary": "ex Lorem consequat", "description": "in enim", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/QFSk/,6V/Q/,pIsG/~0" }, { "type": "encryption", "pointer": "/~1/~0/~1/Vak2CrNM/~0/~1/~0/u0Xt,s7/t4JpFJB8+1/~0/~0" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "id sint cupidatat", "highlightString": "laborum culpa exercitation" } ], "status": "scheduled", "previous": { "incomplete": [ "workflow_start", "error_handler", "e28f", "workflow_start" ], "complete": [ "3a1f", "workflow_start", "error_handler", "workflow_start", "3a1f" ], "error": [ "error_handler", "workflow_start", "workflow_start", "workflow_end", "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "error_handler", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_end", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "loop" }, { "task": "e28f", "type": "loop" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "ullamco in exercitation", "start_time": "2015-02-07T12:53:44.019Z", "end_time": -94795454.3491615, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ { "_id": "aa67acf10541607ac517f0dd", "provenance": "sunt mollit", "name": "quis", "description": "Ut in Lorem laboris", "memberOf": [ { "groupId": "c1cb94718e424958bb0c0c78", "aaaManaged": true }, { "groupId": "0618f51bf1214d6a6f1ae8ad", "aaaManaged": false }, { "groupId": "1a672133ad9b20ac4d796989", "aaaManaged": true }, { "groupId": "d81e43f98460296fe0e44cd5", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Lorem" }, { "roleId": "veniam commodo adipisicing" }, { "roleId": "aute" }, { "roleId": "laborum aliquip sed mollit" }, { "roleId": "sint eu cupidatat in mollit" } ], "inactive": false, "_meta": { "created": "2009-05-08T14:39:27.129Z", "updated": "1964-03-18T03:22:20.702Z", "migrationVersion": -60098985 } }, "edec5787ed4cbac7e2b6e2c0", "default", { "_id": "0d6bcd8c2fdea0498a8815bd", "provenance": "in velit culpa", "name": "magna velit quis enim proident", "description": "Ut culpa officia irure sed", "memberOf": [ { "groupId": "d56cdd4f3dc9c513d5a23ec3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Duis culpa anim" }, { "roleId": "elit" }, { "roleId": "aute aliqua reprehenderit et" } ], "inactive": true, "_meta": { "created": "1968-10-01T15:07:49.584Z", "updated": "1985-06-26T03:04:39.788Z", "migrationVersion": -39281523 } } ], "iterations": [ "edd0A6C6-f83E-D1DC-4E7E-bFAb8b1bf61B", "faECD6Eb-cbcB-CE05-F9ea-E2f35dDdd34e" ] }, "groups": [ "dfd59f0a89dc89b625e8405d" ], "watchers": [ { "_id": "bf2681575e33063ce326c55a", "provenance": "laboris cillum eu in", "username": "id qui", "firstname": "magna ad aliquip", "memberOf": [ { "groupId": "ad71c319f0ac465680961498", "aaaManaged": true }, { "groupId": "562e6fb99f3b69895d94c11c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris nostrud eu pariatur id" }, { "roleId": "quis do incididunt ullamco" }, { "roleId": "sunt Lorem dolore ea" }, { "roleId": "officia non elit" }, { "roleId": "ea" } ], "inactive": false, "lastLogin": "1951-12-28T15:31:02.729Z", "_meta": { "created": "1958-08-20T10:47:06.089Z", "updated": "1978-04-03T13:14:22.398Z", "migrationVersion": 63654782 }, "email": "aliquip" }, { "_id": "abbbae1f5fd4857147e46b4f", "provenance": "deserunt in elit commodo mollit", "username": "laboris laborum commodo", "firstname": "velit consequat", "memberOf": [ { "groupId": "54457e5f2476763caebe4c4c", "aaaManaged": false }, { "groupId": "536b5b961f4325385b22ed97", "aaaManaged": true }, { "groupId": "2219364ace34373e749486f4", "aaaManaged": false }, { "groupId": "e56710b440d12de0929fc85e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor consequat" }, { "roleId": "sint" }, { "roleId": "eiusmod mollit in" }, { "roleId": "sunt id officia in" } ], "inactive": true, "lastLogin": "1957-12-21T15:00:00.446Z", "_meta": { "created": "1964-10-07T17:53:35.834Z", "updated": "1997-09-12T14:24:20.349Z", "migrationVersion": -12871337 }, "email": "consectetur sed" }, null, null, "Pronghorn" ], "metrics": { "start_time": -81382723.34165198, "progress": 0.9181890819422531, "end_time": 38724645.72657877, "user": "Pronghorn", "owner": "Pronghorn" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }