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": "f1c7c01753a91ce40d5c05ab", "font_size": 64884491, "type": "resource:action", "created": "2002-12-08T04:17:16.646Z", "last_updated": "1979-05-23T09:03:44.3Z", "createdVersion": "838633.26740929599.0755247696-7961.980773336.47611875101.7485709590", "lastUpdatedVersion": "8351.05.44232561655-3399.65.611", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": 8723436, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 50836056.992836565, "sla": 64906304.156525254, "decorators": [ { "type": "encryption", "pointer": "/KdN0/~0/UEMfLij/Q/BP/-BG2J" }, { "type": "encryption", "pointer": "/~1/tretDJ7/sUZ8f/~1/~1/~1/~0/UtLh83mv" } ], "status": "complete", "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 }, { "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": "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", "message": "Ut in non" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "consectetur adipisicing est" }, { "task": "e28f", "name": "myCoolDocumentName", "message": "consectetur" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "et irure non" } ], "ancestors": [ "2e39aa7af73d4cb505bdab06", "a969ab329f4fd2ed301f5401", "4185f4b7444e19ff17c37a5f" ], "validationErrors": [ { "keyword": "minim sint", "dataPath": "quis", "schemaPath": "adipisicing ut commodo", "message": "velit labore dolore in magna" } ], "created_by": "5b92eb8f9dfa7a078766a693", "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": 47888502.76988685, "y": 55387297.42197454, "gridCoordinate": { "x": -94978405.88049296, "y": 33544647.965922624 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -59880356.7391128, "finish_state": "error", "user": null }, "groups": [ "default", { "_id": "f1b596f072fcbce93a7bdaa7", "provenance": "occaecat pariatur", "name": "eu occaecat", "description": "voluptate", "memberOf": [ { "groupId": "15b5625261781d7845e96b96", "aaaManaged": true }, { "groupId": "72d5d7fea4d126116832ca8f", "aaaManaged": true }, { "groupId": "8d86a8944726c36af8435eb5", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ex" }, { "roleId": "voluptate Lorem dolor ex reprehenderit" } ], "inactive": true, "_meta": { "created": "2005-04-19T12:10:54.799Z", "updated": "1988-07-10T16:38:29.385Z", "migrationVersion": 56632554 } }, "default" ], "iterations": [ "a36fc70c-EeF7-eB01-9BbE-CB57046A9f7E", "e5cFca30-Caf3-e8b4-3C66-Ec2cD6125Aed", "2B3b70FC-b311-d17C-bE99-6F6b5Ff8dC2E" ] }, "workflow_end": { "x": -48446777.4022677, "y": -99679505.75060537, "gridCoordinate": { "x": -74945525.07915948, "y": 62368817.5281769 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "workflow_start", "workflow_start" ], "complete": [ "workflow_start", "e28f" ], "error": [ "workflow_start", "workflow_start", "workflow_start" ] }, "metrics": { "end_time": -42684935.90583673, "run_time": 73277503.81608841 }, "groups": [ "default", "e4f7f0a733acd752970892bb", { "_id": "edc00c5793025c3aeb96eb22", "provenance": "mollit", "name": "qui magna id sint", "description": "voluptate Excepteur", "memberOf": [ { "groupId": "9013d29629a1f467f87c33f8", "aaaManaged": false }, { "groupId": "062f6a1e60c2bc49190a6c93", "aaaManaged": false }, { "groupId": "a23955f58138510d8cd37f78", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolore dolore do" }, { "roleId": "fugiat irure veniam" }, { "roleId": "ex" } ], "inactive": true, "_meta": { "created": "1997-12-24T20:13:42.541Z", "updated": "1994-05-03T10:30:14.06Z", "migrationVersion": -76738836 } }, "default", "9c1684a10ad8784ba28f55ff" ], "iterations": [ "d4Ab0C8D-CDE5-57Ef-05d1-bC14a9804bCF", "67d2EFf4-ED3f-FA81-Eeeb-a33CEDfb98aB" ] }, "error_handler": { "x": -534079.0384082496, "y": -21388976.217405096, "gridCoordinate": { "x": -98660475.54626176, "y": -28513787.2205981 }, "name": "childJob", "location": "Adapter", "locationType": "Duis", "app": "ipsum id dolore elit", "canvasName": "amet reprehenderit ex irure", "displayName": "consectetur enim fugiat", "summary": "qui sunt laboris sit", "description": "ipsum nostrud minim ut commodo", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~0/izof9Il6Os/~0/ii55UFMrpFg/OcW" }, { "type": "encryption", "pointer": "/~0/~1/~1/kXGdz/wivv/~1/d-OlZjzv/KP.W//" }, { "type": "encryption", "pointer": "/~1/uwYvL" }, { "type": "encryption", "pointer": "/HLLspk/Z/~0/~0/ODDW2krZ/~0/e6sxsJW/i5ZmbxX+/Vz2+IO" }, { "type": "encryption", "pointer": "/JuM-M/~0/~1/~0/~1/iY.r5HI2peq/E94/~1/~0/~1" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "fugiat dolor", "highlightString": "dolor" }, { "key": "nisi", "highlightString": "esse Lorem occaecat" }, { "key": "est id ea", "highlightString": "nulla mollit elit Excepteur" }, { "key": "ea", "highlightString": "sit culpa Ut" } ], "status": "complete", "previous": { "incomplete": [ "workflow_end", "e28f", "workflow_start", "3a1f" ], "complete": [ "e28f", "error_handler", "3a1f", "3a1f" ], "error": [ "workflow_start", "3a1f", "workflow_start", "workflow_end" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "e28f", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "e28f", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "revert" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "culpa", "start_time": "1990-03-16T05:13:07.386Z", "end_time": 31755882.026056796, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ { "_id": "850abc7bb51f878ffd124487", "provenance": "Ut adipisicing", "name": "sit", "description": "velit aliquip eu", "memberOf": [ { "groupId": "fc570500a65da94f3014b336", "aaaManaged": false }, { "groupId": "796f59234089112276d18169", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "veniam ea anim Duis sunt" }, { "roleId": "consectetur sit" }, { "roleId": "occaecat sed" } ], "inactive": true, "_meta": { "created": "2004-12-09T19:54:41.651Z", "updated": "1969-10-14T13:39:45.23Z", "migrationVersion": -42630105 } }, "839f04faec5eff1abff9b040", { "_id": "3fe1e18ff1b423193f2b5dca", "provenance": "Excepteur dolor et", "name": "voluptate ex in", "description": "ad deserunt ex", "memberOf": [ { "groupId": "31a6cd99af1d55fe4a626c31", "aaaManaged": false }, { "groupId": "09f39211085c32d2ed6e739f", "aaaManaged": true }, { "groupId": "5f451a60cfca093bb846c7d9", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "magna in officia fugiat labore" }, { "roleId": "nisi fugiat pariatur" }, { "roleId": "reprehenderit" }, { "roleId": "occaecat in aliqua" } ], "inactive": false, "_meta": { "created": "1948-06-05T20:35:48.491Z", "updated": "1978-12-21T08:27:45.369Z", "migrationVersion": 56117705 } }, "d95f3f1bb0c4a6b5c5452953", "2e8abeab012ebe58d0daa28c" ], "iterations": [ "5F23Bb0E-9291-850A-EeAB-8866C8FAc432", "064c0DdC-5223-5f75-ABd1-32B780482d0a", "6124C1B2-fD72-8ecA-1dD9-C3ba8D42B4ca" ] }, "35a8": { "actor": "a8abc49b439f499b89e03673", "groups": [ "7a69f6e5fea6907ca5d6b356", "default", "default", "1935ccb8f861144670a9e44e", "0a2f85769ec6ebc8391c011a" ], "iterations": [ "3cB3A526-5B8b-CFd3-ABD2-AFde1c1Fe36c", "2BBA80a7-3A15-10ac-bd00-491Bc2a9e9Eb", "B155018f-B8dD-7ADF-8Cb9-ea73B3fC95D9" ], "x": 16305208.003239408, "y": 33219253.566742152, "gridCoordinate": { "x": -17620648.502439097, "y": 51182842.56349558 }, "name": "amet adipisicing non dolor id", "location": "Adapter", "locationType": null, "app": "ullamco Excepteur deserunt dolore dolor", "canvasName": "do est enim et consectetur", "displayName": "commodo", "summary": "in", "description": "ea exercitation dolor", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/DvV/~0/HZvqCrHAE/NC8c9.xj/~1/I9f/if/~1" }, { "type": "encryption", "pointer": "/WD/~0/~1/~0/pNFPU9/tP/ljnzmA-k/hMwd9yEQ/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "esse cupidatat incididunt", "highlightString": "qui amet veniam ea" } ], "status": "scheduled", "previous": { "incomplete": [ "workflow_start", "workflow_start", "workflow_end", "e28f" ], "complete": [ "e28f", "3a1f", "workflow_start", "error_handler" ], "error": [ "error_handler", "3a1f", "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "standard" }, { "task": "e28f", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "e28f", "type": "loop" }, { "task": "3a1f", "type": "revert" } ] }, "serverId": "amet", "start_time": "1986-08-24T04:21:50.849Z", "end_time": 46877351.2298542, "finish_state": "error", "retrySettings": { "state": [ "failure", "failure" ], "autoRetry": false, "limit": 75190835, "delay": 17353887, "count": 49060967, "finishedRetrying": true }, "type": "manual", "view": "reprehenderit culpa in" } }, "parent": { "task": "culpa", "iteration": -34093550.802800275, "element": -19371839.598482147 }, "errorHandler": { "actor": "53627bae1ddd22443826fcfb", "groups": [ "default", "default", "default", "c03610d0ddd6b0a899fa41b9" ], "iterations": [], "x": -55435537.87934803, "y": 80570875.60683435, "gridCoordinate": { "x": -84692496.5784336, "y": 57875297.83915654 }, "name": "pariatur", "location": "Adapter", "locationType": "irure", "app": "nisi", "canvasName": "labore culpa Duis cupidatat", "displayName": "in voluptate ut elit", "summary": "officia nulla eiusmod", "description": "minim ipsum", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/hx-X" }, { "type": "encryption", "pointer": "/KZA/~0/~1/fw3CNO3L/XHfaQ8MBae8/p/FycCXt5bZ" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "culpa consectetur ullamco Lorem tempor", "highlightString": "dolore dolor magna in Duis" }, { "key": "ad est", "highlightString": "cupidatat esse" } ], "status": "scheduled", "previous": { "incomplete": [ "workflow_end", "workflow_end" ], "complete": [ "workflow_start", "3a1f", "error_handler" ], "error": [ "workflow_start", "error_handler", "error_handler", "workflow_end" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "error_handler", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "workflow_end", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "e28f", "type": "standard" } ] }, "serverId": "Duis proident reprehenderit in", "start_time": "1949-02-02T21:19:40.555Z", "end_time": -41658873.5081497, "finish_state": "success", "retrySettings": null, "type": "manual", "view": "in reprehenderit dolore voluptate" }, "groups": [ { "_id": "bb0717255cfa08e9eaec9310", "provenance": "laboris reprehenderit sunt voluptate", "name": "veniam quis nulla est cillum", "description": "culpa", "memberOf": [ { "groupId": "a28ae180beb8f2e155e62b8c", "aaaManaged": true }, { "groupId": "0754c37d06fba1eecbfb9cb1", "aaaManaged": true }, { "groupId": "cad90b5d275897b0fedef210", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ullamco et adipisicing reprehenderit Ut" }, { "roleId": "elit Ut" }, { "roleId": "fugiat" }, { "roleId": "eu ea quis ullamco" } ], "inactive": true, "_meta": { "created": "1961-02-16T13:05:40.755Z", "updated": "1991-07-02T10:48:03.719Z", "migrationVersion": -10123394 } } ], "watchers": [ "465381b11bbadd31407b0b1f", "8b6a415411987ceb9639dc7f", "Pronghorn" ], "metrics": { "start_time": -80400377.4608407, "progress": 0.8455695942927075, "end_time": 4179669.708232805, "user": "Pronghorn", "owner": "Pronghorn" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }