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": "abd2b49f808b6259844fd72a", "uuid": "1d0c110e-f391-fdc8-51e2-c08ee66e2cf7", "font_size": -22793, "type": "resource:compliance", "created": "1970-09-05T12:12:51.608Z", "last_updated": "2011-04-13T05:37:07.963Z", "createdVersion": "572276.39.90121-9592.34175264.180.3817", "lastUpdatedVersion": "21166438270.00344.13298080-4684.800805.8", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": -24502600, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 62299112.04949799, "sla": 41062940.49668485, "decorators": [ { "type": "encryption", "pointer": "/tv8BW/iAiPFI11K-" }, { "type": "encryption", "pointer": "/~1/Km1dyfv5o-/~0" } ], "status": "paused", "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": "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "consectetur veniam dolore et" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "veniam ad aliquip ut" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "labore" } ], "ancestors": null, "validationErrors": [ { "keyword": "velit minim sint", "instancePath": "ut id nulla ullamco dolor", "schemaPath": "amet do dolore Duis", "message": "labore tempor mollit" }, { "keyword": "mollit irure ut consequat", "instancePath": "deserunt et magna consectetur", "schemaPath": "Excepteur laboris labore", "message": "sit" }, { "keyword": "in sed sunt tempor anim", "instancePath": "ullamco consectetur pariatur", "schemaPath": "eu deserunt dolor sed Ut", "message": "est ut anim consequat" }, { "keyword": "laboris ea", "instancePath": "consectetur consequat", "schemaPath": "dolor sed nulla cupidatat", "message": "ex" }, { "keyword": "laborum enim", "instancePath": "nisi ex nulla", "schemaPath": "Duis reprehenderit", "message": "eu" } ], "created_by": null, "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": -28956859.219027683, "y": -73806397.34271015, "gridCoordinate": { "x": -20273195.046667695, "y": -71790533.62486467 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -69148805.35522929, "finish_state": "failure", "user": "90d33a41e7ef00f80b92b00b" }, "groups": [ "default", { "_id": "e5eec55e16bfbb244f07bfca", "provenance": "voluptate quis veniam", "name": "cillum do qui reprehenderit", "description": "et", "memberOf": [ { "groupId": "966f51f71a2f96053615540f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "amet deserunt" }, { "roleId": "sint consectetur nostrud laboris non" }, { "roleId": "do anim eiusmod aliqua" }, { "roleId": "adipisicing nisi in laborum" } ], "inactive": false, "_meta": { "created": "2003-08-16T17:04:29.197Z", "updated": "1949-07-13T09:16:14.053Z", "migrationVersion": 46108628 } }, "ffb9c55f6803cb4b15a10ae9", { "_id": "702532b05bf0e75675602e10", "provenance": "culpa dolore", "name": "amet ipsum ea", "description": "cupidatat quis Lorem do", "memberOf": [ { "groupId": "c419fbf36cad4fe10838dbe7", "aaaManaged": true }, { "groupId": "8296a64fc44dcb15e7456c85", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consequat laboris aliquip voluptate eiusmod" }, { "roleId": "sed nulla laborum et irure" }, { "roleId": "magna exercitation id" }, { "roleId": "culpa mollit" } ], "inactive": false, "_meta": { "created": "1979-07-27T12:31:08.146Z", "updated": "1974-02-03T03:08:32.497Z", "migrationVersion": 72521018 } } ], "iterations": [] }, "workflow_end": { "x": 69422473.72615302, "y": -7375822.619714484, "gridCoordinate": { "x": -53988260.59682751, "y": -61048162.7243252 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "e28f", "workflow_end", "error_handler", "workflow_end" ], "complete": [ "workflow_start", "workflow_start", "3a1f", "workflow_start", "e28f" ], "error": [ "workflow_end", "error_handler", "3a1f" ] }, "metrics": { "end_time": 74758148.22480738, "run_time": -63230725.662764534 }, "groups": [ { "_id": "b514165eed092bb2cad16de3", "provenance": "occaecat cillum velit sed", "name": "eiusmod tempor", "description": "sit aliqua reprehenderit occaecat enim", "memberOf": [ { "groupId": "f0e90ee68cc174f1b8fc7dce", "aaaManaged": true }, { "groupId": "c2a15a61439aacf86b90be82", "aaaManaged": false }, { "groupId": "cea3deeb428bc07926959e36", "aaaManaged": false }, { "groupId": "fa73e35e7ca6edf224844c14", "aaaManaged": true }, { "groupId": "2147cdfc0e6934c2e7d5e03f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nisi dolor" }, { "roleId": "proident" }, { "roleId": "minim eiusmod culpa incididunt" }, { "roleId": "fugiat" }, { "roleId": "anim in nisi" } ], "inactive": true, "_meta": { "created": "2015-06-01T11:49:42.63Z", "updated": "2011-09-12T15:50:52.21Z", "migrationVersion": 95037913 } }, "default", "default", "e33d89eac0906569c40ca32b", { "_id": "068f2e031e2e6610b96d1bf0", "provenance": "elit", "name": "est minim eiusmod non do", "description": "quis eu aliqua magna in", "memberOf": [ { "groupId": "712ed0809da5505dfc35ed77", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "exercitation nisi" }, { "roleId": "enim" }, { "roleId": "dolore in" }, { "roleId": "labore commodo dolor velit Lorem" } ], "inactive": false, "_meta": { "created": "1996-10-18T10:42:51.903Z", "updated": "1994-12-10T20:37:29.411Z", "migrationVersion": -25981203 } } ], "iterations": [] }, "error_handler": { "x": 44217891.55707255, "y": 69445290.81343439, "gridCoordinate": { "x": 17575234.146910653, "y": 70760769.57668182 }, "name": "childJob", "location": "Broker", "locationType": "non Excepteur nostrud", "app": "aute irure", "canvasName": "nisi dolor pariatur Lorem voluptate", "displayName": "proident", "summary": "irure sed cupidatat laborum in", "description": "officia reprehenderit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/s/2x/~1" }, { "type": "encryption", "pointer": "/N/~0/~1/BwLC5rLY/~0" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "non Excepteur in qui", "highlightString": "incididunt veniam ad labore occaecat" }, { "key": "culpa aute", "highlightString": "deserunt nulla" }, { "key": "sit magna ipsum nisi consectetur", "highlightString": "sed reprehenderit" }, { "key": "qui Excepteur culpa", "highlightString": "in do" }, { "key": "labore dolor", "highlightString": "nisi aute Excepteur anim" } ], "status": "failure", "previous": { "incomplete": [ "3a1f", "workflow_start", "workflow_start", "workflow_end", "workflow_end" ], "complete": [ "workflow_end", "workflow_start", "workflow_start", "e28f" ], "error": [ "error_handler", "workflow_start", "3a1f", "3a1f" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "revert" } ], "error": [ { "task": "3a1f", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "loop" } ] }, "serverId": "ea commodo magna id", "start_time": "1986-08-25T21:42:07.427Z", "end_time": 61526258.00336903, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": { "_id": "12d5d603e504558381395502", "provenance": "esse Excepteur deserunt", "username": "dolore", "firstname": "exercitation aliqua dolor labore", "memberOf": [ { "groupId": "3034fb4f0a9ef0efc005e468", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consequat officia in Lorem" } ], "inactive": true, "lastLogin": "2009-09-05T13:03:53.647Z", "_meta": { "created": "1994-07-24T22:06:53.206Z", "updated": "1966-03-26T22:59:13.749Z", "migrationVersion": 16812809 }, "email": "exercitation culpa ullamco do reprehenderit" }, "groups": [ "default", "c4a0fea044848f76ef4788e5" ], "iterations": [ "B1Ce0e6b-EE7C-4B8a-AB8c-D7bBC05BFe15", "7e8cFA77-6f27-1DdA-4Ec3-fDb2D7f44d8e", "EfEF1c62-ae6d-E0a5-CA50-95D1cF475a2D", "5D14Cb4e-8fb7-D3DE-BcB8-f36fFe1B3EFb" ] }, "dff": { "actor": "Pronghorn", "groups": [ { "_id": "fb9d9639300da2f0db7e2fdf", "provenance": "dolore", "name": "non eu deserunt", "description": "ea et", "memberOf": [ { "groupId": "59cd705978a0154f1f729571", "aaaManaged": false }, { "groupId": "6aac290a478e565b3f8ba400", "aaaManaged": true }, { "groupId": "b3bc5daa02623c9038b8f727", "aaaManaged": true }, { "groupId": "50f1f419d9699079ea10aebb", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cupidatat" }, { "roleId": "ea" }, { "roleId": "dolore ullamco pariatur" }, { "roleId": "ut in sint ut in" }, { "roleId": "ut pariatur Ut magna ullamco" } ], "inactive": true, "_meta": { "created": "1953-09-15T09:51:17.339Z", "updated": "1994-12-11T12:37:56.053Z", "migrationVersion": 14758994 } }, "default", "a44e507c59fda3f24044389f", { "_id": "173d14d1e2e8c8180bbb82d4", "provenance": "nisi in laborum ullamco", "name": "occaecat culpa aliquip", "description": "ut et dolor", "memberOf": [ { "groupId": "2a89ec183981d2cfd9232235", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eu cillum voluptate" }, { "roleId": "Lorem do occaecat" }, { "roleId": "laborum tempor" } ], "inactive": false, "_meta": { "created": "1961-04-06T00:09:10.42Z", "updated": "1963-01-05T22:16:49.246Z", "migrationVersion": 17438044 } }, { "_id": "e014e9ee4a308034f5de38bf", "provenance": "exercitation culpa esse", "name": "et enim laboris", "description": "sit dolore", "memberOf": [ { "groupId": "c04c362279f37b312de7e601", "aaaManaged": true }, { "groupId": "85f73d0a2922400ec7c75416", "aaaManaged": true }, { "groupId": "2c0b0d5e98075ba3b978a918", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cupidatat dolore" } ], "inactive": true, "_meta": { "created": "1958-08-13T15:36:50.706Z", "updated": "1954-04-10T09:59:23.573Z", "migrationVersion": -25063506 } } ], "iterations": [ "e82C6119-cFF1-1AE8-CbbC-6b9aDB7BcFB7", "bD4Ec9D5-7a42-4c06-daa6-bcB314Cf43F7" ], "x": -18645642.219365224, "y": 82765054.7883254, "gridCoordinate": { "x": 88091599.57833174, "y": -99107945.94265097 }, "name": "in sunt exercitation veniam quis", "location": "Adapter", "locationType": null, "app": "ut id", "canvasName": "childJob", "displayName": "consectetur mollit adipisicing", "summary": "dolor mollit officia Duis qui", "description": "commodo reprehenderit dolor", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/dRd1/~1/tj/~0/fHSgUwl4/wuzTOK0B/~1" }, { "type": "encryption", "pointer": "/W/TU0IjE/wbfip28Sj" }, { "type": "encryption", "pointer": "/~1/~1/~1/~0/leSUQF/hsTP2u7pb/~0/~0/~0" }, { "type": "encryption", "pointer": "/~0/~1/e+O/~0/~0/~0/z//NM-9Dx/~1/Bf7eC" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "officia adipisicing", "highlightString": "anim amet" }, { "key": "dolore dolore", "highlightString": "labore Duis dolor occaecat consequat" }, { "key": "est sint elit proident", "highlightString": "aliquip sit occaecat anim" }, { "key": "amet veniam tempor", "highlightString": "exercitation" } ], "status": "scheduled", "previous": { "incomplete": [ "workflow_end", "e28f", "e28f" ], "complete": [ "3a1f" ], "error": [ "3a1f", "workflow_end" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "loop" } ] }, "serverId": "elit fugiat magna", "start_time": "1958-11-25T04:35:50.822Z", "end_time": 17834373.494970188, "finish_state": "success", "retrySettings": { "state": [ "failure", "success" ], "autoRetry": false, "limit": 21981114, "delay": 41804410, "count": 53039978, "finishedRetrying": true }, "loop": { "atLeastOneComplete": true, "finishedCount": 29403929.255098134, "outgoing": [] }, "childJobs": [ { "_id": "eiusmod id", "name": "incididunt occaecat ea minim anim", "iteration": 97962931.54812926 }, { "_id": "veniam sed culpa dolor reprehenderit", "name": "do mollit in", "iteration": -52476990.442275405 } ] } }, "parent": { "task": "do proident occaecat", "iteration": -76242584.89496247, "element": 22354393.695862785 }, "errorHandler": { "actor": "0aaa081d2f4921a51be251ce", "groups": [ "default", "default", { "_id": "c6570d6110214ba02502ca5c", "provenance": "labore ad", "name": "proident Excepteur ad", "description": "deserunt velit minim", "memberOf": [ { "groupId": "b4e2f2768e74356ea220e5df", "aaaManaged": false }, { "groupId": "7cd0e53b9311e15396daa313", "aaaManaged": true }, { "groupId": "17177d210423d94b0e69ee8c", "aaaManaged": true }, { "groupId": "d4e75b73d6bcb47ad42fa9b1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "elit officia" } ], "inactive": true, "_meta": { "created": "1998-06-03T09:55:24.053Z", "updated": "2021-11-07T08:36:22.753Z", "migrationVersion": -97255103 } } ], "iterations": [ "60AbAc6a-FDCF-9D48-eFea-Db9BABDd2EaB", "82D1B766-155f-AF7A-B5F7-7E610203028a" ], "x": 98144687.92886001, "y": 27286056.780139893, "gridCoordinate": { "x": -61484061.56377289, "y": -78460759.84330106 }, "name": "Ut sed veniam", "location": "Broker", "locationType": "officia Excepteur Lorem eiusmod elit", "app": "fugiat elit laboris", "canvasName": "childJob", "displayName": "Lorem consequat", "summary": "esse voluptate consectetur", "description": "tempor magna ullamco officia", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/HGSy/GTQj6IarC/~0/~1/dANtJ-H/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "ut Excepteur aliqua", "highlightString": "aute dolor magna Excepteur nisi" } ], "status": "complete", "previous": { "incomplete": [ "3a1f", "workflow_start" ], "complete": [ "workflow_start", "workflow_end", "error_handler", "3a1f", "error_handler" ], "error": [ "e28f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "e28f", "type": "revert" } ] }, "serverId": "fugiat ea anim in", "start_time": "1977-05-09T14:40:07.142Z", "end_time": 52624413.12771034, "finish_state": "failure", "retrySettings": { "state": [ "success", "success", "failure", "error" ], "autoRetry": false, "limit": 22434216, "delay": 61449796, "count": 29114245, "finishedRetrying": false }, "loop": { "atLeastOneComplete": true, "finishedCount": 9800817.375098929, "outgoing": [] }, "childJobs": [ { "_id": "mollit deserunt dolor eu dolore", "name": "dolor ex non eu in", "iteration": -2076770.8159099072 } ] }, "groups": [ { "_id": "3ed402bb41999b545243b4a2", "provenance": "labore", "name": "et aute enim in", "description": "enim pariatur cillum consectetur", "memberOf": [ { "groupId": "9b841aa58caa09dabd4d47bf", "aaaManaged": true }, { "groupId": "db3eafd3d3ef9a0ffcca3c18", "aaaManaged": true }, { "groupId": "76dd5dfa121b1fe1845a85cc", "aaaManaged": false }, { "groupId": "7d751c1884b9736b03acd5c4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "est deserunt magna do" }, { "roleId": "est laborum" }, { "roleId": "est" } ], "inactive": true, "_meta": { "created": "1991-12-08T17:20:52.773Z", "updated": "1958-12-31T21:25:26.015Z", "migrationVersion": 75850186 } }, "4ddafea6b20a311cb5f144f7", "default", "default", "1860f6457027d887f783b7af" ], "watchers": [ "7acefb71a88d6d0d75fb5e07", null, "f7f9b0ba4ab0d367b1eef788" ], "metrics": { "start_time": -99864013.25380698, "progress": 0.09784482727698984, "end_time": -40637771.51931078, "user": "Pronghorn", "owner": "506aa332ae737fdabf89bd53" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }