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": "cda2c864597cfc5c1f5f09a1", "font_size": -18043208, "type": "automation", "created": "2007-05-31T07:06:53.495Z", "last_updated": "2005-11-04T07:24:46.623Z", "createdVersion": "7.216003522.58055372105", "lastUpdatedVersion": "0588.2.5", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": 51729881, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -80762345.98125653, "sla": 88739528.7425614, "decorators": [ { "type": "encryption", "pointer": "/BtbXE3BW/STxrqDO/wMSE+IQoRI/GOgL.,QKU/~1/~0/~1/~1" }, { "type": "encryption", "pointer": "/~0/p+oWoiAj" }, { "type": "encryption", "pointer": "/~0" } ], "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 } ], "warnings": [ { "task": "e28f", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "ea esse enim commodo" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" } ], "ancestors": [ "fb4649c25ca6d50d00cc5dd3" ], "validationErrors": [ { "keyword": "dolor amet ex nulla", "instancePath": "sed sit laborum aliqua", "schemaPath": "dolore quis dolore elit consectetur", "message": "ut laborum" }, { "keyword": "ea id", "instancePath": "sint in", "schemaPath": "consequat dolore", "message": "aliqua id do" }, { "keyword": "minim laborum Duis aliquip", "instancePath": "in commodo", "schemaPath": "do sunt labore", "message": "commodo" }, { "keyword": "ut sint nulla quis", "instancePath": "irure anim Duis", "schemaPath": "aliqua ut", "message": "voluptate" } ], "created_by": "f8d3b5a27093bfea52de4ec2", "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": 54835082.96128324, "y": -66407924.89081093, "gridCoordinate": { "x": 53434477.11921871, "y": -23994815.704590783 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 93840362.46003285, "finish_state": "success", "user": "Pronghorn" }, "groups": [ "cd8ed5253c2c810a530b2032", { "_id": "a46533dc428c358f729aada2", "provenance": "aliqua", "name": "laboris consequat ea nisi eiusmod", "description": "anim pariatur cillum deserunt ex", "memberOf": [ { "groupId": "e99c0980487eccf2122a6b2c", "aaaManaged": false }, { "groupId": "e4c968893f9099059b2245da", "aaaManaged": true }, { "groupId": "0d17a1b7d15949ab0c0f6107", "aaaManaged": false }, { "groupId": "732d5b5b830228d3cc0d4934", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "reprehenderit ullamco id ea" }, { "roleId": "laboris qui ea et" } ], "inactive": true, "_meta": { "created": "2009-09-12T06:49:23.006Z", "updated": "2001-09-26T21:52:53.978Z", "migrationVersion": 24077714 } }, "default", "acbd7a87c542f3b12f7ea64a" ], "iterations": [ "Ad4a5934-6dcF-6aa4-34Bf-Ef2cC1dE6752" ] }, "workflow_end": { "x": 52254012.666669816, "y": -90860471.42837627, "gridCoordinate": { "x": -51262697.41478291, "y": -20836447.74843903 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "workflow_end", "workflow_start" ], "complete": [ "workflow_end", "workflow_end", "3a1f", "workflow_start" ], "error": [ "workflow_start", "workflow_end", "workflow_end", "workflow_end" ] }, "metrics": { "end_time": -46529347.557737075, "run_time": -36358635.969018094 }, "groups": [ { "_id": "b4a65601f540fe1056ffe11b", "provenance": "in adipisicing aute velit ex", "name": "amet Duis ullamco voluptate qui", "description": "Lorem sunt est", "memberOf": [ { "groupId": "6fb7c6d0cb8031093aadde05", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sit nostrud" }, { "roleId": "occaecat" } ], "inactive": false, "_meta": { "created": "2024-02-12T02:37:12.671Z", "updated": "1995-03-14T02:49:34.34Z", "migrationVersion": -7944563 } }, "default", "default", "3724a39029c21dfcc570d4e9" ], "iterations": [ "f1B9ED1A-Dbe8-CE3b-894e-9BEE0ECB747d" ] }, "error_handler": { "x": -77686385.39608178, "y": 91810772.54921642, "gridCoordinate": { "x": -24215616.372254893, "y": -36365456.8488283 }, "name": "childJob", "location": "Application", "locationType": "occaecat adipisicing", "app": "ut voluptate est fugiat veniam", "canvasName": "in Lorem ex", "displayName": "reprehenderit quis", "summary": "in do mollit occaecat", "description": "Lorem ipsum", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~1/FHN7F4/xFwfA/KbnxQa7/n8/~1" }, { "type": "encryption", "pointer": "/~1/osM4eE/~1/ml8.Dof/D+JoMPqfg/KeL" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "in minim Lorem", "highlightString": "Lorem est" }, { "key": "esse officia do", "highlightString": "et cillum in quis Duis" }, { "key": "eiusmod consequat", "highlightString": "nostrud" } ], "status": "running", "previous": { "incomplete": [ "workflow_start", "workflow_start", "workflow_start" ], "complete": [ "error_handler", "workflow_end" ], "error": [ "e28f", "e28f", "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_end", "type": "loop" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "standard" }, { "task": "e28f", "type": "revert" } ] }, "serverId": "velit", "start_time": "1979-02-18T04:41:55.275Z", "end_time": -91805222.04617812, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ { "_id": "5d9f4e9ef1c14cc24b398df5", "provenance": "est dolore", "name": "Lorem", "description": "non", "memberOf": [ { "groupId": "9ce8e7e7267bbc111de9c63c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "quis laborum nulla minim nostrud" }, { "roleId": "labore" }, { "roleId": "culpa ad reprehenderit" }, { "roleId": "incididunt quis voluptate veniam" } ], "inactive": true, "_meta": { "created": "2022-11-09T02:50:35.375Z", "updated": "1958-12-29T20:05:18.474Z", "migrationVersion": -89468271 } }, { "_id": "eeabe2a9471f58872226e56b", "provenance": "occaecat Lorem do pariatur", "name": "Excepteur", "description": "non proident", "memberOf": [ { "groupId": "d6d4f1cd7752a7751942ab1d", "aaaManaged": false }, { "groupId": "f2514b9a48f7dd1c0bcb9338", "aaaManaged": true }, { "groupId": "f207c4970f3432786450738e", "aaaManaged": true }, { "groupId": "4391c872fcaf90e4a2d0c511", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "minim ullamco anim dolor sint" } ], "inactive": true, "_meta": { "created": "1968-07-07T02:17:27.754Z", "updated": "1972-03-06T14:48:52.208Z", "migrationVersion": 37375098 } }, "default" ], "iterations": [ "Ace2ca3e-dA6f-Ac5f-c3cE-79148CBb61Ca" ] }, "89e": { "actor": "job", "groups": [ "default", "default" ], "iterations": [ "1FBb55CB-bD3C-a9DF-9CEE-7c3b10ae4C5C" ], "x": -7624499.226028591, "y": 13995479.72341773, "gridCoordinate": { "x": 36506943.38639125, "y": -13546864.881284699 }, "name": "consequat dolor proident", "location": "Application", "locationType": "magna in minim aliquip proident", "app": "ea quis culpa voluptate", "canvasName": "childJob", "displayName": "sit cupidatat velit", "summary": "proident tempor laborum enim laboris", "description": "velit ut", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/s3" }, { "type": "encryption", "pointer": "/AwQLxR/F3zVeb8o6/pNVUSHuIRG/OF" }, { "type": "encryption", "pointer": "/RJHQ.m9/~1/~1/kq5TtP14npc/lEXhJLpTi/rePtCBd" }, { "type": "encryption", "pointer": "/GS9rTSXVxV" }, { "type": "encryption", "pointer": "/a/ktdBhA-IEo" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "ea dolore", "highlightString": "dolor culpa nostrud ut quis" } ], "status": "canceled", "previous": { "incomplete": [ "error_handler" ], "complete": [ "3a1f", "error_handler", "error_handler", "e28f" ], "error": [ "workflow_start", "e28f", "workflow_start", "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "ad dolore esse", "start_time": "2012-12-03T13:24:54.443Z", "end_time": -31651887.374767676, "finish_state": "failure", "retrySettings": { "state": [ "failure", "success", "error", "success", "failure" ], "autoRetry": false, "limit": 74486732, "delay": 35758245, "count": 93859785, "finishedRetrying": false }, "loop": { "atLeastOneComplete": false, "finishedCount": 62343060.97437194, "outgoing": [ "consectetur", null ] }, "childJobs": [ { "_id": "in qui ut consequat aliquip", "name": "Duis in est ullamco elit", "iteration": 59453170.15747014 }, { "_id": "minim culpa", "name": "reprehenderit dolore", "iteration": 63056217.14302337 }, { "_id": "cillum in magna", "name": "commodo sit", "iteration": 18633401.64456688 }, { "_id": "magna nulla", "name": "id aute eiusmod minim", "iteration": 89367431.57866433 } ] } }, "parent": { "job": "ea eu id dolor", "task": "ad sint", "iteration": 3166970.3476598263, "element": -66438664.17305615 }, "errorHandler": null, "groups": [ { "_id": "ff4f692a7d2c5c9c01099779", "provenance": "dolor ea ipsum esse deserunt", "name": "fugiat tempor cupidatat", "description": "non", "memberOf": [ { "groupId": "0c5b1bd8ea84ee71be0a7987", "aaaManaged": true }, { "groupId": "82a5d9f0630ffaa3347707cf", "aaaManaged": true }, { "groupId": "9569d908265c41b2ab479745", "aaaManaged": false }, { "groupId": "b125721145c3b46edf29d420", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "voluptate adipisicing" }, { "roleId": "irure consequat" }, { "roleId": "anim enim deserunt" } ], "inactive": false, "_meta": { "created": "2005-06-09T06:08:30.117Z", "updated": "1989-10-07T00:09:32.748Z", "migrationVersion": -68669272 } }, { "_id": "dae8ce8e844269c392b2eeb8", "provenance": "id", "name": "laborum ipsum labore", "description": "sed Lorem esse tempor commodo", "memberOf": [ { "groupId": "dc6de83388ebe9ccbc8051f7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "proident minim" } ], "inactive": true, "_meta": { "created": "1959-03-25T18:45:25.062Z", "updated": "1968-10-21T13:27:56.7Z", "migrationVersion": -79330486 } } ], "watchers": [ "a081bf268a51588f668213e7", "Pronghorn" ], "metrics": { "start_time": 13841854.322413296, "progress": 0.47914638351115335, "end_time": -3574435.465478748, "user": { "_id": "2c0236976d38533bd70c7f97", "provenance": "quis velit eu", "username": "sint dolor proident elit tempor", "firstname": "sunt dolor ipsum ullamco quis", "memberOf": [ { "groupId": "4dbc720b90a22b9c52df7776", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "culpa" }, { "roleId": "ipsum" }, { "roleId": "dolore in mollit ut ea" }, { "roleId": "laborum deserunt aliquip proident dolore" } ], "inactive": true, "lastLogin": "1956-06-17T10:00:59.348Z", "_meta": { "created": "1987-03-07T06:26:29.082Z", "updated": "2019-05-15T18:58:42.746Z", "migrationVersion": -8303091 }, "email": "Duis eiusmod" }, "owner": "171e7d4d2980300bc6ee1ecd" } } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }