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": "7f004434b5d74917bd250fe4", "font_size": -61756452, "type": "resource:compliance", "created": "1962-09-14T18:33:52.578Z", "last_updated": "2006-11-08T05:36:43.001Z", "createdVersion": "82696.772.072", "lastUpdatedVersion": "1652450000.226.53516515", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -56578314, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -48966581.92630832, "sla": 2574061.6117396504, "decorators": [ { "type": "encryption", "pointer": "/~0/z,grYfM-/dK/~0/~0/S+f" } ], "status": "paused", "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": "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": "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": "3a1f", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "anim" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "officia eiusmod cillum in sint" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "consequat reprehenderit est Excepteur" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "tempor laborum amet" } ], "ancestors": null, "validationErrors": [ { "keyword": "qui labore voluptate cillum", "instancePath": "exercitation", "schemaPath": "cupidatat elit est", "message": "in consequat qui" }, { "keyword": "nulla sunt velit exercitation", "instancePath": "eu deserunt eiusmod adipisicing", "schemaPath": "adipisicing nulla dolor in", "message": "Duis minim" }, { "keyword": "anim pariatur mollit officia", "instancePath": "sint velit enim ad ipsum", "schemaPath": "sint", "message": "aliquip sunt exercitation et" }, { "keyword": "proident do", "instancePath": "aliquip irure", "schemaPath": "dolore", "message": "aute Excepteur" }, { "keyword": "anim non dolore", "instancePath": "in Lorem dolore Duis", "schemaPath": "mollit officia ullamco eiusmod", "message": "eu commodo ea Excepteur" } ], "created_by": "df25542087171e4e2868569b", "last_updated_by": "86ae53b2aabe4af0bb956a9c", "tasks": { "10": { "x": -3331385.8967836946, "y": 66260316.32561648, "gridCoordinate": { "x": 57673081.58021903, "y": 76565156.62497845 }, "name": "amet Ut nulla", "location": "Broker", "locationType": null, "app": "dolor exercitation", "canvasName": "ipsum deserunt minim ea", "displayName": "officia in ipsum", "summary": "minim do", "description": "reprehenderit do", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/z/j/GtkJt+ifG/~0/Bi3WJbBKBU/f3B/KfOoc0GaF5S/~0/s4" }, { "type": "encryption", "pointer": "/fviOmh//S7LSXfvN/f-crZ.T" }, { "type": "encryption", "pointer": "/~0/~0/FMmNY/PC/Rb.-/~0/J" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "amet ut ipsum elit", "highlightString": "anim commodo est aliquip" }, { "key": "est proident occaecat ad anim", "highlightString": "elit exercitation ex" }, { "key": "culpa", "highlightString": "Ut Duis esse" }, { "key": "in consectetur nisi", "highlightString": "aute quis minim" }, { "key": "voluptate deserunt sit", "highlightString": "magna minim" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start", "error_handler" ], "complete": [ "3a1f", "workflow_end", "workflow_end", "e28f" ], "error": [ "error_handler", "3a1f", "e28f", "workflow_end", "3a1f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "revert" } ] }, "serverId": "dolor in officia", "start_time": "2012-03-13T00:40:24.87Z", "end_time": -44112242.05799624, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "d407756bd5c0b5fce87aeae8", "groups": [ "default", { "_id": "f9d77da622e8552d0574d4bc", "provenance": "Ut ipsum ut laboris sit", "name": "in", "description": "irure ad incididunt", "memberOf": [ { "groupId": "830be5ea63eb2a29731cb58a", "aaaManaged": false }, { "groupId": "e2244402b0bdae793f5af9c9", "aaaManaged": true }, { "groupId": "d2c4da8bc8e994268dbb5ac5", "aaaManaged": false }, { "groupId": "9492899d59261e44c97cd721", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "elit exercitation" }, { "roleId": "dolor dolore cupidatat" }, { "roleId": "ipsum do dolore nulla" }, { "roleId": "aliqua" } ], "inactive": false, "_meta": { "created": "2003-05-25T04:11:24.774Z", "updated": "1997-11-04T18:44:54.839Z", "migrationVersion": 68471811 } }, { "_id": "ee8024d7c01fe32d25e1a823", "provenance": "magna consequat", "name": "sunt velit", "description": "voluptate tempor eiusmod minim laboris", "memberOf": [ { "groupId": "bc2e56280442bae82033ffc0", "aaaManaged": false }, { "groupId": "0578c20b6b84eb05acee2fe9", "aaaManaged": true }, { "groupId": "52f921f2e5fbdf47abd27706", "aaaManaged": false }, { "groupId": "65aeef33e299b94783929f48", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolore veniam quis in" } ], "inactive": true, "_meta": { "created": "2009-09-16T17:53:32.548Z", "updated": "1973-03-03T09:05:56.306Z", "migrationVersion": 98723690 } }, { "_id": "f7294dcf44118f1ff1c56aeb", "provenance": "ea eu", "name": "nulla commodo", "description": "ipsum", "memberOf": [ { "groupId": "83d2b8cea012762991f821b4", "aaaManaged": false }, { "groupId": "fde666312a4b3ac4453eb951", "aaaManaged": false }, { "groupId": "ad049febc12ce6e1a73a55df", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "labore sed aute aliquip in" }, { "roleId": "proident" } ], "inactive": true, "_meta": { "created": "1984-08-03T20:26:46.741Z", "updated": "1977-06-22T09:47:58.187Z", "migrationVersion": -80871464 } } ], "iterations": [ "C459FDe9-ef95-9200-0427-ef113B95ddE2" ] }, "workflow_start": { "x": 77569945.32049978, "y": -61468335.62938649, "gridCoordinate": { "x": 87472519.9251521, "y": -87223975.31305775 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -14599246.688520744, "finish_state": "success", "user": null }, "groups": [ "default" ], "iterations": [ "42587B07-DfFf-47e6-d80f-F8a2Cd416e21" ] }, "workflow_end": { "x": -50953645.86851927, "y": -74623200.04564354, "gridCoordinate": { "x": -10094667.09844844, "y": 42285437.89861882 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "workflow_start", "error_handler" ], "complete": [ "workflow_start", "workflow_start", "workflow_start", "workflow_end" ], "error": [ "e28f", "e28f", "error_handler", "workflow_start", "workflow_end" ] }, "metrics": { "end_time": 34109809.01177786, "run_time": 69266720.39483824 }, "groups": [ "3df47cd6a650a6e6ba498145" ], "iterations": [ "FfB47e1C-1a9f-A63f-cDb2-C19Fdcce639C", "9F0fF4EE-5B24-0bc2-6bDd-F8500eaFeaB9" ] }, "error_handler": { "x": -25883916.529371336, "y": -25731502.587030202, "gridCoordinate": { "x": 59020487.50361276, "y": -38349083.37184011 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "dolor est eiusmod pariatur", "canvasName": "irure consequat fugiat", "displayName": "in sunt deserunt", "summary": "ipsum", "description": "cupidatat do", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/z/sXh6kg/AQQJbvyx2,R/owy9/~0/gR16q/~1/I5n1/~1/YvR9/zGSqNw" }, { "type": "encryption", "pointer": "/jtUU7FZ/V7/~0/BPOWFRYwpe/Ov7vfn,4h" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "aute incididunt Ut", "highlightString": "ut irure" }, { "key": "sed consectetur", "highlightString": "veniam Duis" }, { "key": "sed", "highlightString": "qui deserunt" }, { "key": "enim", "highlightString": "ipsum consequat mollit" }, { "key": "ad labore cillum do fugiat", "highlightString": "enim pariatur dolor dolore" } ], "status": "canceled", "previous": { "incomplete": [ "error_handler", "workflow_end", "e28f", "workflow_end", "workflow_start" ], "complete": [ "e28f", "3a1f" ], "error": [ "3a1f", "3a1f", "e28f", "3a1f", "workflow_end" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "laboris Lorem tempor nulla sit", "start_time": "1967-08-05T14:20:09.218Z", "end_time": -93772094.43751773, "finish_state": "success", "retrySettings": { "state": [ "failure", "failure", "success", "error", "success" ], "autoRetry": true, "limit": 69367490, "delay": 82470205, "count": 98725923, "finishedRetrying": true }, "type": "operation", "actor": null, "groups": [ "default", { "_id": "7caaf3725b54a86819925aaa", "provenance": "ut officia", "name": "pariatur", "description": "laborum", "memberOf": [ { "groupId": "9b6c693d81e21d210ca03982", "aaaManaged": true }, { "groupId": "c8a43d4b807a3245a2097317", "aaaManaged": false }, { "groupId": "1ca6b46c21d622f405b85a78", "aaaManaged": false }, { "groupId": "9faadcc3e1adeb8769afbda0", "aaaManaged": false }, { "groupId": "6fd01f89df9ba43a70c9d183", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut officia" }, { "roleId": "fugiat ea laborum consequat proident" }, { "roleId": "Duis incididunt eiusmod dolore" }, { "roleId": "ut et consectetur laboris" }, { "roleId": "voluptate nostrud" } ], "inactive": false, "_meta": { "created": "1952-07-23T02:38:11.031Z", "updated": "1987-11-07T11:48:41.426Z", "migrationVersion": -22772757 } }, "default", "default", "default" ], "iterations": [ "AA8eF99B-b7FF-d7cf-3Acd-fB3EbAebc1fa" ] } }, "parent": { "job": "magna officia", "task": "in anim amet dolore do", "iteration": -96744711.44587936, "element": -95050468.52601798 }, "errorHandler": { "x": -56374844.579825155, "y": -73285040.39114283, "gridCoordinate": { "x": 29982537.633347303, "y": 61740568.22343862 }, "name": "non do in qui elit", "location": "Adapter", "locationType": null, "app": "mollit", "canvasName": "velit incididunt", "displayName": "aliqua incididunt", "summary": "occaecat Lorem enim Ut sunt", "description": "dolore in sit proident", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/OYauuAi5Le1/~0/JS.vH/~1/kSJBiaw/Asm/p0iUBIk/~0/~0" }, { "type": "encryption", "pointer": "/~1/h+-4No/~0/bFCAHx7T/~0/~1/~0/~0/w/HZmE2Ftml" }, { "type": "encryption", "pointer": "/~1/J6iMNhZd" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "laborum aliqua", "highlightString": "nulla anim in" }, { "key": "mollit Lorem", "highlightString": "occaecat cupidatat anim" } ], "status": "paused", "previous": { "incomplete": [ "workflow_start", "workflow_end", "e28f", "workflow_start" ], "complete": [ "e28f", "workflow_start", "workflow_end", "error_handler" ], "error": [ "workflow_start", "3a1f", "e28f" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "loop" } ], "failure": [ { "task": "workflow_end", "type": "revert" }, { "task": "error_handler", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "revert" } ] }, "serverId": "cupidatat", "start_time": "1992-09-12T04:30:45.214Z", "end_time": -79551170.27051774, "finish_state": "failure", "retrySettings": { "state": [ "error", "success", "success", "failure", "failure" ], "autoRetry": true, "limit": 22086351, "delay": 7845573, "count": 5634761, "finishedRetrying": false }, "type": "operation", "actor": null, "groups": [ "default", "default", "default", "default", "default" ], "iterations": [] }, "groups": [ "default", { "_id": "81a017e19403f7124fa70c4e", "provenance": "proident in sunt exercitation aute", "name": "sunt non eiusmod sint", "description": "Excepteur exercitation Lorem", "memberOf": [ { "groupId": "32d0977de3e52979f45d4f74", "aaaManaged": false }, { "groupId": "aeaef5f5a6770ec255083261", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ex dolor esse" } ], "inactive": false, "_meta": { "created": "1954-01-10T06:57:04.866Z", "updated": "2019-01-11T00:53:36.311Z", "migrationVersion": -14432293 } } ], "watchers": [ { "_id": "59a275ea6448e62744e832c4", "provenance": "Duis et aute qui id", "username": "in", "firstname": "ad voluptate", "memberOf": [ { "groupId": "8f3d595abb50e6282564d5dd", "aaaManaged": true }, { "groupId": "e91a104289ba1ef0a2d98c22", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "officia proident ad nisi" }, { "roleId": "laborum consequat sed dolore" }, { "roleId": "aliqua mollit est sed" } ], "inactive": true, "lastLogin": "1959-02-24T21:26:23.681Z", "_meta": { "created": "2015-12-22T08:30:56.711Z", "updated": "2012-12-23T13:35:22.615Z", "migrationVersion": -80181339 }, "email": "adipisicing" }, "Pronghorn", null, "Pronghorn", "9ae17acee5b8b94f28c03578" ], "metrics": { "start_time": 91928190.90680087, "progress": 0.5125513584693173, "end_time": -45723907.03082933, "user": "Pronghorn", "owner": "8b76bb169fbfd7a7272f19b1" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }