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": "9df08bca6bfa92a954b9ced8", "font_size": -32278720, "type": "resource:action", "created": "1959-09-13T10:08:27.13Z", "last_updated": "1960-07-15T03:45:18.161Z", "createdVersion": "601.92634134337.2775948717-9610.0.4797327147.45839606133", "lastUpdatedVersion": "644765.39230.260532570-4294.92811.60145", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": 38350240, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 68759593.1244331, "sla": 13973637.172224954, "decorators": [ { "type": "encryption", "pointer": "/~0/pnNBAuBFm8/KxQ-/oPFK,DHMqH" }, { "type": "encryption", "pointer": "/bs-W/ARiF3F/iKbi/~0" }, { "type": "encryption", "pointer": "/ABe88g86/inqPgTHHUWc/PxV-9/AQwQPZ/~1/~0/asQ/s6b5xLk" } ], "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 } ], "warnings": [ { "task": "error_handler", "name": "myCoolDocumentName", "message": "aliqua Lorem" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "elit Excepteur aliquip aute" } ], "ancestors": null, "validationErrors": [ { "keyword": "fugiat officia non cillum amet", "instancePath": "aliqua aute culpa", "schemaPath": "ipsum qui", "message": "magna aliquip ipsum fugiat" }, { "keyword": "minim Excepteur est do", "instancePath": "adipisicing Excepteur", "schemaPath": "nulla", "message": "sint ullamco occaecat" }, { "keyword": "Excepteur enim mollit aute sed", "instancePath": "deserunt", "schemaPath": "qui velit", "message": "ea est labore nostrud" }, { "keyword": "ut", "instancePath": "nisi in aliqua", "schemaPath": "enim do dolore fugiat", "message": "minim in reprehenderit" } ], "created_by": "596881d8d37fda2427069bac", "last_updated_by": "Pronghorn", "tasks": { "5": { "x": 78065515.92894801, "y": 45859285.40844503, "gridCoordinate": { "x": 85488687.58057737, "y": 99153460.49764845 }, "name": "voluptate dolor tempor est", "location": "Application", "locationType": "officia ea", "app": "Excepteur mollit", "canvasName": "ut labore ex", "displayName": "non", "summary": "exercitation", "description": "pariatur in sit eiusmod reprehenderit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/UOgfqYLjWzH" }, { "type": "encryption", "pointer": "/yhRuIfKT969/z-Rokf,/fHL/AujViD" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "Duis dolore", "highlightString": "enim amet commodo" } ], "status": "incomplete", "previous": { "incomplete": [ "e28f" ], "complete": [ "workflow_start", "workflow_end", "3a1f", "workflow_start", "e28f" ], "error": [ "workflow_end", "workflow_end", "e28f" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "workflow_end", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "standard" } ], "error": [ { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "standard" } ] }, "serverId": "labore nisi est", "start_time": "1970-04-18T20:06:46.62Z", "end_time": -2599931.562977582, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default", { "_id": "9ea3e49fa335ea92f9a0a27b", "provenance": "ad nulla quis ex", "name": "fugiat ex Lorem dolore", "description": "eiusmod", "memberOf": [ { "groupId": "1fd61d4f98993bf6e327e7b2", "aaaManaged": true }, { "groupId": "4049d4cc136006a4ff44698a", "aaaManaged": true }, { "groupId": "f0d2337ab25d9bae9122b5d3", "aaaManaged": true }, { "groupId": "2bfe71c0e4dc45392f63b762", "aaaManaged": false }, { "groupId": "9a43a61a24bf12edf9e6c38f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "id aute est" } ], "inactive": false, "_meta": { "created": "2005-03-31T15:09:33.388Z", "updated": "1950-11-30T07:28:39.946Z", "migrationVersion": -64574278 } } ], "iterations": [ "3953d324-340c-e5cC-000d-bCB1B0ff53a5", "A26246BE-1C79-F403-6aF4-D9fC3A9aEe36", "dD1a096D-1664-6aa4-0aE6-D74eFB2AaafF" ] }, "workflow_start": { "x": -62094845.585436076, "y": 74180513.32194778, "gridCoordinate": { "x": -91438383.21242952, "y": 73540646.73390129 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -69858076.64088127, "finish_state": "success", "user": "Pronghorn" }, "groups": [ { "_id": "af929cee1dae1df9be6d7df9", "provenance": "sed", "name": "sint", "description": "amet ad non ut", "memberOf": [ { "groupId": "744adb622efe8b8a72b886d5", "aaaManaged": true }, { "groupId": "a94f618ce257fa6970dfc144", "aaaManaged": true }, { "groupId": "01a59246669c51079627a35c", "aaaManaged": false }, { "groupId": "1894911925eb2ae3bbe7e430", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aute dolor" }, { "roleId": "consectetur deserunt Lorem" }, { "roleId": "ut Ut tempor aute voluptate" }, { "roleId": "esse cupidatat" }, { "roleId": "occaecat consequat" } ], "inactive": true, "_meta": { "created": "2017-11-27T07:31:33.529Z", "updated": "1990-09-15T07:01:56.608Z", "migrationVersion": -73457007 } }, "94932bb0a9c744c622c30653" ], "iterations": [ "aD8f457A-fc3E-5557-BBC2-cb4a79EaAE3f", "D14e3BC9-53cc-c4c3-31b0-F9F4001f0eFa" ] }, "workflow_end": { "x": -7319217.641593844, "y": 75593688.89558336, "gridCoordinate": { "x": -71434625.36955547, "y": 6852896.064908713 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "e28f", "workflow_start", "3a1f", "workflow_start", "workflow_start" ], "complete": [ "error_handler", "workflow_start", "workflow_start", "error_handler", "workflow_start" ], "error": [ "3a1f", "workflow_start" ] }, "metrics": { "end_time": 68309933.63703817, "run_time": 63735629.57153052 }, "groups": [ "default", { "_id": "c0a6bc7dbed0c5641d5d27b5", "provenance": "in sed proident reprehenderit", "name": "officia tempor irure occaecat sunt", "description": "cillum ullamco reprehenderit ea", "memberOf": [ { "groupId": "bb4f0b76906553d10aec2194", "aaaManaged": false }, { "groupId": "f050ac571a19d59263052a0e", "aaaManaged": false }, { "groupId": "4ec567484e7cfcc679cd8dfc", "aaaManaged": false }, { "groupId": "80eafc559f1d739cbb0caa9b", "aaaManaged": true }, { "groupId": "c311416d470a1c7bab810009", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sint" } ], "inactive": true, "_meta": { "created": "1977-12-19T20:28:18.368Z", "updated": "1992-07-12T16:48:09.6Z", "migrationVersion": 85838512 } }, "default" ], "iterations": [ "a1dEC90C-10Fc-6426-E777-d8649c12CF3b", "5C1a779E-6bD4-140c-dbBA-3EE83Cc5CBEb" ] }, "error_handler": { "x": 96058882.86007479, "y": -80420466.30929613, "gridCoordinate": { "x": -87894829.30505468, "y": -55718560.59026068 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "officia ut aliquip", "canvasName": "do in laboris ea in", "displayName": "tempor", "summary": "nostrud", "description": "veniam amet aliqua et eiusmod", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/x+wpLB/~0/~1/m5fvx/Y/~0/kLtSY" }, { "type": "encryption", "pointer": "/~1/~1/LcQtf23M/Jbn/D1Ywrt/cmyc0j/~0/j/NbmO+NLnnB/~1" }, { "type": "encryption", "pointer": "/~0/gPww/~0" }, { "type": "encryption", "pointer": "/h.GaI9.E/e-YDlNwVlt/cf/f5QvX2/~1/k13gu/~0/~0/pPq/ejsE" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "labore", "highlightString": "magna" }, { "key": "aliqua sed", "highlightString": "dolor" }, { "key": "occaecat adipisicing", "highlightString": "fugiat mollit voluptate culpa" }, { "key": "Ut sed laboris nulla in", "highlightString": "culpa laborum et eiusmod pariatur" }, { "key": "in ea in in", "highlightString": "Lorem culpa ipsum" } ], "status": "running", "previous": { "incomplete": [ "workflow_start", "workflow_end", "workflow_start" ], "complete": [ "workflow_start" ], "error": [ "workflow_end" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "error_handler", "type": "loop" } ], "failure": [ { "task": "error_handler", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "standard" } ] }, "serverId": "eiusmod", "start_time": "2017-01-08T12:25:54.198Z", "end_time": -70368568.36710119, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": { "_id": "07a0215860fe231ce9c1c5ed", "provenance": "exercitation tempor sint", "username": "esse", "firstname": "adipisicing", "memberOf": [ { "groupId": "ead5d63f935b48d27d94a099", "aaaManaged": true }, { "groupId": "887f1a7ca16d80d2aaba7502", "aaaManaged": true }, { "groupId": "dd7bd0665a920d5439917b18", "aaaManaged": false }, { "groupId": "c76caf3af75f5f0ae85b1bba", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ut enim nisi dolore" } ], "inactive": true, "lastLogin": "1959-10-19T15:55:50.063Z", "_meta": { "created": "1955-07-31T19:12:23.803Z", "updated": "1986-03-13T02:37:12.013Z", "migrationVersion": 72663385 }, "email": "esse" }, "groups": [ { "_id": "f8295ccc4764a87524eb10ca", "provenance": "voluptate ex", "name": "ut minim pariatur sit", "description": "irure pariatur consectetur", "memberOf": [ { "groupId": "dc709b65f2a310ffe83cceda", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "labore elit laborum cillum" } ], "inactive": true, "_meta": { "created": "1945-06-11T22:41:01.871Z", "updated": "1974-04-28T02:20:38.89Z", "migrationVersion": -52213665 } }, "default", { "_id": "92bcebdf228c5aef3b076a8a", "provenance": "Ut labore occaecat pariatur in", "name": "qui", "description": "labore deserunt Excepteur nulla", "memberOf": [ { "groupId": "35a9b9dc80e2655886d2fe3f", "aaaManaged": true }, { "groupId": "5ef02e9aa39c539c1f1c473b", "aaaManaged": true }, { "groupId": "ac5d3cd4cf0b73eb883d0fcf", "aaaManaged": true }, { "groupId": "55020847dcdde7f8eb77e955", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cupidatat Excepteur anim nisi" }, { "roleId": "laborum aute" }, { "roleId": "aute labore ut" } ], "inactive": true, "_meta": { "created": "1947-01-11T20:02:25.047Z", "updated": "1981-12-25T16:44:28.341Z", "migrationVersion": 48346011 } }, "default" ], "iterations": [ "cBC490DF-1D8d-Bec2-ebFB-53fdfeFfdC75", "A4FBaB98-65a9-df46-CAAD-fAb1daaB85d0" ] } }, "parent": { "task": "Duis eiusmod dolor et", "iteration": -79893607.61014104, "element": 91414708.92130464 }, "errorHandler": { "x": -23537792.113078207, "y": 48914457.52834919, "gridCoordinate": { "x": -87561981.2932491, "y": 54335100.91942716 }, "name": "sunt laborum", "location": "Adapter", "locationType": "dolore cupidatat ipsum ullamco velit", "app": "dolor non consequat fugiat", "canvasName": "ipsum", "displayName": "cillum sit occaecat proident", "summary": "ex", "description": "eu aute", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/zAWH3eX+HX0/~1/hF/7/~0/k0T4zQlBrt" }, { "type": "encryption", "pointer": "/W/~0/Lz/F/~0" }, { "type": "encryption", "pointer": "/~0/~1/TLCzCh/~1/~0/LC/etAtz5pzbN/~0/G+B.Hp/j0Sa/AWKv.RzQE" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "qui", "highlightString": "Duis" }, { "key": "irure nostrud pariatur", "highlightString": "dolore dolore enim ut anim" }, { "key": "esse fugiat ad", "highlightString": "ut nostrud sint" } ], "status": "failure", "previous": { "incomplete": [ "workflow_start" ], "complete": [ "workflow_end", "e28f" ], "error": [ "workflow_start", "e28f", "e28f", "workflow_end", "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "loop" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "error_handler", "type": "standard" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_end", "type": "standard" } ] }, "serverId": "consequat esse", "start_time": "2006-05-21T06:23:45.782Z", "end_time": 5291093.027668968, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": { "_id": "51b10bcf0ddffa85384652ae", "provenance": "et aute quis ut", "username": "qui quis", "firstname": "veniam", "memberOf": [ { "groupId": "82496e12ee645439f1bbd6db", "aaaManaged": true }, { "groupId": "0769fbdd9136f7ea23152eb7", "aaaManaged": true }, { "groupId": "282c16895fc2396023de1c13", "aaaManaged": true }, { "groupId": "4ac9cae7705a840007067a68", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "est et nostrud quis mollit" }, { "roleId": "Duis" }, { "roleId": "magna consequat" } ], "inactive": true, "lastLogin": "1947-02-23T21:18:25.142Z", "_meta": { "created": "1974-07-30T10:19:17.586Z", "updated": "1951-02-25T14:10:12.324Z", "migrationVersion": -40384794 }, "email": "mollit labore et magna non" }, "groups": [ { "_id": "63a1a1ddfa8556cdcc1e9858", "provenance": "consequat id aliqua", "name": "cillum et esse", "description": "est", "memberOf": [ { "groupId": "df3397301c9669230dd31db9", "aaaManaged": false }, { "groupId": "2d8330e0cd87c662535481b2", "aaaManaged": true }, { "groupId": "53e420233c838b0915097a7a", "aaaManaged": true }, { "groupId": "15c2e551fd2b57608ffca0d9", "aaaManaged": true }, { "groupId": "4871ab125fda08a4d284f0a4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "incididunt sunt cillum" }, { "roleId": "et esse elit proident" }, { "roleId": "ut sit eu culpa" } ], "inactive": true, "_meta": { "created": "1974-12-06T17:12:24.71Z", "updated": "2021-07-26T01:24:32.647Z", "migrationVersion": -63171285 } }, "default", "default", "088be7c47a83986f7d6b32f6" ], "iterations": [ "fa7de440-EA44-DbD2-11D5-A50baB988b59", "6f7cBede-2A26-8Ba2-db2c-d9F6bc50bba5" ] }, "groups": [ "default", "2e0dafad719499ac8552ab43" ], "watchers": [ null, { "_id": "d21021277b0f301ea738c1a2", "provenance": "in ut", "username": "cillum", "firstname": "dolore", "memberOf": [ { "groupId": "dd957daa90a9ec287609dd32", "aaaManaged": false }, { "groupId": "f5aefeece9accd545686f801", "aaaManaged": false }, { "groupId": "075ed494f09e44394b9f9c2e", "aaaManaged": false }, { "groupId": "7b985b9dda81e80867ce8e81", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sint" }, { "roleId": "nostrud ipsum cillum Excepteur" }, { "roleId": "eu veniam aliqua fugiat dolore" }, { "roleId": "exercitation Excepteur nulla qui" }, { "roleId": "enim Excepteur" } ], "inactive": true, "lastLogin": "1991-07-24T12:20:34.278Z", "_meta": { "created": "1947-01-29T22:35:35.206Z", "updated": "1954-01-02T14:34:30.641Z", "migrationVersion": -98102662 }, "email": "esse minim Lorem" }, "41c309b7cb7cdb0e77381414", null, null ], "metrics": { "start_time": 80869442.61484322, "progress": 0.22215220994612772, "end_time": 4813628.141836986, "user": null, "owner": "Pronghorn" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }