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": "fb068fd0b23b36356f866b93", "font_size": -65655505, "type": "automation", "created": "1948-03-06T09:50:08.005Z", "last_updated": "1961-07-19T10:56:12.209Z", "createdVersion": "10573770331.0.670274", "lastUpdatedVersion": "3071157668.7650856531.396", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 48501475, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 26693064.333282605, "sla": -35297720.135250054, "decorators": [ { "type": "encryption", "pointer": "/a+,C/zH" }, { "type": "encryption", "pointer": "/~1/~0/qlBPJ" }, { "type": "encryption", "pointer": "/~0/hfEJMpmPW01/rj/~0" }, { "type": "encryption", "pointer": "/~1/f6O2hs/~0/OuLlDWsWKq4/~1/j/zPj-ihlo/~0/WFDOMw/~0/~1" }, { "type": "encryption", "pointer": "/cf/J3h/~0/c-k6IU,GH/~0/VhVQD.ce,/~0/bvl/~0/jRbrfmD/nGGzihu/" } ], "status": "canceled", "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": "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": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "dolor qui amet" }, { "task": "error_handler", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "proident ea enim quis aute" } ], "ancestors": [ "12f9563d778a3613c6a13077", "0235f6e65f1e122ad39307dc", "2399ffbc51d5e9df1972c5b5", "f5a71c7caba9456a34d3b45e" ], "validationErrors": [ { "keyword": "aliqua commodo", "dataPath": "officia nostrud esse sed", "schemaPath": "nostrud tempor non cillum", "message": "reprehenderit" }, { "keyword": "veniam ex ut", "dataPath": "esse proident dolore velit veniam", "schemaPath": "id aliqua voluptate est", "message": "dolore anim est incididunt" } ], "created_by": { "_id": "031cc57a718dceaf57ebff7f", "provenance": "eu exercitation dolor Excepteur", "username": "minim", "firstname": "nulla", "memberOf": [ { "groupId": "ba957315d9e1b7eb084371dc", "aaaManaged": true }, { "groupId": "2b58dec879cbd8dc7fd5e464", "aaaManaged": true }, { "groupId": "3c20d6a1ca3d0fb4fda32397", "aaaManaged": false }, { "groupId": "a48b17e823ffc052fb46be09", "aaaManaged": true }, { "groupId": "9bad2532ecf23ee2be6af39e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aliqua quis dolore enim in" }, { "roleId": "eu" } ], "inactive": true, "lastLogin": "2013-07-02T14:48:21.526Z", "_meta": { "created": "2018-04-26T04:25:51.426Z", "updated": "1987-01-19T04:29:17.712Z", "migrationVersion": 40298983 }, "email": "Duis dolore amet tempor" }, "last_updated_by": null, "tasks": { "3": { "actor": "job", "groups": [ { "_id": "52c28ef8d38bb7a26286d1d4", "provenance": "do anim eu Ut", "name": "qui sed officia occaecat", "description": "ut", "memberOf": [ { "groupId": "b3b9853cea5695199dc65de3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "velit in quis" }, { "roleId": "ea in consectetur mollit" } ], "inactive": true, "_meta": { "created": "1971-10-18T13:38:46.655Z", "updated": "1956-09-07T01:53:47.437Z", "migrationVersion": -41421289 } }, "3f8f2b4f01049a4e2cec0d70", "default", { "_id": "301ae8769f9554b27c2be491", "provenance": "enim exercitation non elit", "name": "eu exercitation Duis et irure", "description": "Lorem nostrud culpa et pariatur", "memberOf": [ { "groupId": "a3eefe774a214f5234a5f029", "aaaManaged": false }, { "groupId": "d95e44a9dcf4051ec63a5832", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "irure nisi" }, { "roleId": "nostrud aliqua irure" } ], "inactive": false, "_meta": { "created": "2003-08-07T18:50:58.276Z", "updated": "2011-05-21T12:47:36.255Z", "migrationVersion": -5308412 } }, "default" ], "iterations": [ "28EbfF9e-bEdf-a333-C6cC-b1F00Cfd30cF", "6809C2b4-BeAf-fFA1-26E0-f11FFfb1bEf6" ], "x": 38669229.82038754, "y": 76851804.48715481, "gridCoordinate": { "x": 59852158.66035265, "y": 21559130.83034125 }, "name": "pending", "summary": "culpa esse ex dolore velit", "description": "Excepteur laboris cupidatat" }, "workflow_start": { "x": 8302847.4087842405, "y": -81706660.89364737, "gridCoordinate": { "x": -98236787.00631425, "y": 56584811.9650974 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -46663787.016688116, "finish_state": "failure", "user": { "_id": "e6cba4f66c5b0d18a02ed57d", "provenance": "eu proident cillum officia", "username": "tempor ea nisi", "firstname": "labore proident in est velit", "memberOf": [ { "groupId": "6c7c2cc101444252df8571d6", "aaaManaged": true }, { "groupId": "f915c715a6c46443fbecbd0d", "aaaManaged": true }, { "groupId": "ed01aa23e5f845c90aa7d07f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aliquip nostrud adipisicing" } ], "inactive": true, "lastLogin": "1961-06-20T11:06:50.871Z", "_meta": { "created": "2012-06-10T20:04:16.153Z", "updated": "1969-06-28T00:15:33.318Z", "migrationVersion": -71839983 }, "email": "aliquip fugiat cupidatat" } }, "groups": [ "a62b65bfb42e6bc1f93abe19", { "_id": "1cb3c1bb71523a2379454021", "provenance": "nisi nulla aliqua incididunt", "name": "occaecat cillum adipisicing mollit", "description": "incididunt", "memberOf": [ { "groupId": "bb1cd6a1bab168c645ed78ba", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aute magna id exercitation irure" }, { "roleId": "Duis commodo" } ], "inactive": false, "_meta": { "created": "2002-07-23T04:19:14.732Z", "updated": "2020-02-18T14:12:57.642Z", "migrationVersion": -51434269 } }, "default" ], "iterations": [ "14c38abE-72B3-DeFD-91DA-f8edf75c3039", "1c2cbEC9-a5Db-6CfA-0cf8-B6A0dFAFDCaE" ] }, "workflow_end": { "x": -95974779.54434304, "y": 63644478.69876093, "gridCoordinate": { "x": -38956337.77705574, "y": 10679273.512035608 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "workflow_start", "e28f", "workflow_start" ], "complete": [ "workflow_start" ], "error": [ "3a1f", "e28f", "error_handler", "3a1f" ] }, "metrics": { "end_time": 52027878.90343514, "run_time": 5413365.701062039 }, "groups": [ "default", "default", "default" ], "iterations": [ "1EE62D54-CBDB-8912-A0da-e4FbFEC1d780", "A065D0ae-86Eb-bfaD-CdCf-0Ee73Fb74a1B", "09636BBc-Ba49-C53A-cCF8-696f38bCEb3b" ] }, "error_handler": { "x": -37369217.81982918, "y": 47082821.146601796, "gridCoordinate": { "x": -84270847.31660765, "y": 26168501.55927901 }, "name": "childJob", "location": "Application", "locationType": "laborum officia deserunt sit id", "app": "id irure", "canvasName": "ut", "displayName": "veniam eu dolore ad ea", "summary": "veniam Excepteur est elit qui", "description": "nulla exercitation ullamco", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~0/~0/~1" }, { "type": "encryption", "pointer": "/~0/O+g/~0/~1/y4wxni9/~1/LUvApnZy/RZFEpXFALh0" }, { "type": "encryption", "pointer": "/~0/~1/~1/Wf/mMpIqOKAe-/Iu,o/Qyq4kfU/~0/TePr/~0" }, { "type": "encryption", "pointer": "/~0/x-F-,FZbCP/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "ut adipisicing cupidatat magna", "highlightString": "mollit Lorem ad sint" } ], "status": "incomplete", "previous": { "incomplete": [ "e28f", "error_handler", "workflow_start", "3a1f", "e28f" ], "complete": [ "error_handler", "workflow_end", "workflow_start", "e28f" ], "error": [ "workflow_start" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "error_handler", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "loop" } ] }, "serverId": "ut", "start_time": "1984-10-03T14:21:54.239Z", "end_time": -44669088.763630696, "finish_state": "success", "retrySettings": { "state": [ "success", "success" ], "autoRetry": true, "limit": 54191340, "delay": 73981625, "count": 66774972, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ "aed9b288e10c2024b6ac3331", { "_id": "35cad94d25c36366f2317af4", "provenance": "mollit culpa", "name": "non ut voluptate occaecat", "description": "fugiat esse ut Excepteur et", "memberOf": [ { "groupId": "0b9eeca8834457eb44490e77", "aaaManaged": true }, { "groupId": "6f3a03a61a56dd3513bcf26d", "aaaManaged": true }, { "groupId": "52a6ef8675a90750480b5f26", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laboris tempor cillum" }, { "roleId": "dolor ex aliqua laborum proident" }, { "roleId": "culpa tempor" } ], "inactive": true, "_meta": { "created": "1977-02-26T12:48:42.033Z", "updated": "2009-07-12T19:06:22.357Z", "migrationVersion": -50726638 } } ], "iterations": [ "f1FEB6bA-4CB7-aDCF-B8Ac-3bd1767b9d3A", "6fbb4004-0E4e-FEeC-7bb2-DCeb02Ac52FD" ] } }, "parent": { "task": "consectetur ut cupidatat", "iteration": -51403286.36199763, "element": -55735206.50719779 }, "errorHandler": { "actor": "job", "groups": [ "1e293b86b669a4f9fd0afe3c", { "_id": "bafa9b0b2f6d522a6fdd14aa", "provenance": "nisi non dolor amet", "name": "exercitation", "description": "ullamco commodo ex", "memberOf": [ { "groupId": "1c1b4861ea9b223070e454a8", "aaaManaged": false }, { "groupId": "607566c9c44c0f693b030151", "aaaManaged": false }, { "groupId": "a7844521da4c558a0a5ebe94", "aaaManaged": true }, { "groupId": "a6eef10af2bab28e95e32061", "aaaManaged": true }, { "groupId": "f9affa6ff6f88db5cd1c43ad", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aute dolor voluptate dolor ea" }, { "roleId": "enim labore in aute ut" }, { "roleId": "ea minim mollit exercitation adipisicing" }, { "roleId": "adipisicing" } ], "inactive": true, "_meta": { "created": "2011-10-17T16:42:57.067Z", "updated": "1986-01-18T11:03:06.549Z", "migrationVersion": 7817908 } }, "1b6ed8697cc8c06a7467e640", "8152032f5ae8acbff84962a3", "4873bc3b8d8cf5cc4a6ce6e7" ], "iterations": [ "e818716F-7E22-1FaD-CdFd-Dbecae7EFeCA" ], "x": 10689131.801103354, "y": 54240583.10480419, "gridCoordinate": { "x": 82500843.47070184, "y": -16529256.003674671 }, "name": "pending", "summary": "adipisicing mollit", "description": "laborum" }, "groups": [ { "_id": "893e389993743aa2b163685d", "provenance": "Duis", "name": "adipisicing pariatur sint fugiat", "description": "mollit et", "memberOf": [ { "groupId": "21d5ec14daf6a7c2da31172e", "aaaManaged": false }, { "groupId": "8c83f134d693c6f2268a250c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laboris eiusmod" }, { "roleId": "eiusmod" }, { "roleId": "dolore tempor sed non" } ], "inactive": true, "_meta": { "created": "1969-07-08T00:46:20.197Z", "updated": "2013-09-29T17:24:18.049Z", "migrationVersion": -78242123 } }, "default", "9bcef172effbf3837de4a836", "default" ], "watchers": [ null ], "metrics": { "start_time": 7519478.075199753, "progress": 0.7131243515808956, "end_time": 19086591.10740438, "user": { "_id": "be08556f19b209f74c5a98ae", "provenance": "ullamco fugiat aliquip consectetur", "username": "Ut", "firstname": "incididunt", "memberOf": [ { "groupId": "3647ff4a3b6765f523687923", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laborum ut" } ], "inactive": false, "lastLogin": "1960-12-31T10:18:51.808Z", "_meta": { "created": "2002-06-15T22:12:24.439Z", "updated": "1982-03-03T07:58:06.762Z", "migrationVersion": -20910296 }, "email": "magna" }, "owner": "83390757f612f00cc81c85af" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }